feat: deprecate register_otel_exporter function

Author: Pouyanpi

examples/configs/tracing/README.md

@@ -337,6 +337,36 @@ config = RailsConfig.from_content(
 )
 ```
 
+### Deprecated Features
+
+#### register_otel_exporter Function
+
+The `register_otel_exporter` function is deprecated and will be removed in version 0.16.0:
+
+```python
+#  DEPRECATED - will be removed in 0.16.0
+from nemoguardrails.tracing.adapters.opentelemetry import register_otel_exporter
+from opentelemetry.exporter.otlp.proto.http.trace_exporter import OTLPSpanExporter
+
+register_otel_exporter("my-otlp", OTLPSpanExporter)
+```
+
+Instead, configure exporters directly in your application:
+
+```python
+from opentelemetry import trace
+from opentelemetry.sdk.trace import TracerProvider
+from opentelemetry.sdk.trace.export import BatchSpanProcessor
+from opentelemetry.exporter.otlp.proto.http.trace_exporter import OTLPSpanExporter
+
+tracer_provider = TracerProvider()
+trace.set_tracer_provider(tracer_provider)
+
+otlp_exporter = OTLPSpanExporter(endpoint="http://localhost:4318")
+span_processor = BatchSpanProcessor(otlp_exporter)
+tracer_provider.add_span_processor(span_processor)
+```
+
 ### Why the Change?
 
 This change follows OpenTelemetry best practices:

nemoguardrails/tracing/adapters/opentelemetry.py

@@ -55,7 +55,7 @@
 
 import warnings
 from importlib.metadata import version
-from typing import TYPE_CHECKING
+from typing import TYPE_CHECKING, Optional, Type
 
 if TYPE_CHECKING:
     from nemoguardrails.tracing import InteractionLog
@@ -71,6 +71,34 @@
 
 from nemoguardrails.tracing.adapters.base import InteractionLogAdapter
 
+# DEPRECATED: global dictionary to store registered exporters
+# will be removed in  v0.16.0
+_exporter_name_cls_map: dict[str, Type] = {}
+
+
+def register_otel_exporter(name: str, exporter_cls: Type):
+    """Register a new exporter.
+
+    Args:
+        name: The name to register the exporter under.
+        exporter_cls: The exporter class to register.
+
+    Deprecated:
+        This function is deprecated and will be removed in version 0.16.0.
+        Please configure OpenTelemetry exporters directly in your application code.
+        See the migration guide at:
+        https://github.com/NVIDIA/NeMo-Guardrails/blob/main/examples/configs/tracing/README.md#migration-guide
+    """
+    warnings.warn(
+        "register_otel_exporter is deprecated and will be removed in version 0.16.0. "
+        "Please configure OpenTelemetry exporters directly in your application code. "
+        "See the migration guide at: "
+        "https://github.com/NVIDIA/NeMo-Guardrails/blob/develop/examples/configs/tracing/README.md#migration-guide",
+        DeprecationWarning,
+        stacklevel=2,
+    )
+    _exporter_name_cls_map[name] = exporter_cls
+
 
 class OpenTelemetryAdapter(InteractionLogAdapter):
     """

tests/test_tracing_adapters_opentelemetry.py

@@ -332,7 +332,6 @@ def test_no_op_tracer_provider_warning(self):
 
     def test_no_warnings_with_proper_configuration(self):
         """Test that no warnings are issued when properly configured."""
-
         with warnings.catch_warnings(record=True) as w:
             warnings.simplefilter("always")
 
@@ -341,3 +340,25 @@ def test_no_warnings_with_proper_configuration(self):
 
             # no warnings is issued
             self.assertEqual(len(w), 0)
+
+    def test_register_otel_exporter_deprecation(self):
+        """Test that register_otel_exporter shows deprecation warning."""
+        from nemoguardrails.tracing.adapters.opentelemetry import register_otel_exporter
+
+        with warnings.catch_warnings(record=True) as w:
+            warnings.simplefilter("always")
+
+            mock_exporter_cls = MagicMock()
+
+            register_otel_exporter("test-exporter", mock_exporter_cls)
+
+            self.assertEqual(len(w), 1)
+            self.assertTrue(issubclass(w[0].category, DeprecationWarning))
+            self.assertIn("register_otel_exporter is deprecated", str(w[0].message))
+            self.assertIn("0.16.0", str(w[0].message))
+
+            from nemoguardrails.tracing.adapters.opentelemetry import (
+                _exporter_name_cls_map,
+            )
+
+            self.assertEqual(_exporter_name_cls_map["test-exporter"], mock_exporter_cls)