[io] feat: add telemetry support

Author: AndreyMarkinPPC

libs/io/garf_io/__init__.py

@@ -11,7 +11,6 @@
 # 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.
+"""Write GarfReport to anywhere."""
 
-"""Writing GarfReport to anywhere."""
-
-__version__ = '0.0.16'
+__version__ = '0.1.0'

libs/io/garf_io/formatter.py

@@ -22,6 +22,8 @@
 from garf_core import report as garf_report
 from typing_extensions import TypeAlias
 
+from garf_io.telemetry import tracer
+
 _NESTED_FIELD: TypeAlias = Union[list, tuple]
 
 
@@ -70,6 +72,7 @@ def __init__(
     self.type_ = self._cast_to_enum(ArrayHandling, type_)
     self.delimiter = delimiter
 
+  @tracer.start_as_current_span('apply_transformations')
   def apply_transformations(
     self, report: garf_report.GarfReport
   ) -> garf_report.GarfReport:
@@ -121,6 +124,7 @@ def _delimiter_join(self, field: _NESTED_FIELD) -> str:
     return self.delimiter.join([str(element) for element in field])
 
 
+@tracer.start_as_current_span('format_report_for_writing')
 def format_report_for_writing(
   report: garf_report.GarfReport,
   formatting_strategies: list[FormattingStrategy],

libs/io/garf_io/reader.py

@@ -17,6 +17,8 @@
 import smart_open
 from typing_extensions import override
 
+from garf_io.telemetry import tracer
+
 
 class AbsReader(abc.ABC):
   """Base class for reading queries."""
@@ -30,6 +32,7 @@ class FileReader(AbsReader):
   """Reads from file."""
 
   @override
+  @tracer.start_as_current_span('file.read')
   def read(self, query_path, **kwargs):
     with smart_open.open(query_path, 'r') as f:
       return f.read()
@@ -39,6 +42,7 @@ class ConsoleReader(AbsReader):
   """Read query from standard input."""
 
   @override
+  @tracer.start_as_current_span('console.read')
   def read(self, query_path, **kwargs):
     return query_path
 

libs/io/garf_io/telemetry.py

@@ -0,0 +1,20 @@
+# Copyright 2025 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
+#
+#     https://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.
+
+# pylint: disable=C0330, g-bad-import-order, g-multiple-import
+from opentelemetry import trace
+
+tracer = trace.get_tracer(
+  instrumenting_module_name='garf_io',
+)

libs/io/garf_io/writers/abs_writer.py

@@ -22,6 +22,7 @@
 from garf_core.report import GarfReport
 
 from garf_io import formatter
+from garf_io.telemetry import tracer
 
 logger = logging.getLogger(__name__)
 
@@ -43,6 +44,7 @@ def __init__(
   def write(self, report: GarfReport, destination: str) -> str | None:
     """Writes report to destination."""
 
+  @tracer.start_as_current_span('format_for_write')
   def format_for_write(self, report: GarfReport) -> GarfReport:
     """Prepares report for writing."""
     array_handling_strategy = formatter.ArrayHandlingStrategy(

libs/io/garf_io/writers/bigquery_writer.py

@@ -34,6 +34,7 @@
 from google.cloud import exceptions as google_cloud_exceptions
 
 from garf_io import exceptions, formatter
+from garf_io.telemetry import tracer
 from garf_io.writers import abs_writer
 
 logger = logging.getLogger(__name__)
@@ -110,6 +111,7 @@ def client(self) -> bigquery.Client:
     """Instantiated BigQuery client."""
     return bigquery.Client(self.project)
 
+  @tracer.start_as_current_span('bq.create_or_get_dataset')
   def create_or_get_dataset(self) -> bigquery.Dataset:
     """Gets existing dataset or create a new one."""
     try:
@@ -120,6 +122,7 @@ def create_or_get_dataset(self) -> bigquery.Dataset:
       bq_dataset = self.client.create_dataset(bq_dataset, timeout=30)
     return bq_dataset
 
+  @tracer.start_as_current_span('bq.write')
   def write(self, report: garf_report.GarfReport, destination: str) -> str:
     """Writes Garf report to a BigQuery table.
 

libs/io/garf_io/writers/console_writer.py

@@ -21,6 +21,7 @@
 from garf_core import report as garf_report
 from rich import console, table
 
+from garf_io.telemetry import tracer
 from garf_io.writers import abs_writer
 
 
@@ -49,6 +50,7 @@ def __init__(
     self.page_size = int(page_size)
     self.format = format
 
+  @tracer.start_as_current_span('console.write')
   def write(self, report: garf_report.GarfReport, destination: str) -> None:
     """Writes Garf report to standard output.
 

libs/io/garf_io/writers/csv_writer.py

@@ -28,6 +28,7 @@
 from garf_core import report as garf_report
 
 from garf_io import formatter
+from garf_io.telemetry import tracer
 from garf_io.writers import file_writer
 
 logger = logging.getLogger(__name__)
@@ -72,6 +73,7 @@ def __str__(self):
       f'[CSV] - data are saved to {self.destination_folder} destination_folder.'
     )
 
+  @tracer.start_as_current_span('csv.write')
   def write(self, report: garf_report.GarfReport, destination: str) -> str:
     """Writes Garf report to a CSV file.
 

libs/io/garf_io/writers/file_writer.py

@@ -17,6 +17,7 @@
 import pathlib
 from typing import Union
 
+from garf_io.telemetry import tracer
 from garf_io.writers.abs_writer import AbsWriter
 
 
@@ -38,6 +39,7 @@ def __init__(
     super().__init__(**kwargs)
     self.destination_folder = str(destination_folder)
 
+  @tracer.start_as_current_span('file.create_dir')
   def create_dir(self) -> None:
     """Creates folders if needed or destination is not remote."""
     if (

libs/io/garf_io/writers/json_writer.py

@@ -24,6 +24,7 @@
 from garf_core import report as garf_report
 
 from garf_io import formatter
+from garf_io.telemetry import tracer
 from garf_io.writers import file_writer
 
 logger = logging.getLogger(__name__)
@@ -54,6 +55,7 @@ def __init__(
     super().__init__(destination_folder=destination_folder, **kwargs)
     self.format = format
 
+  @tracer.start_as_current_span('json.write')
   def write(self, report: garf_report.GarfReport, destination: str) -> str:
     """Writes Garf report to a JSON file.