Enrich logging through context vars #452
Merged
Conversation
This file contains 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
MattToast
requested changes
Jan 16, 2024
move log filter creation into ContextAwareLogger
al-rigazzi
requested changes
Jan 17, 2024
There was a problem hiding this comment.
Everything looks semantics-wise good! Just two requests:
- can you please add/complete the missing docstring parameter lists including
:return:and:rtype:fields, at least in the more user-facing files such aslog.py? - consider running
make styleand thenmake check-styleto make sure the future GH checks will pass
MattToast
approved these changes
Jan 17, 2024
al-rigazzi
approved these changes
Jan 18, 2024
ashao
pushed a commit
to ashao/SmartSim
that referenced
this pull request
Jan 27, 2024
The implementation makes use of python `contextvars.ContextVar` to store
experiment-specific state. The state is used to dynamically modify
experiment-level logging.
For example, this driver:
```py
exp1 = smartsim.Experiment('exp-1')
rs1 = exp1.create_runsettings(...)
model1 = exp1.create_model(..., rs1)
exp2 = smartsim.Experiment('other-exp')
rs2 = exp2.create_runsettings(...)
model2 = exp2.create_model(..., rs2)
exp1.start(model1)
exp1.start(model2)
```
Results in each experiment dynamically registering `logging.FileHandler`
instances that write logs to separate files:
- `/exp-1/.telemetry/smartsim/smartsim.out`
- `/other-exp/.telemetry/smartsim/smartsim.out`
### Key changes:
1. Decorated experiment API w/contextualizer to enrich log context
2. Create/Use `ContextThread` to ensure threads include current context
information
3. Create/Use `ContextAwareLogger` to dynamically add file handlers for
experiment logs
4. Updated manifest serialization to include paths to
experiment-specific log files
5. Added `LowPassFilter` to enable splitting experiment logs across
`xxx.out` and `xxx.err`
### Additional minor changes:
1. Moved `serialize.TELMON_SUBDIR` constant to `Config.telemetry_subdir`
to make it more universally available
---------
Co-authored-by: Matt Drozt <[email protected]>
Co-authored-by: Matt Drozt <[email protected]>
[ committed by @ankona ]
[ reviewed by @al-rigazzi @MattToast ]
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.
The experiment previously wrote to
sys.stdoutandsys.stderr. This change makes experiment driver scripts using theExperimentAPI write additional logs for experiment tracking. The public "factory API" of theExperimenthas added the behavior of also logging to individual experiment log files.The implementation makes use of python
contextvars.ContextVarto store experiment-specific state. The state is used to dynamically modify experiment-level logging.For example, this driver:
Results in each experiment dynamically registering
logging.FileHandlerinstances that write logs to separate files:/exp-1/.telemetry/smartsim/smartsim.out/other-exp/.telemetry/smartsim/smartsim.outKey changes:
ContextThreadto ensure threads include current context informationContextAwareLoggerto dynamically add file handlers for experiment logsLowPassFilterto enable splitting experiment logs acrossxxx.outandxxx.errAdditional minor changes:
serialize.TELMON_SUBDIRconstant toConfig.telemetry_subdirto make it more universally available