Skip to content

Genesis LLO Support in ADOT SDK #361

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.

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

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
110 changes: 55 additions & 55 deletions aws-opentelemetry-distro/pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -25,61 +25,61 @@ classifiers = [
]

dependencies = [
"opentelemetry-api == 1.27.0",
"opentelemetry-sdk == 1.27.0",
"opentelemetry-exporter-otlp-proto-grpc == 1.27.0",
"opentelemetry-exporter-otlp-proto-http == 1.27.0",
"opentelemetry-propagator-b3 == 1.27.0",
"opentelemetry-propagator-jaeger == 1.27.0",
"opentelemetry-exporter-otlp-proto-common == 1.27.0",
"opentelemetry-sdk-extension-aws == 2.0.2",
"opentelemetry-propagator-aws-xray == 1.0.1",
"opentelemetry-distro == 0.48b0",
"opentelemetry-propagator-ot-trace == 0.48b0",
"opentelemetry-instrumentation == 0.48b0",
"opentelemetry-instrumentation-aws-lambda == 0.48b0",
"opentelemetry-instrumentation-aio-pika == 0.48b0",
"opentelemetry-instrumentation-aiohttp-client == 0.48b0",
"opentelemetry-instrumentation-aiopg == 0.48b0",
"opentelemetry-instrumentation-asgi == 0.48b0",
"opentelemetry-instrumentation-asyncpg == 0.48b0",
"opentelemetry-instrumentation-boto == 0.48b0",
"opentelemetry-instrumentation-boto3sqs == 0.48b0",
"opentelemetry-instrumentation-botocore == 0.48b0",
"opentelemetry-instrumentation-celery == 0.48b0",
"opentelemetry-instrumentation-confluent-kafka == 0.48b0",
"opentelemetry-instrumentation-dbapi == 0.48b0",
"opentelemetry-instrumentation-django == 0.48b0",
"opentelemetry-instrumentation-elasticsearch == 0.48b0",
"opentelemetry-instrumentation-falcon == 0.48b0",
"opentelemetry-instrumentation-fastapi == 0.48b0",
"opentelemetry-instrumentation-flask == 0.48b0",
"opentelemetry-instrumentation-grpc == 0.48b0",
"opentelemetry-instrumentation-httpx == 0.48b0",
"opentelemetry-instrumentation-jinja2 == 0.48b0",
"opentelemetry-instrumentation-kafka-python == 0.48b0",
"opentelemetry-instrumentation-logging == 0.48b0",
"opentelemetry-instrumentation-mysql == 0.48b0",
"opentelemetry-instrumentation-mysqlclient == 0.48b0",
"opentelemetry-instrumentation-pika == 0.48b0",
"opentelemetry-instrumentation-psycopg2 == 0.48b0",
"opentelemetry-instrumentation-pymemcache == 0.48b0",
"opentelemetry-instrumentation-pymongo == 0.48b0",
"opentelemetry-instrumentation-pymysql == 0.48b0",
"opentelemetry-instrumentation-pyramid == 0.48b0",
"opentelemetry-instrumentation-redis == 0.48b0",
"opentelemetry-instrumentation-remoulade == 0.48b0",
"opentelemetry-instrumentation-requests == 0.48b0",
"opentelemetry-instrumentation-sqlalchemy == 0.48b0",
"opentelemetry-instrumentation-sqlite3 == 0.48b0",
"opentelemetry-instrumentation-starlette == 0.48b0",
"opentelemetry-instrumentation-system-metrics == 0.48b0",
"opentelemetry-instrumentation-tornado == 0.48b0",
"opentelemetry-instrumentation-tortoiseorm == 0.48b0",
"opentelemetry-instrumentation-urllib == 0.48b0",
"opentelemetry-instrumentation-urllib3 == 0.48b0",
"opentelemetry-instrumentation-wsgi == 0.48b0",
"opentelemetry-instrumentation-cassandra == 0.48b0",
"opentelemetry-api >= 1.29.0",
"opentelemetry-sdk >= 1.29.0",
"opentelemetry-exporter-otlp-proto-grpc >= 1.29.0",
"opentelemetry-exporter-otlp-proto-http >= 1.29.0",
"opentelemetry-propagator-b3 >= 1.29.0",
"opentelemetry-propagator-jaeger >= 1.29.0",
"opentelemetry-exporter-otlp-proto-common >= 1.29.0",
"opentelemetry-sdk-extension-aws >= 2.0.2",
"opentelemetry-propagator-aws-xray >= 1.0.1",
"opentelemetry-distro >= 0.50b0",
"opentelemetry-propagator-ot-trace >= 0.50b0",
"opentelemetry-instrumentation >= 0.50b0",
"opentelemetry-instrumentation-aws-lambda >= 0.50b0",
"opentelemetry-instrumentation-aio-pika >= 0.50b0",
"opentelemetry-instrumentation-aiohttp-client >= 0.50b0",
"opentelemetry-instrumentation-aiopg >= 0.50b0",
"opentelemetry-instrumentation-asgi >= 0.50b0",
"opentelemetry-instrumentation-asyncpg >= 0.50b0",
"opentelemetry-instrumentation-boto >= 0.50b0",
"opentelemetry-instrumentation-boto3sqs >= 0.50b0",
"opentelemetry-instrumentation-botocore >= 0.50b0",
"opentelemetry-instrumentation-celery >= 0.50b0",
"opentelemetry-instrumentation-confluent-kafka >= 0.50b0",
"opentelemetry-instrumentation-dbapi >= 0.50b0",
"opentelemetry-instrumentation-django >= 0.50b0",
"opentelemetry-instrumentation-elasticsearch >= 0.50b0",
"opentelemetry-instrumentation-falcon >= 0.50b0",
"opentelemetry-instrumentation-fastapi >= 0.50b0",
"opentelemetry-instrumentation-flask >= 0.50b0",
"opentelemetry-instrumentation-grpc >= 0.50b0",
"opentelemetry-instrumentation-httpx >= 0.50b0",
"opentelemetry-instrumentation-jinja2 >= 0.50b0",
"opentelemetry-instrumentation-kafka-python >= 0.50b0",
"opentelemetry-instrumentation-logging >= 0.50b0",
"opentelemetry-instrumentation-mysql >= 0.50b0",
"opentelemetry-instrumentation-mysqlclient >= 0.50b0",
"opentelemetry-instrumentation-pika >= 0.50b0",
"opentelemetry-instrumentation-psycopg2 >= 0.50b0",
"opentelemetry-instrumentation-pymemcache >= 0.50b0",
"opentelemetry-instrumentation-pymongo >= 0.50b0",
"opentelemetry-instrumentation-pymysql >= 0.50b0",
"opentelemetry-instrumentation-pyramid >= 0.50b0",
"opentelemetry-instrumentation-redis >= 0.50b0",
"opentelemetry-instrumentation-remoulade >= 0.50b0",
"opentelemetry-instrumentation-requests >= 0.50b0",
"opentelemetry-instrumentation-sqlalchemy >= 0.50b0",
"opentelemetry-instrumentation-sqlite3 >= 0.50b0",
"opentelemetry-instrumentation-starlette >= 0.50b0",
"opentelemetry-instrumentation-system-metrics >= 0.50b0",
"opentelemetry-instrumentation-tornado >= 0.50b0",
"opentelemetry-instrumentation-tortoiseorm >= 0.50b0",
"opentelemetry-instrumentation-urllib >= 0.50b0",
"opentelemetry-instrumentation-urllib3 >= 0.50b0",
"opentelemetry-instrumentation-wsgi >= 0.50b0",
"opentelemetry-instrumentation-cassandra >= 0.50b0",
]

