pyscript icon indicating copy to clipboard operation
pyscript copied to clipboard

Suggestion to add info on logging levels

Open markwmuller opened this issue 4 years ago • 6 comments

Thanks for a great tool! I had some trouble initially, as the jupyter notebook would only print error messages, but not debug or info.

It took me some time to understand that I need to modify my configuration.yaml to add the logger line. I suggest adding to the example notebook, in the block containing To display messages use the log.debug (the print function is not currently supported) to say something like the following (I don't know how to submit a PR on this):

To display messages use the log.debug (the print function is not currently supported). If you're not seeing any output from the below, make sure that you've set up your logger to display more than error messages (which is the default). For more information, including how to configure your `configuration.yaml`, see here: https://www.home-assistant.io/integrations/logger/

markwmuller avatar Nov 14 '21 23:11 markwmuller

I feel like the documentation in the logging section covers this pretty well.

dlashua avatar Nov 16 '21 11:11 dlashua

The tutorial also has a relatively prominent note about setting the log levels.

craigbarratt avatar Nov 16 '21 16:11 craigbarratt

These are great! However, for someone who isn't sure whether to invest the time to read all the docs, and trying out pyscript and appdaemon simultaneously (like I was), a huge advantage of pyscript is the notebook to get started with (and in fact, that's what the "Tutorial" seems to suggest -- learn by using the notebook). It's easy to then get stuck without outputs, and assume it's not working (or you've screwed up the installation somehow), and give up.

Could the notebook link to the logging section then? It seems like a trivial addition, and it would certainly have helped at least one person (me!). Alternatively, perhaps the installation instructions should suggest putting the logging level for pyscript to "info" initially, so that the notebook works as expected.

markwmuller avatar Nov 16 '21 17:11 markwmuller

I would like to chime in with the OP here that the docs seem a little ambiguous. I initially skipped this configuration because the docs seemed to state that it would not be necessary for Jupyter users. When I did apply the new configuration after running into the same problem as OP, the problem got resolved.

Specifically, I'm referring to the following language:

Note that in Jupyter, all the log functions will display output in your session, independent of the logger configuration settings.

and

You’ll need to look at the log messages to see the output (unless you are using Jupyter, in which case all log messages will be displayed, independent of the log setting).

gabrielecirulli avatar Jan 30 '22 06:01 gabrielecirulli

Note that in Jupyter, all the log functions will display output in your session, independent of the logger configuration settings.

I'm not seeing any log output in Jupyter, how do I debug this?

image

ValentinFunk avatar Nov 27 '22 14:11 ValentinFunk