Set/ Override Open Telemetry enabled PublisherOption in the Publish client

Author: mukund-ananthu

google/cloud/pubsub_v1/publisher/client.py

@@ -22,6 +22,7 @@
 import typing
 from typing import Any, Dict, Optional, Sequence, Tuple, Type, Union
 import warnings
+import sys
 
 from google.api_core import gapic_v1
 from google.auth.credentials import AnonymousCredentials # type: ignore
@@ -153,6 +154,22 @@ def __init__(
  # The object controlling the message publishing flow
  self._flow_controller = FlowController(self.publisher_options.flow_control)
 
+ self._open_telemetry_enabled = (
+ self.publisher_options.enable_open_telemetry_tracing
+ )
+ # OpenTelemetry features used by the library are not supported in Python versions <= 3.7.
+ # Refer https://github.com/open-telemetry/opentelemetry-python/issues/3993#issuecomment-2211976389
+ if (
+ self.publisher_options.enable_open_telemetry_tracing
+ and sys.version_info.major == 3
+ and sys.version_info.minor < 8
+ ):
+ warnings.warn(
+ message="Open Telemetry for Python version 3.7 or lower is not supported. Disabling Open Telemetry tracing.",
+ category=RuntimeWarning,
+ )
+ self._open_telemetry_enabled = False
+
  @classmethod
  def from_service_account_file( # type: ignore[override]
  cls,

google/cloud/pubsub_v1/types.py

@@ -177,6 +177,7 @@ class PublisherOptions(NamedTuple):
  enable_open_telemetry_tracing: bool = False # disabled by default
  """Open Telemetry tracing is enabled if this is set to True."""
 
+
 # Define the type class and default values for flow control settings.
 #
 # This class is used when creating a publisher or subscriber client, and

tests/unit/pubsub_v1/publisher/test_publisher_client.py

@@ -129,6 +129,38 @@ def test_init_w_custom_transport(creds):
  assert client.batch_settings.max_messages == 100
 
 
+@pytest.mark.parametrize(
+ "enable_open_telemetry",
+ [
+ True,
+ False,
+ ],
+)
+def test_open_telemetry_publisher_options(creds, enable_open_telemetry):
+ if sys.version_info >= (3, 8) or enable_open_telemetry is False:
+ client = publisher.Client(
+ publisher_options=types.PublisherOptions(
+ enable_open_telemetry_tracing=enable_open_telemetry
+ ),
+ credentials=creds,
+ )
+ assert client._open_telemetry_enabled == enable_open_telemetry
+ else:
+ # Open Telemetry is not supported and hence disabled for Python
+ # versions 3.7 or below
+ with pytest.warns(
+ RuntimeWarning,
+ match="Open Telemetry for Python version 3.7 or lower is not supported. Disabling Open Telemetry tracing.",
+ ):
+ client = publisher.Client(
+ publisher_options=types.PublisherOptions(
+ enable_open_telemetry_tracing=True
+ ),
+ credentials=creds,
+ )
+ assert client._open_telemetry_enabled is False
+
+
 def test_init_w_api_endpoint(creds):
  client_options = {"api_endpoint": "testendpoint.google.com"}
  client = publisher.Client(client_options=client_options, credentials=creds)