opentelemetry-sdk: Add ability to refresh process sensitive Resource attributes#5280
opentelemetry-sdk: Add ability to refresh process sensitive Resource attributes#5280herin049 wants to merge 26 commits into
Conversation
There was a problem hiding this comment.
Pull request overview
This PR adds fork-safety for process-sensitive SDK Resource attributes (e.g., process.pid) by re-running process-sensitive resource detectors in child processes and propagating refreshed resources into trace, metrics, and logs providers (including already-created tracers/loggers). It also introduces provider-level update_resource() APIs and adds subprocess-based fork tests.
Changes:
- Add
ResourceDetector.is_process_sensitive()and_get_process_sensitive_resource()to selectively re-run only process-sensitive detectors. - Add
update_resource()toTracerProvider,MeterProvider, andLoggerProvider, and wireos.register_at_fork(after_in_child=...)to refresh resources in child processes. - Add fork-based subprocess tests plus direct
update_resource()unit tests for traces, metrics, and logs.
Reviewed changes
Copilot reviewed 12 out of 12 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| opentelemetry-sdk/src/opentelemetry/sdk/resources/init.py | Adds process-sensitivity marker on detectors and helper to aggregate only process-sensitive resources. |
| opentelemetry-sdk/src/opentelemetry/sdk/trace/init.py | Adds tracer/provider resource refresh on fork and public update_resource() that updates existing tracers. |
| opentelemetry-sdk/src/opentelemetry/sdk/metrics/_internal/init.py | Adds meter provider resource refresh on fork and update_resource() support. |
| opentelemetry-sdk/src/opentelemetry/sdk/_logs/_internal/init.py | Adds logger provider resource refresh on fork, update_resource(), and propagation to active loggers. |
| opentelemetry-sdk/tests/resources/test_resources.py | Adds unit tests for process-sensitivity defaults and _get_process_sensitive_resource(). |
| opentelemetry-sdk/tests/trace/test_trace.py | Adds TracerProvider.update_resource() test and fork subprocess test. |
| opentelemetry-sdk/tests/trace/scripts/tracer_provider_resource_after_fork.py | New subprocess script validating trace resource PID refresh after fork. |
| opentelemetry-sdk/tests/metrics/test_metrics.py | Adds MeterProvider.update_resource() test and fork subprocess test. |
| opentelemetry-sdk/tests/metrics/scripts/meter_provider_resource_after_fork.py | New subprocess script validating metric resource PID refresh after fork. |
| opentelemetry-sdk/tests/logs/test_logs.py | Adds LoggerProvider.update_resource() test and fork subprocess test. |
| opentelemetry-sdk/tests/logs/scripts/logger_provider_resource_after_fork.py | New subprocess script validating log resource PID refresh after fork. |
| .changelog/5280.added | Changelog entry for the new fork/resource refresh capability. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Thanks I'll remove all references of "sensitive" from the PR |
All usages of the phrase "sensitive" should be removed now. |
There was a problem hiding this comment.
Copilot spotted that this has an unexpected effect. That is that the post fork handler will override any manual set resource attributes. One could argue that I don't need a detector setting service.instance.id if I set it manually and so maybe documenting that behavior is enough? An alternative would be to track the source of the attributes and skip the update if they have been set manually but not sure if it's worth it.
That's true. I think we can document the behavior for now. @herin049 wdyt? |
I'll add a comment for now. I think it's more desirable to set a new UUID for Another option is to add the ability to disable this detector. Then the user can create their own custom process-dependent detector which populates |
I've added the following comment under the service instance id resource detector:
|
Description
This PR adds support for refreshing process sensitive SDK resources after
os.fork(). It introduces provider level resource updates for traces, metrics, and logs, marks process resource detection as process sensitive and usesos.register_at_fork()to re-run any process sensitive resource detectors in child processes. This ensures attributes such asprocess.pidare updated for newly emitted spans, metrics, and logs after a fork.Changes
os.fork()usingos.register_at_fork().Fixes #5279
Type of change
Please delete options that are not relevant.
How Has This Been Tested?
Does This PR Require a Contrib Repo Change?
Checklist: