Changed MetricsTracer to have its own setters for attributes

Author: lszinv

google/cloud/spanner_v1/metrics/metrics_exporter.py

@@ -62,7 +62,7 @@
     from opentelemetry.sdk.resources import Resource
 
     HAS_OPENTELEMETRY_INSTALLED = True
-except ImportError:
+except ImportError:  # pragma: NO COVER
     HAS_OPENTELEMETRY_INSTALLED = False
 
 try:

google/cloud/spanner_v1/metrics/metrics_tracer.py

@@ -24,10 +24,18 @@
 from typing import Dict
 from grpc import StatusCode
 from .constants import (
-    METRIC_LABEL_KEY_STATUS,
-    METRIC_LABEL_KEY_METHOD,
+    METRIC_LABEL_KEY_CLIENT_NAME,
+    METRIC_LABEL_KEY_CLIENT_UID,
+    METRIC_LABEL_KEY_DATABASE,
     METRIC_LABEL_KEY_DIRECT_PATH_ENABLED,
     METRIC_LABEL_KEY_DIRECT_PATH_USED,
+    METRIC_LABEL_KEY_METHOD,
+    METRIC_LABEL_KEY_STATUS,
+    MONITORED_RES_LABEL_KEY_CLIENT_HASH,
+    MONITORED_RES_LABEL_KEY_INSTANCE,
+    MONITORED_RES_LABEL_KEY_INSTANCE_CONFIG,
+    MONITORED_RES_LABEL_KEY_LOCATION,
+    MONITORED_RES_LABEL_KEY_PROJECT,
 )
 
 try:
@@ -107,23 +115,62 @@ def __init__(self, is_direct_path_enabled: bool = False):
 
     @property
     def attempt_count(self):
+        """
+        Getter method for the attempt_count property.
+
+        This method returns the current count of attempts made for the metric operation.
+
+        Returns:
+            int: The current count of attempts.
+        """
         return self._attempt_count
 
     @property
     def current_attempt(self):
+        """
+        Getter method for the current_attempt property.
+
+        This method returns the current MetricAttemptTracer instance associated with the metric operation.
+
+        Returns:
+            MetricAttemptTracer: The current MetricAttemptTracer instance.
+        """
         return self._current_attempt
 
     @property
     def start_time(self):
+        """
+        Getter method for the start_time property.
+
+        This method returns the start time of the metric operation.
+
+        Returns:
+            datetime: The start time of the metric operation.
+        """
         return self._start_time
 
     def increment_attempt_count(self):
+        """
+        Increments the attempt count by 1.
+
+        This method updates the attempt count by incrementing it by 1, indicating a new attempt has been made.
+        """
         self._attempt_count += 1
 
     def start(self):
+        """
+        Sets the start time of the metric operation to the current time.
+
+        This method updates the start time of the metric operation to the current time, indicating the operation has started.
+        """
         self._start_time = datetime.now()
 
     def new_attempt(self):
+        """
+        Initializes a new MetricAttemptTracer instance for the current metric operation.
+
+        This method sets up a new MetricAttemptTracer instance, indicating a new attempt is being made within the metric operation.
+        """
         self._current_attempt = MetricAttemptTracer()
 
 
