Skip to content

docs: link example source directories #5429

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
himanshu-2l wants to merge 1 commit into
base: main
Choose a base branch
from
+14 −2
Open

docs: link example source directories #5429

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 3 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,7 @@ Auto-instrumentation
To learn about automatic instrumentation and how to run the example in this
directory, see `Automatic Instrumentation`_.

The source files for these examples are available :scm_web:`here
<docs/examples/auto-instrumentation/>`.

.. _Automatic Instrumentation: https://opentelemetry.io/docs/instrumentation/python/automatic/example
4 changes: 4 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,9 @@
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
4 changes: 4 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,9 @@
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
5 changes: 3 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,8 @@ 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 +122,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/>`_
Loading