From 23fcd4c91d908f00eda5ff57f6ccea3dfe936b57 Mon Sep 17 00:00:00 2001 From: Connor Adams Date: Fri, 7 Aug 2020 03:54:03 -0400 Subject: [PATCH] docs: add install reference for cloud trace exporter (opentelemetry) (#127) The example uses the Cloud Trace exporter, but there is no `pip install` mentioned for it in the example. \+ misc doc fixes --- docs/opentelemetry-tracing.rst | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/docs/opentelemetry-tracing.rst b/docs/opentelemetry-tracing.rst index 8906db43b6..9b3dea276f 100644 --- a/docs/opentelemetry-tracing.rst +++ b/docs/opentelemetry-tracing.rst @@ -1,15 +1,19 @@ Tracing with OpenTelemetry -================================== +========================== + This library uses `OpenTelemetry `_ to automatically generate traces providing insight on calls to Cloud Spanner. For information on the benefits and utility of tracing, see the `Cloud Trace docs `_. -To take advantage of these traces, we first need to install opentelemetry: +To take advantage of these traces, we first need to install OpenTelemetry: .. code-block:: sh pip install opentelemetry-api opentelemetry-sdk opentelemetry-instrumentation -We also need to tell OpenTelemetry which exporter to use. For example, to export python-spanner traces to `Cloud Tracing `_, add the following lines to your application: + # [Optional] Installs the cloud monitoring exporter, however you can use any exporter of your choice + pip install opentelemetry-exporter-google-cloud + +We also need to tell OpenTelemetry which exporter to use. To export Spanner traces to `Cloud Tracing `_, add the following lines to your application: .. code:: python