clue-python-sdk-core 0.0.1__py3-none-any.whl

clue_python_sdk_core/bootstrap.py

@@ -0,0 +1,166 @@
+from __future__ import annotations
+
+import os
+from dataclasses import dataclass
+from typing import Mapping
+from urllib.parse import urlsplit, urlunsplit
+
+from .resources import CluePythonResourceConfig, build_resource_attributes, serialize_resource_attributes
+
+
+@dataclass(frozen=True)
+class CluePythonBootstrapConfig:
+	service_name: str
+	project_key: str
+	environment: str
+	deployment_environment: str
+	service_type: str
+	traces_endpoint: str
+	producer_id: str = "python-service"
+	api_key: str | None = None
+	service_version: str | None = None
+	service_namespace: str | None = None
+
+
+def load_bootstrap_config(
+	environ: Mapping[str, str] | None = None,
+) -> CluePythonBootstrapConfig:
+	env = environ or os.environ
+	return CluePythonBootstrapConfig(
+		service_name=env.get(
+			"OTEL_SERVICE_NAME",
+			env.get("CLUE_SERVICE_NAME", "python-service"),
+		),
+		producer_id=env.get(
+			"CLUE_PRODUCER_ID",
+			env.get("OTEL_SERVICE_NAME", env.get("CLUE_SERVICE_NAME", "python-service")),
+		),
+		project_key=env.get("CLUE_PROJECT_KEY", ""),
+		environment=env.get("CLUE_ENVIRONMENT", env.get("ENVIRONMENT", "")),
+		deployment_environment=env.get(
+			"OTEL_DEPLOYMENT_ENVIRONMENT",
+			env.get("DEPLOYMENT_ENVIRONMENT", env.get("ENVIRONMENT", "")),
+		),
+		service_type=env.get("CLUE_SERVICE_TYPE", "api"),
+		traces_endpoint=env.get(
+			"OTEL_EXPORTER_OTLP_TRACES_ENDPOINT",
+			env.get("CLUE_OTLP_TRACES_ENDPOINT", ""),
+		),
+		api_key=env.get("CLUE_API_KEY"),
+		service_version=env.get("OTEL_SERVICE_VERSION", env.get("CLUE_SERVICE_VERSION")),
+		service_namespace=env.get(
+			"OTEL_SERVICE_NAMESPACE",
+			env.get("CLUE_SERVICE_NAMESPACE"),
+		),
+	)
+
+
+def build_otel_environment(
+	config: CluePythonBootstrapConfig,
+) -> dict[str, str]:
+	resource_attributes = build_resource_attributes(
+		CluePythonResourceConfig(
+			service_name=config.service_name,
+			producer_id=config.producer_id,
+			project_key=config.project_key,
+			environment=config.environment,
+			deployment_environment=config.deployment_environment,
+			service_type=config.service_type,
+			service_version=config.service_version,
+			service_namespace=config.service_namespace,
+		)
+	)
+	env = {
+		"OTEL_SERVICE_NAME": config.service_name,
+		"OTEL_EXPORTER_OTLP_TRACES_ENDPOINT": config.traces_endpoint,
+		"OTEL_RESOURCE_ATTRIBUTES": serialize_resource_attributes(resource_attributes),
+	}
+
+	if config.api_key:
+		env["OTEL_EXPORTER_OTLP_TRACES_HEADERS"] = f"x-clue-api-key={config.api_key}"
+
+	return env
+
+
+def default_traces_endpoint_from_ingest_endpoint(ingest_endpoint: str) -> str:
+	trimmed = ingest_endpoint.strip()
+	if not trimmed:
+		return ""
+
+	parsed = urlsplit(trimmed)
+	if not parsed.scheme or not parsed.netloc:
+		return ""
+
+	path = parsed.path.rstrip("/")
+	if path.endswith("/ingest/backend"):
+		traces_path = path
+	elif path.endswith("/api/v1") or path.endswith("/v1"):
+		traces_path = f"{path}/ingest/backend"
+	else:
+		traces_path = f"{path}/api/v1/ingest/backend"
+
+	return urlunsplit(
+		(
+			parsed.scheme,
+			parsed.netloc,
+			traces_path,
+			"",
+			"",
+		)
+	)
+
+
+def configure_opentelemetry_environment(
+	config: CluePythonBootstrapConfig,
+	target: dict[str, str] | None = None,
+) -> dict[str, str]:
+	env = target if target is not None else os.environ
+	for key, value in build_otel_environment(config).items():
+		env[key] = value
+	return env
+
+
+def initialize_opentelemetry(config: CluePythonBootstrapConfig) -> bool:
+	configure_opentelemetry_environment(config)
+	if not config.traces_endpoint.strip():
+		return False
+
+	try:
+		from opentelemetry import trace
+		from opentelemetry.exporter.otlp.proto.http.trace_exporter import OTLPSpanExporter
+		from opentelemetry.sdk.resources import Resource
+		from opentelemetry.sdk.trace import TracerProvider
+		from opentelemetry.sdk.trace.export import BatchSpanProcessor
+	except ImportError:
+		return False
+
+	try:
+		resource_attributes = build_resource_attributes(
+			CluePythonResourceConfig(
+				service_name=config.service_name,
+				producer_id=config.producer_id,
+				project_key=config.project_key,
+				environment=config.environment,
+				deployment_environment=config.deployment_environment,
+				service_type=config.service_type,
+				service_version=config.service_version,
+				service_namespace=config.service_namespace,
+			)
+		)
+		headers = {"x-clue-api-key": config.api_key} if config.api_key else None
+		provider = TracerProvider(
+			resource=Resource.create(resource_attributes),
+		)
+		provider.add_span_processor(
+			BatchSpanProcessor(
+				OTLPSpanExporter(
+					endpoint=config.traces_endpoint,
+					headers=headers,
+				)
+			)
+		)
+		trace.set_tracer_provider(provider)
+	except Exception:
+		return False
+
+	return True