@@ -72,17 +72,21 @@ Install
72
72
-------
73
73
74
74
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.
77
78
78
79
.. code :: sh
79
80
80
- $ pip install opentelemetry-sdk
81
- $ pip install opentelemetry-instrumentation
81
+ $ pip install opentelemetry-distro
82
82
$ pip install opentelemetry-instrumentation-flask
83
83
$ pip install flask
84
84
$ pip install requests
85
85
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
+
86
90
Execute
87
91
---------
88
92
@@ -106,8 +110,8 @@ scripts that make up this example:
106
110
$ source auto_instrumentation/bin/activate
107
111
$ python client.py testing
108
112
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:
111
115
112
116
.. code :: sh
113
117
@@ -162,8 +166,8 @@ command again:
162
166
163
167
$ python client.py testing
164
168
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:
167
171
168
172
.. code :: sh
169
173
@@ -227,11 +231,3 @@ reloader. To run instrumentation while the debug mode is enabled, set the
227
231
228
232
if __name__ == " __main__" :
229
233
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