Skip to content
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

Propose way to customize exporters. #4452

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

Conversation

DylanRussell
Copy link

One possible approach to customize OTLP exporters

@DylanRussell
Copy link
Author

DylanRussell commented Feb 27, 2025

This would let us inject a customizer into the code, that would initialize the OTLP exporters with a set of custom params, ex:

import inspect
from typing import Tuple

import google.auth
import grpc
from google.auth.transport import requests
from google.auth.transport.grpc import AuthMetadataPlugin
from google.auth.transport.requests import AuthorizedSession

from opentelemetry.exporter.otlp.customizer import (
    BaseOTLPExporters,
    OTLPExporterCustomizerBase,
)

class GoogleOTLPExporterCustomizer(OTLPExporterCustomizerBase):
    def __init__(self):
        credentials, _ = google.auth.default()
        request = requests.Request()
        auth_metadata_plugin = AuthMetadataPlugin(
            credentials=credentials, request=request
        )

        self.authed_session = AuthorizedSession(credentials)
        self.channel_creds = grpc.composite_channel_credentials(
            grpc.ssl_channel_credentials(),
            grpc.metadata_call_credentials(auth_metadata_plugin),
        )

    def customize_exporter(
        self, exporter_class: BaseOTLPExporters
    ) -> Tuple[str, str]:
        params = inspect.signature(exporter_class.__init__).parameters
        if "credentials" in params and isinstance(
            self.channel_creds, params["credentials"].annotation
        ):
            return exporter_class(credentials=self.channel_creds)
        if "session" in params and isinstance(
            self.authed_session, params["session"].annotation
        ):
            return exporter_class(session=self.authed_session)
        raise RuntimeError(
            "OTLP Exporter class {export_class.__name__} does not contain a parameter named `sesion` or `credentials`."
        )

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant