Skip to content
Permalink
Browse files
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
  • Loading branch information
cnnradams committed Aug 7, 2020
1 parent c8a371a commit 23fcd4c91d908f00eda5ff57f6ccea3dfe936b57
Showing with 7 additions and 3 deletions.
  1. +7 −3 docs/opentelemetry-tracing.rst
@@ -1,15 +1,19 @@
Tracing with OpenTelemetry
==================================
==========================

This library uses `OpenTelemetry <https://opentelemetry.io/>`_ 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 <https://cloud.google.com/trace/docs/overview>`_.

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 <https://cloud.google.com/trace>`_, 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 <https://cloud.google.com/trace>`_, add the following lines to your application:

.. code:: python

0 comments on commit 23fcd4c

Please sign in to comment.