Skip to content

Commit af862eb

Browse files
authored
[docs] Include opentelemetry-distro as dep for auto-instrumentation example (#2317)
1 parent 9ef6829 commit af862eb

File tree

1 file changed

+12
-16
lines changed

1 file changed

+12
-16
lines changed

docs/examples/auto-instrumentation/README.rst

Lines changed: 12 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -72,17 +72,21 @@ Install
7272
-------
7373

7474
Run the following commands to install the appropriate packages. The
75-
``opentelemetry-instrumentation`` package provides several
76-
commands that help automatically instruments a program.
75+
``opentelemetry-distro`` package depends on a few others, like ``opentelemetry-sdk``
76+
for custom instrumentation of your own code and ``opentelemetry-instrumentation`` which
77+
provides several commands that help automatically instrument a program.
7778

7879
.. code:: sh
7980
80-
$ pip install opentelemetry-sdk
81-
$ pip install opentelemetry-instrumentation
81+
$ pip install opentelemetry-distro
8282
$ pip install opentelemetry-instrumentation-flask
8383
$ pip install flask
8484
$ pip install requests
8585
86+
The examples that follow send instrumentation results to the console. Learn more
87+
about installing and configuring the `OpenTelemetry Distro <../distro>`_ to send
88+
telemetry to other destinations, like an OpenTelemetry Collector.
89+
8690
Execute
8791
---------
8892

@@ -106,8 +110,8 @@ scripts that make up this example:
106110
$ source auto_instrumentation/bin/activate
107111
$ python client.py testing
108112
109-
When you execute ``server_instrumented.py`` it returns a JSON response
110-
similar to the following example:
113+
The console running ``server_instrumented.py`` will display the spans generated by instrumentation as JSON.
114+
The spans should appear similar to the following example:
111115

112116
.. code:: sh
113117
@@ -162,8 +166,8 @@ command again:
162166
163167
$ python client.py testing
164168
165-
When you execute ``server_uninstrumented.py`` it returns a JSON response
166-
similar to the following example:
169+
The console running ``server_uninstrumented.py`` will display the spans generated by instrumentation as JSON.
170+
The spans should appear similar to the following example:
167171

168172
.. code:: sh
169173
@@ -227,11 +231,3 @@ reloader. To run instrumentation while the debug mode is enabled, set the
227231
228232
if __name__ == "__main__":
229233
app.run(port=8082, debug=True, use_reloader=False)
230-
231-
232-
Additional resources
233-
~~~~~~~~~~~~~~~~~~~~
234-
235-
In order to send telemetry to an OpenTelemetry Collector without doing any
236-
additional configuration, read about the `OpenTelemetry Distro <../distro>`_
237-
package.

0 commit comments

Comments
 (0)