From 82bcedf3e64e341952728b16bd913bdbcb7781a8 Mon Sep 17 00:00:00 2001 From: Connor Adams Date: Wed, 5 Aug 2020 14:10:22 -0400 Subject: [PATCH 1/2] docs: add install reference for cloud trace exporter --- 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..7f9120a885 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 From 2e2afc02ec4f545ab7eab48617a34bc4f5cd7b71 Mon Sep 17 00:00:00 2001 From: Connor Adams Date: Thu, 6 Aug 2020 22:09:38 -0400 Subject: [PATCH 2/2] Update docs/opentelemetry-tracing.rst Co-authored-by: larkee <31196561+larkee@users.noreply.github.com> --- docs/opentelemetry-tracing.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/opentelemetry-tracing.rst b/docs/opentelemetry-tracing.rst index 7f9120a885..9b3dea276f 100644 --- a/docs/opentelemetry-tracing.rst +++ b/docs/opentelemetry-tracing.rst @@ -13,7 +13,7 @@ To take advantage of these traces, we first need to install OpenTelemetry: # [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: +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