Add sampler shutdown lifecycle by Mayukhga83 · Pull Request #5747 · open-telemetry/opentelemetry-python

Mayukhga83 · 2026-10-05T22:25:40Z

Description

This PR adds a shutdown lifecycle to SDK samplers.

Sampler.shutdown() has a default no-op implementation so existing custom samplers remain compatible. TracerProvider.shutdown() now shuts down span processors first and then the configured sampler.

Wrapper samplers also forward shutdown to their delegates:

ParentBased shuts down each distinct directly wrapped sampler once.
AlwaysRecordSampler shuts down its root sampler.

Provider shutdown is idempotent, including when explicit shutdown and process-exit cleanup both occur. Cleanup is still attempted when another shutdown component raises an exception.

Part of #5713.

Assisted-by: ChatGPT

Type of change

Bug fix
New feature (non-breaking change)
Breaking change
This change requires a documentation update

How Has This Been Tested?

I added unit tests covering:

Existing custom samplers that do not override shutdown()
Shutdown propagation through ParentBased
Deduplication when a sampler occupies multiple ParentBased delegate positions
Shutdown propagation through AlwaysRecordSampler
Span-processor and sampler shutdown ordering
Explicit and process-exit shutdown
Repeated shutdown calls
Exceptions raised during processor or sampler shutdown

Validation performed:

138 focused sampler and tracer-provider tests passed
283 SDK trace tests passed
lint-opentelemetry-sdk passed

Does This PR Require a Contrib Repo Change?

Yes
- The AWS X-Ray sampler will need a corresponding implementation in the contrib repository.
- Follow-up PR: pending
No

Checklist

Followed the style guidelines of this project
Changelogs have been updated
Unit tests have been added
API documentation/docstrings have been updated

Forward shutdown through wrapper samplers and invoke it from TracerProvider with idempotent cleanup semantics. Assisted-by: ChatGPT

linux-foundation-easycla · 2026-10-05T22:25:48Z

The committers listed above are authorized under a signed CLA.

✅ login: Mayukhga83 / name: Mayukh Das (e776e0e)

opentelemetry-pr-dashboard · 2026-10-05T22:29:30Z

Pull request dashboard status

Waiting on the author · refreshed 2026-11-04 04:09 UTC

Respond to 4 review items (e.g. link a commit, explain why not, ask a follow-up):

Inline threads: 1, 2, 3, 4

Status above doesn't look right?

Just replied or pushed? Anything around or after the refresh time above may not be picked up yet — give it a few minutes.
Should this be with reviewers? Comment /dashboard route:reviewers to route it to them.
Anything wrong — including the routing? Report it with what you expected; it helps us improve the dashboard.

herin049 · 2026-10-06T00:28:47Z

    def get_description(self) -> str:
        pass

+    def shutdown(self) -> None:


This needs to be private since it's developmental

Changed the developmental lifecycle hook to private _shutdown() and updated wrappers/tests

herin049 · 2026-10-06T00:29:09Z

+            if self._shutdown:
+                return
+            self._shutdown = True
+            try:


nit: extract these into helpers to avoid nested try-finally

Extracted sampler shutdown and atexit cleanup into helpers, removing the nested try/finally while preserving cleanup behavior

lzchen · 2026-10-07T17:45:58Z

