From 677684b875df05f1c1d2a2cb4d368927a8dfd166 Mon Sep 17 00:00:00 2001 From: Harshit Nagar Date: Sat, 18 Jul 2026 13:28:06 +0530 Subject: [PATCH 1/2] docs: add :scm_web: links to example README files (#5427) --- docs/examples/auto-instrumentation/README.rst | 3 +++ docs/examples/error_handler/error_handler_0/README.rst | 3 +++ docs/examples/error_handler/error_handler_1/README.rst | 3 +++ docs/examples/fork-process-model/flask-gunicorn/README.rst | 3 +++ docs/examples/fork-process-model/flask-uwsgi/README.rst | 3 +++ docs/examples/sqlcommenter/README.rst | 2 +- 6 files changed, 16 insertions(+), 1 deletion(-) diff --git a/docs/examples/auto-instrumentation/README.rst b/docs/examples/auto-instrumentation/README.rst index b9f3692a372..65ecc4fdef9 100644 --- a/docs/examples/auto-instrumentation/README.rst +++ b/docs/examples/auto-instrumentation/README.rst @@ -5,3 +5,6 @@ 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 `. + diff --git a/docs/examples/error_handler/error_handler_0/README.rst b/docs/examples/error_handler/error_handler_0/README.rst index 0c86902e4ca..3d512585506 100644 --- a/docs/examples/error_handler/error_handler_0/README.rst +++ b/docs/examples/error_handler/error_handler_0/README.rst @@ -2,3 +2,6 @@ Error Handler 0 =============== This is just an error handler for this example. + +The source files of this example are available :scm_web:`here `. + diff --git a/docs/examples/error_handler/error_handler_1/README.rst b/docs/examples/error_handler/error_handler_1/README.rst index 029b95f5c0f..c6b86e74234 100644 --- a/docs/examples/error_handler/error_handler_1/README.rst +++ b/docs/examples/error_handler/error_handler_1/README.rst @@ -2,3 +2,6 @@ Error Handler 1 =============== This is just an error handler for this example. + +The source files of this example are available :scm_web:`here `. + diff --git a/docs/examples/fork-process-model/flask-gunicorn/README.rst b/docs/examples/fork-process-model/flask-gunicorn/README.rst index 6ca9790dcd7..2a27695f261 100644 --- a/docs/examples/fork-process-model/flask-gunicorn/README.rst +++ b/docs/examples/fork-process-model/flask-gunicorn/README.rst @@ -9,3 +9,6 @@ Run application .. code-block:: sh gunicorn app -c gunicorn.conf.py + +The source files of this example are available :scm_web:`here `. + diff --git a/docs/examples/fork-process-model/flask-uwsgi/README.rst b/docs/examples/fork-process-model/flask-uwsgi/README.rst index d9310e03f4c..79ebf248c20 100644 --- a/docs/examples/fork-process-model/flask-uwsgi/README.rst +++ b/docs/examples/fork-process-model/flask-uwsgi/README.rst @@ -10,3 +10,6 @@ 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 `. + diff --git a/docs/examples/sqlcommenter/README.rst b/docs/examples/sqlcommenter/README.rst index 99b5de526e7..8d4980cc650 100644 --- a/docs/examples/sqlcommenter/README.rst +++ b/docs/examples/sqlcommenter/README.rst @@ -8,7 +8,7 @@ For more information on sqlcommenter concepts, see: * `Semantic Conventions - Database Spans `_ * `sqlcommenter `_ -The source files of this example are available `here `_. +The source files of this example are available :scm_web:`here `. This example uses Docker to manage a database server and OpenTelemetry collector. Run MySQL server From 02137cf88ee63674b68d4194f91080c8b0c4cffe Mon Sep 17 00:00:00 2001 From: Harshit Nagar Date: Sat, 18 Jul 2026 13:28:09 +0530 Subject: [PATCH 2/2] docs: add :scm_web: links to example README files missing source code links --- docs/examples/auto-instrumentation/README.rst | 1 - docs/examples/error_handler/error_handler_0/README.rst | 1 - docs/examples/error_handler/error_handler_1/README.rst | 1 - docs/examples/fork-process-model/flask-gunicorn/README.rst | 1 - docs/examples/fork-process-model/flask-uwsgi/README.rst | 1 - docs/examples/sqlcommenter/README.rst | 2 +- 6 files changed, 1 insertion(+), 6 deletions(-) diff --git a/docs/examples/auto-instrumentation/README.rst b/docs/examples/auto-instrumentation/README.rst index 65ecc4fdef9..d8437fa3117 100644 --- a/docs/examples/auto-instrumentation/README.rst +++ b/docs/examples/auto-instrumentation/README.rst @@ -7,4 +7,3 @@ 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 `. - diff --git a/docs/examples/error_handler/error_handler_0/README.rst b/docs/examples/error_handler/error_handler_0/README.rst index 3d512585506..572491fd987 100644 --- a/docs/examples/error_handler/error_handler_0/README.rst +++ b/docs/examples/error_handler/error_handler_0/README.rst @@ -4,4 +4,3 @@ Error Handler 0 This is just an error handler for this example. The source files of this example are available :scm_web:`here `. - diff --git a/docs/examples/error_handler/error_handler_1/README.rst b/docs/examples/error_handler/error_handler_1/README.rst index c6b86e74234..0fc8a316965 100644 --- a/docs/examples/error_handler/error_handler_1/README.rst +++ b/docs/examples/error_handler/error_handler_1/README.rst @@ -4,4 +4,3 @@ Error Handler 1 This is just an error handler for this example. The source files of this example are available :scm_web:`here `. - diff --git a/docs/examples/fork-process-model/flask-gunicorn/README.rst b/docs/examples/fork-process-model/flask-gunicorn/README.rst index 2a27695f261..3729b795d99 100644 --- a/docs/examples/fork-process-model/flask-gunicorn/README.rst +++ b/docs/examples/fork-process-model/flask-gunicorn/README.rst @@ -11,4 +11,3 @@ Run application gunicorn app -c gunicorn.conf.py The source files of this example are available :scm_web:`here `. - diff --git a/docs/examples/fork-process-model/flask-uwsgi/README.rst b/docs/examples/fork-process-model/flask-uwsgi/README.rst index 79ebf248c20..047ec518144 100644 --- a/docs/examples/fork-process-model/flask-uwsgi/README.rst +++ b/docs/examples/fork-process-model/flask-uwsgi/README.rst @@ -12,4 +12,3 @@ Run application uwsgi --http :8000 --wsgi-file app.py --callable application --master --enable-threads The source files of this example are available :scm_web:`here `. - diff --git a/docs/examples/sqlcommenter/README.rst b/docs/examples/sqlcommenter/README.rst index 8d4980cc650..35d63348c45 100644 --- a/docs/examples/sqlcommenter/README.rst +++ b/docs/examples/sqlcommenter/README.rst @@ -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: