Skip to content

docs: add :scm_web: links to example README files referencing source code #5433

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
harshitnagar22 wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs: add :scm_web: links to example README files referencing source code #5433

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
677684b
docs: add :scm_web: links to example README files (#5427)
harshitnagar22 Jul 18, 2026
02137cf
docs: add :scm_web: links to example README files missing source code…
harshitnagar22 Jul 18, 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 @@ -5,3 +5,5 @@ 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

The source files of these examples are available :scm_web:`here <docs/examples/auto-instrumentation/>`.
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 of this example are available :scm_web:`here <docs/examples/error_handler/>`.
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 of this example are available :scm_web:`here <docs/examples/error_handler/>`.
2 changes: 2 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
Expand Up @@ -9,3 +9,5 @@ Run application
.. code-block:: sh

gunicorn app -c gunicorn.conf.py

The source files of this example are available :scm_web:`here <docs/examples/fork-process-model/flask-gunicorn/>`.
2 changes: 2 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
Expand Up @@ -10,3 +10,5 @@ Run application
.. code-block:: sh

uwsgi --http :8000 --wsgi-file app.py --callable application --master --enable-threads

The source files of this example are available :scm_web:`here <docs/examples/fork-process-model/flask-uwsgi/>`.
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 @@ -75,7 +75,7 @@ After running the query script, check the MySQL general log contents:

.. code-block:: sh

docker exec -it books-db tail -f /var/log/general.log
docker exec -it books-db tail -f /var/log.general.log

For each instrumented ``SELECT`` call, a query was made and logged with
a sqlcomment appended. For example:
Expand Down
Loading