Skip to content

docs: Clarify BatchSpanProcessor fork support - #5777

Open
Harshil-1603 wants to merge 2 commits into
open-telemetry:mainfrom
Harshil-1603:docs/fork-process-guidance-4759
Open

Harshil-1603 wants to merge 2 commits into
open-telemetry:mainfrom
Harshil-1603:docs/fork-process-guidance-4759

Conversation

@Harshil-1603

Copy link
Copy Markdown

Description

Correct the fork-process example's blanket statement that BatchSpanProcessor is not fork-safe. The current shared batch processor reinitializes its internal synchronization and worker thread in forked children and clears the inherited queue. The revised text distinguishes that behavior from exporter/transport constraints, keeps the per-worker initialization examples, and links to the signal-specific auto-instrumentation troubleshooting guide.

Fixes #4759

Type of change

  • Documentation update

How Has This Been Tested?

  • Four existing real-fork tests in opentelemetry-sdk/tests/shared_internal/test_batch_processor.py passed on Linux, Python 3.12.14, including the BatchSpanProcessor child export case.
  • rstcheck --report-level warning --ignore-roles scm_web docs/examples/fork-process-model/README.rst: passed.
  • git diff --check: passed.

The full documentation site and the Gunicorn/uWSGI deployments were not run.

Does This PR Require a Contrib Repo Change?

  • No.

AI assistance: Codex GPT-6; disclosed with an Assisted-by: commit trailer.

@Harshil-1603
Harshil-1603 requested a review from a team as a code owner October 12, 2026 20:07
@linux-foundation-easycla

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

Copy link
Copy Markdown

CLA Signed
The committers listed above are authorized under a signed CLA.

@opentelemetry-pr-dashboard

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

Copy link
Copy Markdown

Pull request dashboard status

Waiting on reviewers · refreshed 2026-10-14 22:00 UTC

Review the latest changes.

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.
  • Anything look wrong? Report it with what you expected; it helps us improve the dashboard.

Assisted-by: Codex GPT-6
Signed-off-by: Harshil <181649964+Harshil-1603@users.noreply.github.com>
Assisted-by: Codex GPT-6
Signed-off-by: Harshil <181649964+Harshil-1603@users.noreply.github.com>
@Harshil-1603
Harshil-1603 force-pushed the docs/fork-process-guidance-4759 branch from ac095b4 to 56d7a01 Compare October 14, 2026 21:59

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: No status

Development

Successfully merging this pull request may close these issues.

conflicting information about fork-safety of BatchSpanProcessor

1 participant