Skip to content

oss_29_refresh_examples_and_docs#43

Open
ocelotl wants to merge 2 commits into
mainfrom
oss_29_refresh_examples_and_docs
Open

oss_29_refresh_examples_and_docs#43
ocelotl wants to merge 2 commits into
mainfrom
oss_29_refresh_examples_and_docs

Conversation

@ocelotl

@ocelotl ocelotl commented Jul 22, 2026

Copy link
Copy Markdown
Owner

Closes #40

Refresh stale examples and fix doc inconsistencies (core repo, Linear OSS-29, D3-D8): bump example pins to the 1.43/0.64b0 line (drop an RC + stale transitive pins), fix opentracing README exporter mismatch, mark opencensus example legacy, update moved opentelemetry.io links, drop stale metrics comment.

Validation: scope contained to docs/examples + README + changelog; no stale /docs/instrumentation/python links remain; specifiers validated as PEP 440. Contrib-side items noted as follow-up (separate repo).

Linear issue: https://linear.app/dash0/issue/OSS-29/d3-d8-refresh-stale-examples-and-fix-doc-inconsistencies

Bump example dependency pins to the current release line (1.43 / 0.64b0)
and drop stale 2023-era transitive pins:

- metrics/views and metrics/reader: switch to compatible-release
  specifiers on the current line.
- metrics/prometheus-grafana: replace the 1.12.0rc1 release candidate
  with the current opentelemetry-exporter-prometheus line and drop the
  unused protobuf pin.
- fork-process-model/flask-gunicorn and flask-uwsgi: bump OpenTelemetry
  packages to the current line and remove pinned transitive dependencies
  (protobuf, grpcio, six, thrift, googleapis-common-protos) so they are
  resolved fresh.

Documentation fixes:

- opentracing README: describe span export via the OTLP exporter to a
  Jaeger backend to match main.py, which uses OTLPSpanExporter.
- opencensus-exporter-tracer README: mark the example legacy; it relies
  on Collector components that have been removed (opencensus receiver,
  jaeger_grpc exporter, queued_retry processor) and OpenCensus is EOL.
- README.md, docs/index.rst and auto-instrumentation README: update
  opentelemetry.io links from /docs/instrumentation/python/ to
  /docs/languages/python/.
- getting_started/metrics_example.py: drop the stale comment claiming the
  metrics SDK is still being implemented.
@ocelotl

ocelotl commented Jul 22, 2026

Copy link
Copy Markdown
Owner Author

🔒 Internal (dash0) — not for upstream.

@ocelotl

ocelotl commented Jul 22, 2026

Copy link
Copy Markdown
Owner Author

📣 Public-facing draft — to be used for the upstream PR in open-telemetry/opentelemetry-python. No internal references; copy verbatim.

Title: Refresh stale examples and fix documentation inconsistencies

What

  • Bump example dependency pins to the current release line (1.43 / 0.64b0): metrics/views and metrics/reader switch to compatible-release specifiers; metrics/prometheus-grafana replaces the 1.12.0rc1 RC with the current opentelemetry-exporter-prometheus line and drops the unused protobuf pin; fork-process-model/flask-gunicorn and flask-uwsgi bump OpenTelemetry packages and remove pinned 2023-era transitive deps (protobuf, grpcio, six, thrift, googleapis-common-protos).
  • Docs: opentracing README now describes OTLP export to a Jaeger backend (matching main.py); opencensus-exporter-tracer README gains a legacy warning (removed Collector components; OpenCensus EOL) pointing to the OTLP exporter; opentelemetry.io links in README.md, docs/index.rst, and the auto-instrumentation README updated from /docs/instrumentation/python/ to /docs/languages/python/; removed the stale "metrics SDK is being implemented" comment from docs/getting_started/metrics_example.py.

Why

The example lockfiles pinned releases up to ~3 years old (including a release candidate and stale transitive dependencies); the doc links pointed at a relocated section of the website (leaving README.md internally inconsistent); the opentracing README contradicted its own code; the opencensus example depended on Collector components that have since been removed; and the metrics getting-started example carried a comment inaccurate since the metrics SDK stabilized in 1.12. All specifiers were validated as legal PEP 440 resolving to the intended current-line versions. Documentation/example-only; no library code affected.

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.

oss_29_refresh_examples_and_docs

1 participant