Skip to content

docs: add install reference for cloud trace exporter (opentelemetry) #127

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
gcf-merge-on-green merged 4 commits into from
Aug 7, 2020
Merged

docs: add install reference for cloud trace exporter (opentelemetry) #127

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
82bcedf
docs: add install reference for cloud trace exporter
cnnradams Aug 5, 2020
26e423d
Merge branch 'master' into opentelemetry-tracing
cnnradams Aug 6, 2020
2e2afc0
Update docs/opentelemetry-tracing.rst
cnnradams Aug 7, 2020
9e7505f
Merge branch 'master' into opentelemetry-tracing
larkee Aug 7, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 7 additions & 3 deletions docs/opentelemetry-tracing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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

Expand Down