@@ -1279,6 +1279,8 @@ def __init__(
        self._disabled = disabled.lower().strip() == "true"


Please add a changelog entry.

Added .changelog/5747.added for the SDK sampler shutdown lifecycle

Assisted-by: ChatGPT 5

Mayukhga83 · 2026-10-15T23:15:43Z

Addressed the three review items in 17d8851. The focused tests pass: 137 passed, 1 platform-specific skip

tammy-baylis-swi

Thank you, this lgtm. Not sure why the changelog ci/cd is failing. Please could you Update Branch which might stop the symbol failure.

tammy-baylis-swi · 2026-10-23T16:52:05Z

Update from main has fixed the ci/cd. 🙂 Maintainers ptal at the revisions made

tammy-baylis-swi · 2026-11-02T16:46:50Z

/dashboard route:reviewers

opentelemetry-pr-dashboard · 2026-11-02T16:47:58Z

@tammy-baylis-swi, your reviewer-routing request was recorded; this pull request has the approvals it needs and is now waiting on maintainers. The handoff remains active across pushes until newer actionable human feedback arrives. Top-level feedback through this request will not return; unresolved review threads remain open.

pmcollins

Thanks, LGTM overall. Added one comment.

pmcollins · 2026-11-03T15:22:45Z

+        for delegate in delegates:
+            if id(delegate) not in seen:
+                seen.add(id(delegate))
+                delegate._shutdown()  # pylint: disable=protected-access


Looks like this can raise an exception, in which case the remaining delegates won't be shut down. Can we catch any exceptions and continue shutting down remaining delegates, then handle the error?

Copilot

🟡 Changes recommended

Shutdown bypasses the advertised public sampler hook, while delegate or processor failures can permanently prevent remaining resources from being cleaned up.

3 open issues

Attempt shutdown of every span processor · New
Expose the sampler shutdown hook publicly · New
Attempt all delegate shutdowns before propagating errors · New

What changed in this PR

Adds a sampler shutdown lifecycle to the tracing SDK, supporting resource cleanup for samplers as requested in #5713.

Changes:

Adds a default no-op sampler cleanup hook and forwarding through wrapper samplers.
Makes provider shutdown idempotent and attempts sampler cleanup after span processors, including when processor shutdown raises.
Adds lifecycle tests and a changelog entry.

File	Description
`opentelemetry-sdk/tests/trace/test_trace.py`	Tests shutdown ordering, repeated calls, exit cleanup, and failures.
`opentelemetry-sdk/tests/trace/test_sampling.py`	Tests default cleanup, wrapper forwarding, and delegate deduplication.
`opentelemetry-sdk/src/opentelemetry/sdk/trace/sampling.py`	Adds sampler cleanup hooks and wrapper propagation.
`opentelemetry-sdk/src/opentelemetry/sdk/trace/__init__.py`	Integrates sampler cleanup into guarded, once-only provider shutdown.
`.changelog/5747.added`	Announces the sampler shutdown lifecycle.

_{Review effort: Balanced}

+            self._shutdown = True
+            try:
+                self._active_span_processor.shutdown()


    def get_description(self) -> str:
        pass

+    def _shutdown(self) -> None:


+        for delegate in delegates:
+            if id(delegate) not in seen:
+                seen.add(id(delegate))
+                delegate._shutdown()  # pylint: disable=protected-access


Add sampler shutdown lifecycle

e776e0e

Forward shutdown through wrapper samplers and invoke it from TracerProvider with idempotent cleanup semantics. Assisted-by: ChatGPT

Mayukhga83 requested a review from a team as a code owner October 5, 2026 22:25

otelbot-python Bot added this to Python PR digest Oct 5, 2026

opentelemetry-pr-dashboard Bot mentioned this pull request Oct 5, 2026

Pull Request Dashboard #5550

Open

Mayukhga83 mentioned this pull request Oct 5, 2026

Add shutdown method to samplers #5713

Open

herin049 requested changes Oct 6, 2026

View reviewed changes

Merge branch 'main' into feat/sampler-shutdown-5713

eddd754

lzchen reviewed Oct 7, 2026

View reviewed changes

This comment has been minimized.

Sign in to view

Address sampler shutdown review feedback

17d8851

Assisted-by: ChatGPT 5

tammy-baylis-swi moved this from Reviewed PRs that need fixes to Ready for review in Python PR digest Oct 16, 2026

tammy-baylis-swi approved these changes Oct 16, 2026

View reviewed changes

tammy-baylis-swi moved this from Ready for review to Approved PRs in Python PR digest Oct 16, 2026

Merge branch 'main' into feat/sampler-shutdown-5713

880b848

This comment has been minimized.

Sign in to view

pmcollins approved these changes Nov 3, 2026

View reviewed changes

herin049 approved these changes Nov 4, 2026

View reviewed changes

herin049 requested a balanced review from Copilot November 4, 2026 04:05

Copilot started reviewing on behalf of herin049 November 4, 2026 04:06

View session

Copilot AI reviewed Nov 4, 2026

View reviewed changes

		@@ -1279,6 +1279,8 @@ def __init__(
		self._disabled = disabled.lower().strip() == "true"

Conversation

Mayukhga83 commented Oct 5, 2026

Description

Type of change

How Has This Been Tested?

Does This PR Require a Contrib Repo Change?

Checklist

Uh oh!

linux-foundation-easycla Bot commented Oct 5, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

opentelemetry-pr-dashboard Bot commented Oct 5, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pull request dashboard status

Uh oh!

herin049 Oct 6, 2026

Choose a reason for hiding this comment

Uh oh!

Mayukhga83 Oct 15, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

herin049 Oct 6, 2026

Choose a reason for hiding this comment

Uh oh!

Mayukhga83 Oct 15, 2026

Choose a reason for hiding this comment

Uh oh!

lzchen Oct 7, 2026

Choose a reason for hiding this comment

Uh oh!

Mayukhga83 Oct 15, 2026

Choose a reason for hiding this comment

Uh oh!

This comment has been minimized.

Mayukhga83 commented Oct 15, 2026

Uh oh!

tammy-baylis-swi left a comment

Choose a reason for hiding this comment

Uh oh!

tammy-baylis-swi commented Oct 23, 2026

Uh oh!

This comment has been minimized.

tammy-baylis-swi commented Nov 2, 2026

Uh oh!

opentelemetry-pr-dashboard Bot commented Nov 2, 2026

Uh oh!

pmcollins left a comment

Choose a reason for hiding this comment

Uh oh!

pmcollins Nov 3, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

🟡 Changes recommended

Uh oh!

This branch has not been deployed

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

linux-foundation-easycla Bot commented Oct 5, 2026 •

edited

Loading

opentelemetry-pr-dashboard Bot commented Oct 5, 2026 •

edited

Loading

Mayukhga83 Oct 15, 2026 •

edited

Loading