Example deprecation of get_resource_data

Author: jack-burridge-cfh

exporter/opentelemetry-exporter-otlp-proto-common/src/opentelemetry/exporter/otlp/proto/common/__init__.py

@@ -15,7 +15,7 @@
 
 import logging
 from collections.abc import Sequence
-from typing import Any, Optional, List
+from typing import Any, Optional, List, Callable, TypeVar, Dict
 
 from .version import __version__
 from opentelemetry.sdk.util.instrumentation import InstrumentationScope
@@ -36,6 +36,9 @@
 
 _logger = logging.getLogger(__name__)
 
+TypingResourceT = TypeVar("TypingResourceT")
+ResourceDataT = TypeVar("ResourceDataT")
+
 
 def _encode_instrumentation_scope(
     instrumentation_scope: InstrumentationScope,
@@ -98,4 +101,30 @@ def _encode_attributes(
     return pb2_attributes
 
 
+def _get_resource_data(
+    sdk_resource_scope_data: Dict[Resource, ResourceDataT],
+    resource_class: Callable[..., TypingResourceT],
+    name: str,
+) -> List[TypingResourceT]:
+
+    resource_data = []
+
+    for (
+        sdk_resource,
+        scope_data,
+    ) in sdk_resource_scope_data.items():
+        collector_resource = PB2Resource(
+            attributes=_encode_attributes(sdk_resource.attributes)
+        )
+        resource_data.append(
+            resource_class(
+                **{
+                    "resource": collector_resource,
+                    "scope_{}".format(name): scope_data.values(),
+                }
+            )
+        )
+    return resource_data
+
+
 __all__ = ["__version__"]

exporter/opentelemetry-exporter-otlp-proto-grpc/src/opentelemetry/exporter/otlp/proto/grpc/exporter.py

@@ -23,6 +23,10 @@
 from typing import Sequence as TypingSequence
 from typing import TypeVar
 from urllib.parse import urlparse
+
+from deprecated import deprecated
+
+from opentelemetry.exporter.otlp.proto.common import _get_resource_data
 from opentelemetry.sdk.trace import ReadableSpan
 
 import backoff
@@ -42,7 +46,6 @@
     ArrayValue,
     KeyValue,
 )
-from opentelemetry.proto.resource.v1.resource_pb2 import Resource
 from opentelemetry.sdk.environment_variables import (
     OTEL_EXPORTER_OTLP_CERTIFICATE,
     OTEL_EXPORTER_OTLP_COMPRESSION,
@@ -130,41 +133,16 @@ def _translate_key_values(key: str, value: Any) -> KeyValue:
     return KeyValue(key=key, value=_translate_value(value))
 
 
+@deprecated(
+    version="1.16.0",
+    reason="Use one of the encoders from opentelemetry-exporter-otlp-proto-common instead",
+)
 def get_resource_data(
     sdk_resource_scope_data: Dict[SDKResource, ResourceDataT],
     resource_class: Callable[..., TypingResourceT],
     name: str,
 ) -> List[TypingResourceT]:
-
-    resource_data = []
-
-    for (
-        sdk_resource,
-        scope_data,
-    ) in sdk_resource_scope_data.items():
-
-        collector_resource = Resource()
-
-        for key, value in sdk_resource.attributes.items():
-
-            try:
-                # pylint: disable=no-member
-                collector_resource.attributes.append(
-                    _translate_key_values(key, value)
-                )
-            except Exception as error:  # pylint: disable=broad-except
-                logger.exception(error)
-
-        resource_data.append(
-            resource_class(
-                **{
-                    "resource": collector_resource,
-                    "scope_{}".format(name): scope_data.values(),
-                }
-            )
-        )
-
-    return resource_data
+    return _get_resource_data(sdk_resource_scope_data, resource_class, name)
 
 
 def _load_credential_from_file(filepath) -> ChannelCredentials:

opentelemetry-sdk/pyproject.toml

@@ -26,6 +26,7 @@ classifiers = [
   "Typing :: Typed",
 ]
 dependencies = [
+  "Deprecated >= 1.2.6",
   "opentelemetry-api == 1.16.0.dev",
   "opentelemetry-semantic-conventions == 0.37b0.dev",
   "setuptools >= 16.0",