Logging in DUNE-DAQ — Documentation
Welcome to the logging documentation for daqpytools (as of fddaq-v5.6.0).
This documentation is split into two sections depending on your role:
- User docs — for anyone writing Python applications that use logging
- Developer docs — for anyone extending the logging system itself (new handlers, new filters)
Furthermore, a separate API reference set that includes Auto-generated kwargs, types, and defaults for all public APIs is found in the API reference page.
User documentation
| Page | What it's for |
|---|---|
| Tutorial | Get a working logger running from scratch |
| Concepts & explanation | Understand how Python logging and daqpytools work |
| How to use handlers and filters | Descriptions and examples for each handler and filter |
| How to route messages | Direct records to specific handlers using HandlerType and LogHandlerConf |
| How to add handlers at runtime | Attach handlers after logger creation; pass kwargs |
| How to configure ERS | Attach and use ERS handlers |
| How to upgrade an existing package | Migration checklist for adopting daqpytools logging in existing codebases |
| Best practices | Recommended patterns for structuring logging in your application |
| Troubleshooting | Common symptoms, causes, and fixes |
Developer documentation
| Page | What it's for |
|---|---|
| Concepts & explanation | The routing model, component definitions, fallback logic |
| Architecture reference | Logger init flow and record flow at runtime |
| How to add a handler | Step-by-step guide to adding a new handler type |
| How to add a filter | Step-by-step guide to adding a new logger-level filter |
| How to debug routing | Systematic workflow for diagnosing routing issues |
| How docs work and how to update them | Explains docs structure, generation pipeline, and update workflow |
| Common patterns | Quick-reference recipes for handlers and filters |