@@ -181,10 +228,29 @@ def __init__(
         self._instrument_operation_counter = instrument_operation_counter
         self.enabled = enabled
 
+    @staticmethod
+    def _get_ms_time_diff(start: datetime, end: datetime) -> float:
+        """
+        Calculate the time difference in milliseconds between two datetime objects.
+
+        This method calculates the time difference between two datetime objects and returns the result in milliseconds.
+        This is useful for measuring the duration of operations or attempts for metrics tracing.
+        Note: total_seconds() returns a float value of seconds.
+
+        Args:
+            start (datetime): The start datetime.
+            end (datetime): The end datetime.
+
+        Returns:
+            float: The time difference in milliseconds.
+        """
+        time_delta = end - start
+        return time_delta.total_seconds() * 1000
+
     @property
     def client_attributes(self) -> Dict[str, str]:
         """
-        Returns a dictionary of client attributes used for metrics tracing.
+        Return a dictionary of client attributes used for metrics tracing.
 
         This property returns a dictionary containing client attributes such as project, instance,
         instance configuration, location, client hash, client UID, client name, and database.
@@ -198,7 +264,7 @@ def client_attributes(self) -> Dict[str, str]:
     @property
     def instrument_attempt_counter(self) -> Counter:
         """
-        Returns the instrument for counting attempts.
+        Return the instrument for counting attempts.
 
         This property returns the Counter instrument used to count the number of attempts made during RPC operations.
         This metric is useful for tracking the frequency of attempts and can help identify patterns or issues in the operation flow.
@@ -211,7 +277,7 @@ def instrument_attempt_counter(self) -> Counter:
     @property
     def instrument_attempt_latency(self) -> Histogram:
         """
-        Returns the instrument for measuring attempt latency.
+        Return the instrument for measuring attempt latency.
 
         This property returns the Histogram instrument used to measure the latency of individual attempts.
         This metric is useful for tracking the performance of attempts and can help identify bottlenecks or issues in the operation flow.
@@ -224,7 +290,7 @@ def instrument_attempt_latency(self) -> Histogram:
     @property
     def instrument_operation_counter(self) -> Counter:
         """
-        Returns the instrument for counting operations.
+        Return the instrument for counting operations.
 
         This property returns the Counter instrument used to count the number of operations made during RPC operations.
         This metric is useful for tracking the frequency of operations and can help identify patterns or issues in the operation flow.
@@ -237,7 +303,7 @@ def instrument_operation_counter(self) -> Counter:
     @property
     def instrument_operation_latency(self) -> Histogram:
         """
-        Returns the instrument for measuring operation latency.
+        Return the instrument for measuring operation latency.
 
         This property returns the Histogram instrument used to measure the latency of operations.
         This metric is useful for tracking the performance of operations and can help identify bottlenecks or issues in the operation flow.
@@ -249,7 +315,7 @@ def instrument_operation_latency(self) -> Histogram:
 
     def record_attempt_start(self) -> None:
         """
-        Records the start of a new attempt within the current operation.
+        Record the start of a new attempt within the current operation.
 
         This method increments the attempt count for the current operation and marks the start of a new attempt.
         It is used to track the number of attempts made during an operation and to identify the start of each attempt for metrics and tracing purposes.
@@ -259,7 +325,7 @@ def record_attempt_start(self) -> None:
 
     def record_attempt_completion(self, status: str = StatusCode.OK.name) -> None:
         """
-        Records the completion of an attempt within the current operation.
+        Record the completion of an attempt within the current operation.
 
         This method updates the status of the current attempt to indicate its completion and records the latency of the attempt.
         It calculates the elapsed time since the attempt started and uses this value to record the attempt latency metric.
@@ -308,7 +374,6 @@ def record_operation_completion(self) -> None:
         if not self.enabled:
             return
         end_time = datetime.now()
-
         # Build Attributes
         operation_attributes = self._create_operation_otel_attributes()
         attempt_attributes = self._create_attempt_otel_attributes()
@@ -345,17 +410,16 @@ def _create_otel_attributes(self) -> Dict[str, str]:
         if not self.enabled:
             return
 
-        attributes = self.client_attributes.copy()
-        attributes[METRIC_LABEL_KEY_METHOD] = self.method
-        attributes[METRIC_LABEL_KEY_DIRECT_PATH_ENABLED] = str(
+        self.client_attributes[METRIC_LABEL_KEY_METHOD] = self.method
+        self.client_attributes[METRIC_LABEL_KEY_DIRECT_PATH_ENABLED] = str(
             self.current_op.direct_path_enabled
         )
         if self.current_op.current_attempt is not None:
-            attributes[METRIC_LABEL_KEY_DIRECT_PATH_USED] = str(
+            self.client_attributes[METRIC_LABEL_KEY_DIRECT_PATH_USED] = str(
                 self.current_op.current_attempt.direct_path_used
             )
 
-        return attributes
+        return self.client_attributes
 
     def _create_operation_otel_attributes(self) -> Dict[str, str]:
         """
@@ -395,21 +459,130 @@ def _create_attempt_otel_attributes(self) -> Dict[str, str]:
 
         return attributes
 
-    @staticmethod
-    def _get_ms_time_diff(start: datetime, end: datetime) -> float:
+    def set_project(self, project: str) -> "MetricsTracer":
         """
-        Calculate the time difference in milliseconds between two datetime objects.
+        Set the project attribute for metrics tracing.
 
-        This method calculates the time difference between two datetime objects and returns the result in milliseconds.
-        This is useful for measuring the duration of operations or attempts for metrics tracing.
-        Note: total_seconds() returns a float value of seconds.
+        This method updates the project attribute in the client attributes dictionary for metrics tracing purposes.
+        If the project attribute already has a value, this method does nothing and returns.
 
-        Args:
-            start (datetime): The start datetime.
-            end (datetime): The end datetime.
+        :param project: The project name to set.
+        :return: This instance of MetricsTracer for method chaining.
+        """
+        if MONITORED_RES_LABEL_KEY_PROJECT not in self._client_attributes:
+            self._client_attributes[MONITORED_RES_LABEL_KEY_PROJECT] = project
+        return self
 
-        Returns:
-            float: The time difference in milliseconds.
+    def set_instance(self, instance: str) -> "MetricsTracer":
         """
-        time_delta = end - start
-        return time_delta.total_seconds() * 1000
+        Set the instance attribute for metrics tracing.
+
+        This method updates the instance attribute in the client attributes dictionary for metrics tracing purposes.
+        If the instance attribute already has a value, this method does nothing and returns.
+
+        :param instance: The instance name to set.
+        :return: This instance of MetricsTracer for method chaining.
+        """
+        if MONITORED_RES_LABEL_KEY_INSTANCE not in self._client_attributes:
+            self._client_attributes[MONITORED_RES_LABEL_KEY_INSTANCE] = instance
+        return self
+
+    def set_instance_config(self, instance_config: str) -> "MetricsTracer":
+        """
+        Set the instance configuration attribute for metrics tracing.
+
+        This method updates the instance configuration attribute in the client attributes dictionary for metrics tracing purposes.
+        If the instance configuration attribute already has a value, this method does nothing and returns.
+
+        :param instance_config: The instance configuration name to set.
+        :return: This instance of MetricsTracer for method chaining.
+        """
+        if MONITORED_RES_LABEL_KEY_INSTANCE_CONFIG not in self._client_attributes:
+            self._client_attributes[
+                MONITORED_RES_LABEL_KEY_INSTANCE_CONFIG
+            ] = instance_config
+        return self
+
+    def set_location(self, location: str) -> "MetricsTracer":
+        """
+        Set the location attribute for metrics tracing.
+
+        This method updates the location attribute in the client attributes dictionary for metrics tracing purposes.
+        If the location attribute already has a value, this method does nothing and returns.
+
+        :param location: The location name to set.
+        :return: This instance of MetricsTracer for method chaining.
+        """
+        if MONITORED_RES_LABEL_KEY_LOCATION not in self._client_attributes:
+            self._client_attributes[MONITORED_RES_LABEL_KEY_LOCATION] = location
+        return self
+
+    def set_client_hash(self, hash: str) -> "MetricsTracer":
+        """
+        Set the client hash attribute for metrics tracing.
+
+        This method updates the client hash attribute in the client attributes dictionary for metrics tracing purposes.
+        If the client hash attribute already has a value, this method does nothing and returns.
+
+        :param hash: The client hash to set.
+        :return: This instance of MetricsTracer for method chaining.
+        """
+        if MONITORED_RES_LABEL_KEY_CLIENT_HASH not in self._client_attributes:
+            self._client_attributes[MONITORED_RES_LABEL_KEY_CLIENT_HASH] = hash
+        return self
+
+    def set_client_uid(self, client_uid: str) -> "MetricsTracer":
+        """
+        Set the client UID attribute for metrics tracing.
+
+        This method updates the client UID attribute in the client attributes dictionary for metrics tracing purposes.
+        If the client UID attribute already has a value, this method does nothing and returns.
+
+        :param client_uid: The client UID to set.
+        :return: This instance of MetricsTracer for method chaining.
+        """
+        if METRIC_LABEL_KEY_CLIENT_UID not in self._client_attributes:
+            self._client_attributes[METRIC_LABEL_KEY_CLIENT_UID] = client_uid
+        return self
+
+    def set_client_name(self, client_name: str) -> "MetricsTracer":
+        """
+        Set the client name attribute for metrics tracing.
+
+        This method updates the client name attribute in the client attributes dictionary for metrics tracing purposes.
+        If the client name attribute already has a value, this method does nothing and returns.
+
+        :param client_name: The client name to set.
+        :return: This instance of MetricsTracer for method chaining.
+        """
+        if METRIC_LABEL_KEY_CLIENT_NAME not in self._client_attributes:
+            self._client_attributes[METRIC_LABEL_KEY_CLIENT_NAME] = client_name
+        return self
+
+    def set_database(self, database: str) -> "MetricsTracer":
+        """
+        Set the database attribute for metrics tracing.
+
+        This method updates the database attribute in the client attributes dictionary for metrics tracing purposes.
+        If the database attribute already has a value, this method does nothing and returns.
+
+        :param database: The database name to set.
+        :return: This instance of MetricsTracer for method chaining.
+        """
+        if METRIC_LABEL_KEY_DATABASE not in self._client_attributes:
+            self._client_attributes[METRIC_LABEL_KEY_DATABASE] = database
+        return self
+
+    def enable_direct_path(self, enable: bool = False) -> "MetricsTracer":
+        """
+        Enable or disable the direct path for metrics tracing.
+
+        This method updates the direct path enabled attribute in the client attributes dictionary for metrics tracing purposes.
+        If the direct path enabled attribute already has a value, this method does nothing and returns.
+
+        :param enable: Boolean indicating whether to enable the direct path.
+        :return: This instance of MetricsTracer for method chaining.
+        """
+        if METRIC_LABEL_KEY_DIRECT_PATH_ENABLED not in self._client_attributes:
+            self._client_attributes[METRIC_LABEL_KEY_DIRECT_PATH_ENABLED] = str(enable)
+        return self