diff --git a/.changelog/43.fixed b/.changelog/43.fixed new file mode 100644 index 00000000000..1d67a9e7681 --- /dev/null +++ b/.changelog/43.fixed @@ -0,0 +1 @@ +Refresh stale example dependency pins and fix documentation inconsistencies diff --git a/README.md b/README.md index 278016c3768..39994eb3177 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ ## Project Status -See the [OpenTelemetry Instrumentation for Python](https://opentelemetry.io/docs/instrumentation/python/#status-and-releases). +See the [OpenTelemetry Instrumentation for Python](https://opentelemetry.io/docs/languages/python/#status-and-releases). | Signal | Status | Project | | ------- | ------------ | ------- | diff --git a/docs/examples/auto-instrumentation/README.rst b/docs/examples/auto-instrumentation/README.rst index b9f3692a372..ea8035662f9 100644 --- a/docs/examples/auto-instrumentation/README.rst +++ b/docs/examples/auto-instrumentation/README.rst @@ -4,4 +4,4 @@ Auto-instrumentation To learn about automatic instrumentation and how to run the example in this directory, see `Automatic Instrumentation`_. -.. _Automatic Instrumentation: https://opentelemetry.io/docs/instrumentation/python/automatic/example +.. _Automatic Instrumentation: https://opentelemetry.io/docs/languages/python/automatic/example diff --git a/docs/examples/fork-process-model/flask-gunicorn/requirements.txt b/docs/examples/fork-process-model/flask-gunicorn/requirements.txt index de4cc15ee56..995e851d115 100644 --- a/docs/examples/fork-process-model/flask-gunicorn/requirements.txt +++ b/docs/examples/fork-process-model/flask-gunicorn/requirements.txt @@ -1,20 +1,14 @@ click==8.1.7 Flask==3.1.3 -googleapis-common-protos==1.52.0 -grpcio==1.56.2 gunicorn==22.0.0 itsdangerous==2.1.2 Jinja2==3.1.6 MarkupSafe==2.1.3 -opentelemetry-api==1.20.0 -opentelemetry-exporter-otlp==1.20.0 -opentelemetry-instrumentation==0.41b0 -opentelemetry-instrumentation-flask==0.41b0 -opentelemetry-instrumentation-wsgi==0.41b0 -opentelemetry-sdk==1.20.0 -protobuf==3.20.3 -six==1.15.0 -thrift==0.13.0 -uWSGI==2.0.22 +opentelemetry-api~=1.43 +opentelemetry-exporter-otlp~=1.43 +opentelemetry-instrumentation~=0.64b0 +opentelemetry-instrumentation-flask~=0.64b0 +opentelemetry-instrumentation-wsgi~=0.64b0 +opentelemetry-sdk~=1.43 Werkzeug==3.1.5 -wrapt==1.16.0 +wrapt~=1.16 diff --git a/docs/examples/fork-process-model/flask-uwsgi/requirements.txt b/docs/examples/fork-process-model/flask-uwsgi/requirements.txt index 6bf12485c59..fd7f91ec3d0 100644 --- a/docs/examples/fork-process-model/flask-uwsgi/requirements.txt +++ b/docs/examples/fork-process-model/flask-uwsgi/requirements.txt @@ -1,19 +1,14 @@ click==8.1.7 Flask==3.1.3 -googleapis-common-protos==1.52.0 -grpcio==1.56.2 itsdangerous==2.1.2 Jinja2==3.1.6 MarkupSafe==2.1.3 -opentelemetry-api==1.20.0 -opentelemetry-exporter-otlp==1.20.0 -opentelemetry-instrumentation==0.41b0 -opentelemetry-instrumentation-flask==0.41b0 -opentelemetry-instrumentation-wsgi==0.41b0 -opentelemetry-sdk==1.20.0 -protobuf==3.20.3 -six==1.15.0 -thrift==0.13.0 +opentelemetry-api~=1.43 +opentelemetry-exporter-otlp~=1.43 +opentelemetry-instrumentation~=0.64b0 +opentelemetry-instrumentation-flask~=0.64b0 +opentelemetry-instrumentation-wsgi~=0.64b0 +opentelemetry-sdk~=1.43 uWSGI==2.0.22 Werkzeug==3.1.5 -wrapt==1.16.0 +wrapt~=1.16 diff --git a/docs/examples/metrics/prometheus-grafana/requirements.txt b/docs/examples/metrics/prometheus-grafana/requirements.txt index f18ff7b7b48..3b6e8207056 100644 --- a/docs/examples/metrics/prometheus-grafana/requirements.txt +++ b/docs/examples/metrics/prometheus-grafana/requirements.txt @@ -1,2 +1 @@ -opentelemetry-exporter-prometheus==1.12.0rc1 -protobuf~=3.18.1 +opentelemetry-exporter-prometheus~=0.64b0 diff --git a/docs/examples/metrics/reader/requirements.txt b/docs/examples/metrics/reader/requirements.txt index d7a896c9570..719ad0fc186 100644 --- a/docs/examples/metrics/reader/requirements.txt +++ b/docs/examples/metrics/reader/requirements.txt @@ -1,5 +1,5 @@ -opentelemetry-api==1.15.0 -opentelemetry-sdk==1.15.0 -opentelemetry-semantic-conventions==0.36b0 -typing_extensions==4.5.0 -wrapt==1.14.1 +opentelemetry-api~=1.43 +opentelemetry-sdk~=1.43 +opentelemetry-semantic-conventions~=0.64b0 +typing_extensions~=4.5 +wrapt~=1.14 diff --git a/docs/examples/metrics/views/requirements.txt b/docs/examples/metrics/views/requirements.txt index c530b620b95..719ad0fc186 100644 --- a/docs/examples/metrics/views/requirements.txt +++ b/docs/examples/metrics/views/requirements.txt @@ -1,5 +1,5 @@ -opentelemetry-api==1.12.0 -opentelemetry-sdk==1.12.0 -opentelemetry-semantic-conventions==0.33b0 -typing_extensions==4.5.0 -wrapt==1.14.1 +opentelemetry-api~=1.43 +opentelemetry-sdk~=1.43 +opentelemetry-semantic-conventions~=0.64b0 +typing_extensions~=4.5 +wrapt~=1.14 diff --git a/docs/examples/opencensus-exporter-tracer/README.rst b/docs/examples/opencensus-exporter-tracer/README.rst index 3047987c2c4..e96a027ed9e 100644 --- a/docs/examples/opencensus-exporter-tracer/README.rst +++ b/docs/examples/opencensus-exporter-tracer/README.rst @@ -1,6 +1,18 @@ OpenCensus Exporter =================== +.. warning:: + + This example is legacy and no longer works as written. It relies on + OpenTelemetry Collector components that have since been removed: the + ``opencensus`` receiver, the ``jaeger_grpc`` exporter and the + ``queued_retry`` processor, as well as the unmaintained + ``omnition/opentelemetry-collector-contrib`` image. OpenCensus itself is + end-of-life. For new code, export traces directly with the + :doc:`OTLP exporter <../../exporter/otlp/otlp>` + to a Collector configured with the ``otlp`` receiver. This example is kept + for historical reference only. + This example shows how to use the OpenCensus Exporter to export traces to the OpenTelemetry collector. diff --git a/docs/examples/opentracing/README.rst b/docs/examples/opentracing/README.rst index d811c36fd46..bb3e95864c4 100644 --- a/docs/examples/opentracing/README.rst +++ b/docs/examples/opentracing/README.rst @@ -9,8 +9,8 @@ to interact with libraries instrumented with The included ``rediscache`` library creates spans via the OpenTracing Redis integration, `redis_opentracing `_. -Spans are exported via the Jaeger exporter, which is attached to the -OpenTelemetry tracer. +Spans are exported via the OTLP exporter to a Jaeger backend, which is +attached to the OpenTelemetry tracer. The source files required to run this example are available :scm_web:`here `. diff --git a/docs/getting_started/metrics_example.py b/docs/getting_started/metrics_example.py index 7d83d04e88c..99e753647cc 100644 --- a/docs/getting_started/metrics_example.py +++ b/docs/getting_started/metrics_example.py @@ -2,7 +2,6 @@ # SPDX-License-Identifier: Apache-2.0 # metrics.py -# This is still work in progress as the metrics SDK is being implemented from collections.abc import Iterable diff --git a/docs/index.rst b/docs/index.rst index a66cc4f1ec7..8b09e63708e 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -6,21 +6,21 @@ OpenTelemetry-Python API Reference :alt: Slack Chat Welcome to the docs for the `Python OpenTelemetry implementation -`_. +`_. For an introduction to OpenTelemetry, see the `OpenTelemetry website docs `_. To learn how to instrument your Python code, see `Getting Started -`_. For +`_. For project status, information about releases, installation instructions and more, -see `Python `_. +see `Python `_. Getting Started --------------- -* `Getting Started `_ -* `Frequently Asked Questions and Cookbook `_ +* `Getting Started `_ +* `Frequently Asked Questions and Cookbook `_ .. toctree:: :maxdepth: 1