Skip to content

Commit 23fcd4c

Browse files
authored
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
1 parent c8a371a commit 23fcd4c

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

docs/opentelemetry-tracing.rst

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,19 @@
11
Tracing with OpenTelemetry
2-
==================================
2+
==========================
3+
34
This library uses `OpenTelemetry <https://opentelemetry.io/>`_ to automatically generate traces providing insight on calls to Cloud Spanner.
45
For information on the benefits and utility of tracing, see the `Cloud Trace docs <https://cloud.google.com/trace/docs/overview>`_.
56

6-
To take advantage of these traces, we first need to install opentelemetry:
7+
To take advantage of these traces, we first need to install OpenTelemetry:
78

89
.. code-block:: sh
910
1011
pip install opentelemetry-api opentelemetry-sdk opentelemetry-instrumentation
1112
12-
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:
13+
# [Optional] Installs the cloud monitoring exporter, however you can use any exporter of your choice
14+
pip install opentelemetry-exporter-google-cloud
15+
16+
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:
1317

1418
.. code:: python
1519

0 commit comments

Comments
 (0)