[project.optional-dependencies]
Expand Down
Original file line number Diff line number Diff line change
@@ -1,13 +1,15 @@
# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
# SPDX-License-Identifier: Apache-2.0

import os
import sys
from logging import Logger, getLogger

import pkg_resources

_logger: Logger = getLogger(__name__)

AGENT_OBSERVABILITY_ENABLED = "AGENT_OBSERVABILITY_ENABLED"
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LLO handling is gated behind this configuration. If false, then the ADOT SDK will have default behavior in span and logs pipelines.


def is_installed(req: str) -> bool:
"""Is the given required package installed?"""
Expand All @@ -21,3 +23,6 @@ def is_installed(req: str) -> bool:
_logger.debug("Skipping instrumentation patch: package %s, exception: %s", req, exc)
return False
return True

def is_agent_observability_enabled() -> bool:
return os.environ.get(AGENT_OBSERVABILITY_ENABLED, "false").lower() == "true"
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
from typing_extensions import override

from amazon.opentelemetry.distro._aws_attribute_keys import AWS_LOCAL_SERVICE
from amazon.opentelemetry.distro._utils import is_agent_observability_enabled
from amazon.opentelemetry.distro._aws_resource_attribute_configurator import get_service_attribute
from amazon.opentelemetry.distro.always_record_sampler import AlwaysRecordSampler
from amazon.opentelemetry.distro.attribute_propagating_span_processor_builder import (
Expand All @@ -27,7 +28,7 @@
from amazon.opentelemetry.distro.sampler.aws_xray_remote_sampler import AwsXRayRemoteSampler
from amazon.opentelemetry.distro.scope_based_exporter import ScopeBasedPeriodicExportingMetricReader
from amazon.opentelemetry.distro.scope_based_filtering_view import ScopeBasedRetainingView
from opentelemetry._logs import set_logger_provider
from opentelemetry._logs import set_logger_provider, get_logger_provider
from opentelemetry.exporter.otlp.proto.http._log_exporter import OTLPLogExporter
from opentelemetry.exporter.otlp.proto.http.metric_exporter import OTLPMetricExporter as OTLPHttpOTLPMetricExporter
from opentelemetry.exporter.otlp.proto.http.trace_exporter import OTLPSpanExporter
Expand Down Expand Up @@ -91,6 +92,8 @@
OTEL_EXPORTER_OTLP_LOGS_ENDPOINT = "OTEL_EXPORTER_OTLP_LOGS_ENDPOINT"
OTEL_EXPORTER_OTLP_LOGS_HEADERS = "OTEL_EXPORTER_OTLP_LOGS_HEADERS"

AGENT_OBSERVABILITY_ENABLED = "AGENT_OBSERVABILITY_ENABLED"

AWS_TRACES_OTLP_ENDPOINT_PATTERN = r"https://xray\.([a-z0-9-]+)\.amazonaws\.com/v1/traces$"
AWS_LOGS_OTLP_ENDPOINT_PATTERN = r"https://logs\.([a-z0-9-]+)\.amazonaws\.com/v1/logs$"

Expand Down Expand Up @@ -160,16 +163,17 @@ def _initialize_components():
sampler_name = _get_sampler()
sampler = _custom_import_sampler(sampler_name, resource)

logging_enabled = os.getenv(_OTEL_PYTHON_LOGGING_AUTO_INSTRUMENTATION_ENABLED, "false")
if logging_enabled.strip().lower() == "true":
_init_logging(log_exporters, resource)

Comment on lines +166 to +169
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changed order of pipeline initialization so we can pass the global logger provider instance to the span pipeline if AGENT_OBSERVABILITY_ENABLED flag is enabled.

_init_tracing(
exporters=trace_exporters,
id_generator=id_generator,
sampler=sampler,
resource=resource,
)
_init_metrics(metric_exporters, resource)
logging_enabled = os.getenv(_OTEL_PYTHON_LOGGING_AUTO_INSTRUMENTATION_ENABLED, "false")
if logging_enabled.strip().lower() == "true":
_init_logging(log_exporters, resource)


def _init_logging(
Expand Down Expand Up @@ -359,7 +363,15 @@ def _customize_span_exporter(span_exporter: SpanExporter, resource: Resource) ->
_logger.info("Detected using AWS OTLP Traces Endpoint.")

if isinstance(span_exporter, OTLPSpanExporter):
span_exporter = OTLPAwsSpanExporter(endpoint=traces_endpoint)
if is_agent_observability_enabled():
logs_endpoint = os.getenv(OTEL_EXPORTER_OTLP_LOGS_ENDPOINT)
logs_exporter = OTLPAwsLogExporter(endpoint=logs_endpoint)
span_exporter = OTLPAwsSpanExporter(
endpoint=traces_endpoint,
logger_provider=get_logger_provider()
)
else:
span_exporter = OTLPAwsSpanExporter(endpoint=traces_endpoint)

else:
_logger.warning(
Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,18 @@
# Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
# SPDX-License-Identifier: Apache-2.0

from typing import Dict, Optional
from typing import Dict, Optional, Sequence

from amazon.opentelemetry.distro.exporter.otlp.aws.common.aws_auth_session import AwsAuthSession
from amazon.opentelemetry.distro.llo_handler import LLOHandler
from amazon.opentelemetry.distro._utils import is_agent_observability_enabled
from opentelemetry.sdk._logs import LoggerProvider
from opentelemetry.exporter.otlp.proto.http import Compression
from opentelemetry.exporter.otlp.proto.http.trace_exporter import OTLPSpanExporter
from opentelemetry.sdk.trace import ReadableSpan
from opentelemetry.sdk.trace.export import SpanExportResult

AGENT_OBSERVABILITY_ENABLED = "AGENT_OBSERVABILITY_ENABLED"


class OTLPAwsSpanExporter(OTLPSpanExporter):
Expand All @@ -18,9 +25,13 @@ def __init__(
headers: Optional[Dict[str, str]] = None,
timeout: Optional[int] = None,
compression: Optional[Compression] = None,
logger_provider: Optional[LoggerProvider] = None
):
self._aws_region = None

if logger_provider:
self._llo_handler = LLOHandler(logger_provider)

if endpoint:
self._aws_region = endpoint.split(".")[1]

Expand All @@ -35,3 +46,10 @@ def __init__(
compression,
session=AwsAuthSession(aws_region=self._aws_region, service="xray"),
)

def export(self, spans: Sequence[ReadableSpan]) -> SpanExportResult:
if is_agent_observability_enabled():
llo_processed_spans = self._llo_handler.process_spans(spans)
return super().export(llo_processed_spans)

return super().export(spans)
Loading