Skip to content

Commit

Permalink
Add a note stating that OpenTelemetry traces are subject to change
Browse files Browse the repository at this point in the history
  • Loading branch information
mukund-ananthu committed Sep 24, 2024
1 parent b4fdd40 commit ad13b59
Showing 1 changed file with 16 additions and 2 deletions.
18 changes: 16 additions & 2 deletions google/cloud/pubsub_v1/types.py
Original file line number Diff line number Diff line change
Expand Up @@ -144,7 +144,14 @@ class SubscriberOptions(NamedTuple):
"""

enable_open_telemetry_tracing: bool = False
"""Whether to enable OpenTelemetry tracing."""
"""
Whether to enable OpenTelemetry tracing.
Warning: traces are subject to change. The name and attributes of a span might
change without notice. Only use run traces interactively. Don't use in
automation. Running non-interactive traces can cause problems if the underlying
trace architecture changes without notice.
"""


# Define the default publisher options.
Expand Down Expand Up @@ -191,7 +198,14 @@ class PublisherOptions(NamedTuple):
)

enable_open_telemetry_tracing: bool = False # disabled by default
"""Open Telemetry tracing is enabled if this is set to True."""
"""
Open Telemetry tracing is enabled if this is set to True.
Warning: traces are subject to change. The name and attributes of a span might
change without notice. Only use run traces interactively. Don't use in
automation. Running non-interactive traces can cause problems if the underlying
trace architecture changes without notice.
"""


# Define the type class and default values for flow control settings.
Expand Down

0 comments on commit ad13b59

Please sign in to comment.