Skip to content

This isn't a real PR, just some 5% baked OTel tracing attempts that I'm sharing #535

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
bmtcril wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

This isn't a real PR, just some 5% baked OTel tracing attempts that I'm sharing #535

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 18 additions & 6 deletions edx_django_utils/monitoring/internal/backends.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ class TelemetryBackend(ABC):
"""
Base class for telemetry sinks.
"""

@abstractmethod
def set_attribute(self, key, value):
"""
Expand Down Expand Up @@ -83,9 +84,12 @@ class NewRelicBackend(TelemetryBackend):

API reference: https://docs.newrelic.com/docs/apm/agents/python-agent/python-agent-api/guide-using-python-agent-api/
"""

def __init__(self):
if newrelic is None:
raise Exception("Could not load New Relic monitoring backend; package not present.")
raise Exception(
"Could not load New Relic monitoring backend; package not present."
)

def set_attribute(self, key, value):
# Sets attribute on the transaction, rather than the current
Expand Down Expand Up @@ -119,11 +123,16 @@ class OpenTelemetryBackend(TelemetryBackend):

API reference: https://opentelemetry-python.readthedocs.io/en/latest/
"""

# pylint: disable=import-outside-toplevel
def __init__(self):
# If import fails, the backend won't be used.
from opentelemetry import trace
from opentelemetry.sdk.trace import TracerProvider

trace.set_tracer_provider(TracerProvider())
self.otel_trace = trace
self.otel_tracer = self.otel_trace.get_tracer(__name__)

def set_attribute(self, key, value):
# Sets the value on the current span, not necessarily the root
Expand All @@ -134,8 +143,7 @@ def record_exception(self):
self.otel_trace.get_current_span().record_exception(sys.exc_info()[1])

def create_span(self, name):
# Currently, this is not implemented.
pass
return self.otel_tracer.start_span(name=name)

def tag_root_span_with_error(self, exception):
# Currently, this is not implemented for OTel
Expand All @@ -152,10 +160,12 @@ class DatadogBackend(TelemetryBackend):

API reference: https://ddtrace.readthedocs.io/en/stable/api.html
"""

# pylint: disable=import-outside-toplevel
def __init__(self):
# If import fails, the backend won't be used.
from ddtrace import tracer

self.dd_tracer = tracer

def set_attribute(self, key, value):
Expand Down Expand Up @@ -199,12 +209,12 @@ def configured_backends():
# having the broadest support). Unusable options are ignored. Configuration
# of the backends themselves is via environment variables and system config files
# rather than via Django settings.
backend_classes = getattr(settings, 'OPENEDX_TELEMETRY', None)
backend_classes = getattr(settings, "OPENEDX_TELEMETRY", None)
if isinstance(backend_classes, str):
# Prevent a certain kind of easy mistake.
raise Exception("OPENEDX_TELEMETRY must be a list, not a string.")
if backend_classes is None:
backend_classes = ['edx_django_utils.monitoring.NewRelicBackend']
backend_classes = ["edx_django_utils.monitoring.NewRelicBackend"]

backends = []
for backend_class in backend_classes:
Expand All @@ -218,7 +228,9 @@ def configured_backends():
f"{cls} is not a subclass of TelemetryBackend"
)
except BaseException as e:
log.warning(f"Could not load OPENEDX_TELEMETRY option {backend_class!r}: {e!r}")
log.warning(
f"Could not load OPENEDX_TELEMETRY option {backend_class!r}: {e!r}"
)

return backends

Expand Down
Loading