Skip to content

Fix createTracerShim example in the OpenTracing shim README - #8813

Draft
thswlsqls wants to merge 1 commit into
open-telemetry:mainfrom
thswlsqls:docs/opentracing-shim-readme-create-tracer-shim
Draft

Fix createTracerShim example in the OpenTracing shim README#8813
thswlsqls wants to merge 1 commit into
open-telemetry:mainfrom
thswlsqls:docs/opentracing-shim-readme-create-tracer-shim

Conversation

@thswlsqls

Copy link
Copy Markdown
Contributor

Description

  • The second usage example in opentracing-shim/README.md calls OpenTracingShim.createTracerShim(openTelemetry, textMapPropagator, httpPropagator), but the only three-argument overload is createTracerShim(TracerProvider provider, TextMapPropagator textMapPropagator, TextMapPropagator httpPropagator), and OpenTelemetry does not implement TracerProvider, so the snippet does not compile.
  • Renames the first argument in the snippet to tracerProvider, matching the surrounding prose ("From a specific TracerProvider, ...") and the overload signature.
  • The snippet has been wrong since it was added in Fix opentracing docs #5145; the overload already took a TracerProvider at that time (add missing createTracerShim function #4988).

Testing done

  • Docs-only, test-exempt: no test added.
  • Verified the corrected snippet against OpenTracingShim.createTracerShim(TracerProvider, TextMapPropagator, TextMapPropagator) in OpenTracingShim.java.

@codecov

codecov Bot commented Sep 12, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 91.28%. Comparing base (77b1ac4) to head (472a79f).

Additional details and impacted files
@@             Coverage Diff              @@
##               main    #8813      +/-   ##
============================================
- Coverage     91.28%   91.28%   -0.01%     
  Complexity    10528    10528              
============================================
  Files          1008     1008              
  Lines         28465    28465              
  Branches       3617     3617              
============================================
- Hits          25984    25983       -1     
  Misses         1685     1685              
- Partials        796      797       +1     

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@opentelemetry-pr-dashboard

Copy link
Copy Markdown

Pull request dashboard status

Waiting on the author · refreshed 2026-09-12 12:50 UTC

Move out of draft to request review.

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.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant