Merge pull request #41 from godon-dev/otel_instrumenation_logging

Add shared OTel logging helper for instrumented scripts

Author: cherusk

shared/component.yaml

@@ -0,0 +1,10 @@
+name: shared
+target: controller/shared
+workspace: godon
+
+scripts:
+  - pattern: "*.py"
+    settings:
+      summary: "Shared utilities for godon-controller"
+      description: "Common modules including OTel logging, helpers"
+      tag: "default"

shared/otel_logging.py

@@ -0,0 +1,70 @@
+#requirements:
+#opentelemetry-api
+#opentelemetry-sdk
+#opentelemetry-exporter-otlp
+
+import os
+import logging
+from opentelemetry import trace
+from opentelemetry.exporter.otlp.proto.http.trace_exporter import OTLPSpanExporter
+from opentelemetry.exporter.otlp.proto.http._log_exporter import OTLPLogExporter
+from opentelemetry.sdk.trace import TracerProvider
+from opentelemetry.sdk.trace.export import BatchSpanProcessor
+from opentelemetry.sdk._logs import LoggerProvider, LoggingHandler
+from opentelemetry.sdk._logs.export import BatchLogRecordProcessor
+from opentelemetry.sdk.resources import Resource
+
+OTEL_ENDPOINT = os.environ.get(
+    "OTEL_EXPORTER_OTLP_ENDPOINT",
+    "http://godon-observability-opentelemetry-collector.godon-observability.svc.cluster.local:4318"
+)
+
+_service_name = os.environ.get("OTEL_SERVICE_NAME", "godon-controller")
+_tracer = None
+_logger_provider = None
+_initialized = False
+
+
+def init_telemetry(service_name: str = None):
+    global _tracer, _logger_provider, _initialized, _service_name
+    
+    if _initialized:
+        return _tracer, _logger_provider
+    
+    if service_name:
+        _service_name = service_name
+    
+    resource = Resource.create({"service.name": _service_name})
+    
+    tracer_provider = TracerProvider(resource=resource)
+    tracer_provider.add_span_processor(
+        BatchSpanProcessor(OTLPSpanExporter(endpoint=f"{OTEL_ENDPOINT}/v1/traces"))
+    )
+    trace.set_tracer_provider(tracer_provider)
+    _tracer = trace.get_tracer(_service_name)
+    
+    _logger_provider = LoggerProvider(resource=resource)
+    _logger_provider.add_log_record_processor(
+        BatchLogRecordProcessor(OTLPLogExporter(endpoint=f"{OTEL_ENDPOINT}/v1/logs"))
+    )
+    
+    _initialized = True
+    return _tracer, _logger_provider
+
+
+def get_logger(name: str, service_name: str = None) -> logging.Logger:
+    init_telemetry(service_name)
+    
+    logger = logging.getLogger(name)
+    logger.setLevel(logging.DEBUG)
+    
+    if not any(isinstance(h, LoggingHandler) for h in logger.handlers):
+        handler = LoggingHandler(logger_provider=_logger_provider)
+        logger.addHandler(handler)
+    
+    return logger
+
+
+def get_tracer(service_name: str = None):
+    init_telemetry(service_name)
+    return _tracer