Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: Document how logging works in dodal #459

Open
DominicOram opened this issue Apr 23, 2024 · 0 comments
Open

Docs: Document how logging works in dodal #459

DominicOram opened this issue Apr 23, 2024 · 0 comments

Comments

@DominicOram
Copy link
Contributor

DominicOram commented Apr 23, 2024

As a dodal user e.g. a DAQ person writing an application or a beamline scientist playing around I would like to know how to set up logging.

Currently this can be done by just calling:

from dodal.log import LOGGER, do_default_logging_setup
do_default_logging_setup()
LOGGER.info("hello world")

Which will set up some defaults for you, including logging to graylog at https://graylog.diamond.ac.uk/streams/662655e6b17cec581f3cf46d/search. We should document:

  • The default locations it puts text logs
  • Debug logs and the CircularMemoryHandler
  • How to override these defaults
  • Recommended tags to add to the logs and how to add them
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant