Fix issue 2098: Add opt-in structured logging, metrics, and tracing#2283
Open
lqminhhh wants to merge 8 commits into
Open
Fix issue 2098: Add opt-in structured logging, metrics, and tracing#2283lqminhhh wants to merge 8 commits into
lqminhhh wants to merge 8 commits into
Conversation
|
@lqminhhh please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.
Contributor License AgreementContribution License AgreementThis Contribution License Agreement (“Agreement”) is agreed to by the party signing below (“You”),
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
feat(observability): add opt-in structured logging, metrics, and tracing
Description
This PR adds an opt-in observability foundation for Qlib.
It introduces structured JSON logging, lightweight metrics collection, metrics export/reporting, and basic trace/span support while preserving Qlib's existing default logging behavior.
Main changes:
JSONFormatterfor structured JSON logs.trace_span(...)context manager.Motivation and Context
Related to #2098.
Qlib currently has plain-text logging and some isolated timing/experiment metrics, but it does not have a unified opt-in observability layer for structured logs, runtime metrics, and trace context.
This PR keeps observability disabled by default and does not introduce mandatory external monitoring dependencies such as Prometheus or OpenTelemetry.
How Has This Been Tested?
pytest qlib/tests/test_all_pipeline.pyunder upper directory ofqlib.Focused tests run:
Result:
Also manually tested with a real-data Qlib notebook using
D.features(...)to verify structured logs, metrics export/summary, and trace spans.Screenshots of Test Results (if appropriate)
Types of changes