As a stepping stone toward Unfold Studio as a research platform, we need much better logging to be instrumented throughout the application: both the content of the logging and the structure. For the structure, we will use structlog. I recently replaced logging in qc with structlog, and have been very happy with it, although it took some effort to understand the new paradigm and integrate it into the existing app. Use the qc codebase as a guide.
We will use this as a meta-issue; create new issues for the specific tasks below.
Phase 1: Structure
Integrate structlog into the application
Replace all existing logging calls with structlog calls.
Phase 2: Content
Standardize what is getting logged.
Standardize where logging takes place (should there be a log message for each request?)
Standardize the use of log levels.
Phase 3: Analysis
Gather the conceptual framework and the constructs which are measured through logs.
Extend logging to fill out conceptual framework
Implement measures which can consume log data (e.g. dashboard)
As a stepping stone toward Unfold Studio as a research platform, we need much better logging to be instrumented throughout the application: both the content of the logging and the structure. For the structure, we will use structlog. I recently replaced logging in qc with structlog, and have been very happy with it, although it took some effort to understand the new paradigm and integrate it into the existing app. Use the qc codebase as a guide.
We will use this as a meta-issue; create new issues for the specific tasks below.
Phase 1: Structure
Phase 2: Content
Phase 3: Analysis