From af862eb3292edf97a7cd5eae03f58bb6e27f97c8 Mon Sep 17 00:00:00 2001 From: Robb Kidd Date: Fri, 10 Dec 2021 11:41:49 -0500 Subject: [PATCH] [docs] Include opentelemetry-distro as dep for auto-instrumentation example (#2317) --- docs/examples/auto-instrumentation/README.rst | 28 ++++++++----------- 1 file changed, 12 insertions(+), 16 deletions(-) diff --git a/docs/examples/auto-instrumentation/README.rst b/docs/examples/auto-instrumentation/README.rst index 7ebd8a76d3..4fdb896482 100644 --- a/docs/examples/auto-instrumentation/README.rst +++ b/docs/examples/auto-instrumentation/README.rst @@ -72,17 +72,21 @@ Install ------- Run the following commands to install the appropriate packages. The -``opentelemetry-instrumentation`` package provides several -commands that help automatically instruments a program. +``opentelemetry-distro`` package depends on a few others, like ``opentelemetry-sdk`` +for custom instrumentation of your own code and ``opentelemetry-instrumentation`` which +provides several commands that help automatically instrument a program. .. code:: sh - $ pip install opentelemetry-sdk - $ pip install opentelemetry-instrumentation + $ pip install opentelemetry-distro $ pip install opentelemetry-instrumentation-flask $ pip install flask $ pip install requests +The examples that follow send instrumentation results to the console. Learn more +about installing and configuring the `OpenTelemetry Distro <../distro>`_ to send +telemetry to other destinations, like an OpenTelemetry Collector. + Execute --------- @@ -106,8 +110,8 @@ scripts that make up this example: $ source auto_instrumentation/bin/activate $ python client.py testing -When you execute ``server_instrumented.py`` it returns a JSON response -similar to the following example: +The console running ``server_instrumented.py`` will display the spans generated by instrumentation as JSON. +The spans should appear similar to the following example: .. code:: sh @@ -162,8 +166,8 @@ command again: $ python client.py testing -When you execute ``server_uninstrumented.py`` it returns a JSON response -similar to the following example: +The console running ``server_uninstrumented.py`` will display the spans generated by instrumentation as JSON. +The spans should appear similar to the following example: .. code:: sh @@ -227,11 +231,3 @@ reloader. To run instrumentation while the debug mode is enabled, set the if __name__ == "__main__": app.run(port=8082, debug=True, use_reloader=False) - - -Additional resources -~~~~~~~~~~~~~~~~~~~~ - -In order to send telemetry to an OpenTelemetry Collector without doing any -additional configuration, read about the `OpenTelemetry Distro <../distro>`_ -package.