Cloud Trace Exporter Example

These examples show how to use OpenTelemetry to send tracing data to Cloud Trace.

Basic Example

To use this exporter you first need to:

  • Create a Google Cloud project. You can create one here.

  • Enable Cloud Trace API (listed in the Cloud Console as Stackdriver Trace API) in the project here. If the page says “API Enabled” then you’re done! No need to do anything.

  • Enable Default Application Credentials by creating setting GOOGLE_APPLICATION_CREDENTIALS or by installing gcloud sdk and calling gcloud auth application-default login.

  • Installation

pip install opentelemetry-exporter-gcp-trace \
    opentelemetry-api \
    opentelemetry-sdk

  • Run a basic example locally

# Copyright 2021 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

from opentelemetry import trace
from opentelemetry.exporter.cloud_trace import CloudTraceSpanExporter
from opentelemetry.sdk.trace import TracerProvider
from opentelemetry.sdk.trace.export import SimpleSpanProcessor

trace.set_tracer_provider(TracerProvider())

cloud_trace_exporter = CloudTraceSpanExporter()
trace.get_tracer_provider().add_span_processor(
    SimpleSpanProcessor(cloud_trace_exporter)
)
tracer = trace.get_tracer(__name__)
with tracer.start_as_current_span("foo"):
    print("Hello world!")

# Copyright 2021 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

import random
import time

# [START opentelemetry_trace_import]

from opentelemetry import trace
from opentelemetry.exporter.cloud_trace import CloudTraceSpanExporter
from opentelemetry.sdk.trace import TracerProvider
from opentelemetry.sdk.trace.export import BatchSpanProcessor
from opentelemetry.trace import Link

# [END opentelemetry_trace_import]

# [START opentelemetry_setup_exporter]

tracer_provider = TracerProvider()
cloud_trace_exporter = CloudTraceSpanExporter()
tracer_provider.add_span_processor(
    # BatchSpanProcessor buffers spans and sends them in batches in a
    # background thread. The default parameters are sensible, but can be
    # tweaked to optimize your performance
    BatchSpanProcessor(cloud_trace_exporter)
)
trace.set_tracer_provider(tracer_provider)

tracer = trace.get_tracer(__name__)

# [END opentelemetry_setup_exporter]


def do_work() -> None:
    time.sleep(random.random() * 0.5)


# [START opentelemetry_trace_custom_span]

with tracer.start_span("foo_with_attribute") as current_span:
    do_work()

    # Add attributes to the spans of various types
    current_span.set_attribute("string_attribute", "str")
    current_span.set_attribute("bool_attribute", False)
    current_span.set_attribute("int_attribute", 3)
    current_span.set_attribute("float_attribute", 3.14)

# [END opentelemetry_trace_custom_span]

# [START opentelemetry_trace_custom_span_events]

# Adding events to spans
with tracer.start_as_current_span("foo_with_event") as current_span:
    do_work()
    current_span.add_event(name="event_name")

# [END opentelemetry_trace_custom_span_events]

# [START opentelemetry_trace_custom_span_links]

# Adding links to spans
with tracer.start_as_current_span("link_target") as link_target:
    # Using start_as_current_span() instead of start_span() will make spans
    # created within this scope children of foo_with_attribute

    # Creates a span "span_with_link" and a link from
    # "span_with_link" -> "link_target"
    with tracer.start_as_current_span(
        "span_with_link", links=[Link(link_target.context)]
    ):
        do_work()

    # Creates a span "span_with_link" and a link from
    # "span_with_link" -> "link_target". This link also has the attribute
    # {"link_attr": "string"}
    with tracer.start_as_current_span(
        "span_with_link_and_link_attributes",
        links=[Link(link_target.context, attributes={"link_attr": "string"})],
    ):
        do_work()

# [END opentelemetry_trace_custom_span_links]

Checking Output

After running any of these examples, you can go to Cloud Trace overview to see the results.

Further Reading

Troubleshooting

Running basic_trace.py hangs:

  • Make sure you’ve setup Application Default Credentials. Either run gcloud auth application-default login or set the GOOGLE_APPLICATION_CREDENTIALS environment variable to be a path to a service account token file.

Getting error google.api_core.exceptions.ResourceExhausted: 429 Resource has been exhausted:

bash: pip: command not found:

  • Install pip

  • If your machine uses python2 by default, pip will also be the python2 version. Try using pip3 instead of pip.

pip install is hanging

Try upgrading pip

pip install --upgrade pip

pip install grcpio may take a long time compiling C extensions when there is no wheel available for your platform, gRPC version, and Python version.

ImportError: No module named opentelemetry

Make sure you are using python3. If

python --version

returns Python 2.X.X try calling

python3 basic_trace.py

Exporting is slow or making the program slow

opentelemetry.sdk.trace.export.SimpleSpanProcessor will slow down your program because it exports spans synchronously, one-by-one as they finish, without any batching. It should only be used for testing or debugging.

Instead, use opentelemetry.sdk.trace.export.BatchSpanProcessor (with the default parameters) which buffers spans and sends them in batches in a background thread.

trace.get_tracer_provider().add_span_processor(
    BatchSpanProcessor(cloud_trace_exporter)
)