Skip to content

docs: link example source files from READMEs #5515

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
slegarraga wants to merge 2 commits into
base: main
Choose a base branch
from
+19 −7
Open

docs: link example source files from READMEs #5515

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c16faf7
docs: link example source files from READMEs
slegarraga Aug 6, 2026
4cd75b0
chore: re-trigger CI and EasyCLA evaluation
slegarraga Aug 21, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/examples/auto-instrumentation/README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,6 @@ Auto-instrumentation
To learn about automatic instrumentation and how to run the example in this
directory, see `Automatic Instrumentation`_.

The source files of this example are available :scm_web:`here <docs/examples/auto-instrumentation/>`.

.. _Automatic Instrumentation: https://opentelemetry.io/docs/instrumentation/python/automatic/example
2 changes: 2 additions & 0 deletions docs/examples/error_handler/error_handler_0/README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,5 @@ Error Handler 0
===============

This is just an error handler for this example.

The source files for this subexample are available :scm_web:`here <docs/examples/error_handler/error_handler_0/>`.
2 changes: 2 additions & 0 deletions docs/examples/error_handler/error_handler_1/README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,5 @@ Error Handler 1
===============

This is just an error handler for this example.

The source files for this subexample are available :scm_web:`here <docs/examples/error_handler/error_handler_1/>`.
3 changes: 3 additions & 0 deletions docs/examples/fork-process-model/flask-gunicorn/README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
Installation
------------

The source files of this example are available :scm_web:`here <docs/examples/fork-process-model/flask-gunicorn/>`.

.. code-block:: sh

pip install -rrequirements.txt
Expand Down
3 changes: 3 additions & 0 deletions docs/examples/fork-process-model/flask-uwsgi/README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
Installation
------------

The source files of this example are available :scm_web:`here <docs/examples/fork-process-model/flask-uwsgi/>`.

.. code-block:: sh

pip install -rrequirements.txt
Expand Down
10 changes: 5 additions & 5 deletions docs/examples/metrics/views/README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,11 @@ View common scenarios

These examples show how to customize the metrics that are output by the SDK using Views. There are multiple examples:

* change_aggregation.py: Shows how to configure to change the default aggregation for an instrument.
* change_name.py: Shows how to change the name of a metric.
* limit_num_of_attrs.py: Shows how to limit the number of attributes that are output for a metric.
* drop_metrics_from_instrument.py: Shows how to drop measurements from an instrument.
* change_reservoir_factory.py: Shows how to use your own ``ExemplarReservoir``
* :scm_web:`change_aggregation.py <docs/examples/metrics/views/change_aggregation.py>`: Shows how to configure to change the default aggregation for an instrument.
* :scm_web:`change_name.py <docs/examples/metrics/views/change_name.py>`: Shows how to change the name of a metric.
* :scm_web:`limit_num_of_attrs.py <docs/examples/metrics/views/limit_num_of_attrs.py>`: Shows how to limit the number of attributes that are output for a metric.
* :scm_web:`drop_metrics_from_instrument.py <docs/examples/metrics/views/drop_metrics_from_instrument.py>`: Shows how to drop measurements from an instrument.
* :scm_web:`change_reservoir_factory.py <docs/examples/metrics/views/change_reservoir_factory.py>`: Shows how to use your own ``ExemplarReservoir``

The source files of these examples are available :scm_web:`here <docs/examples/metrics/views/>`.

Expand Down
4 changes: 2 additions & 2 deletions docs/examples/sqlcommenter/README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ For more information on sqlcommenter concepts, see:
* `Semantic Conventions - Database Spans <https://github.com/open-telemetry/semantic-conventions/blob/main/docs/db/database-spans.md#sql-commenter>`_
* `sqlcommenter <https://google.github.io/sqlcommenter/>`_

The source files of this example are available `here <https://github.com/open-telemetry/opentelemetry-python/tree/main/docs/examples/sqlcommenter/>`_.
The source files of this example are available :scm_web:`here <docs/examples/sqlcommenter/>`.
This example uses Docker to manage a database server and OpenTelemetry collector.

Run MySQL server
Expand Down Expand Up @@ -121,4 +121,4 @@ References
* `OpenTelemetry Collector <https://github.com/open-telemetry/opentelemetry-collector>`_
* `OpenTelemetry MySQL instrumentation <https://github.com/open-telemetry/opentelemetry-python-contrib/tree/main/instrumentation/opentelemetry-instrumentation-mysql>`_
* `Semantic Conventions - Database Spans <https://github.com/open-telemetry/semantic-conventions/blob/main/docs/db/database-spans.md#sql-commenter>`_
* `sqlcommenter <https://google.github.io/sqlcommenter/>`_
* `sqlcommenter <https://google.github.io/sqlcommenter/>`_