Document the entry points better

Author: DylanRussell

exporter/opentelemetry-exporter-otlp-proto-http/src/opentelemetry/exporter/otlp/proto/http/metric_exporter/__init__.py

@@ -77,11 +77,11 @@
     OTEL_EXPORTER_OTLP_METRICS_CLIENT_CERTIFICATE,
     OTEL_EXPORTER_OTLP_METRICS_CLIENT_KEY,
     OTEL_EXPORTER_OTLP_METRICS_COMPRESSION,
-    OTEL_PYTHON_EXPORTER_OTLP_METRICS_CREDENTIAL_PROVIDER
     OTEL_EXPORTER_OTLP_METRICS_ENDPOINT,
     OTEL_EXPORTER_OTLP_METRICS_HEADERS,
     OTEL_EXPORTER_OTLP_METRICS_TIMEOUT,
     OTEL_EXPORTER_OTLP_TIMEOUT,
+    OTEL_PYTHON_EXPORTER_OTLP_METRICS_CREDENTIAL_PROVIDER,
 )
 from opentelemetry.sdk.metrics._internal.aggregation import Aggregation
 from opentelemetry.sdk.metrics.export import (  # noqa: F401
@@ -163,7 +163,9 @@ def __init__(
         self._compression = compression or _compression_from_env()
         self._session = (
             session
-            or _load_session_from_envvar(OTEL_PYTHON_EXPORTER_OTLP_METRICS_CREDENTIAL_PROVIDER)
+            or _load_session_from_envvar(
+                OTEL_PYTHON_EXPORTER_OTLP_METRICS_CREDENTIAL_PROVIDER
+            )
             or requests.Session()
         )
         self._session.headers.update(self._headers)

opentelemetry-sdk/src/opentelemetry/sdk/environment_variables/__init__.py

@@ -400,35 +400,75 @@
 """
 .. envvar:: OTEL_PYTHON_EXPORTER_OTLP_LOGS_CREDENTIAL_PROVIDER
 
-The :envvar:`OTEL_PYTHON_EXPORTER_OTLP_LOGS_CREDENTIAL_PROVIDER` provides either `grpc.ChannelCredentials` for grpc OTLP Log exporters,
-or `request.Session` for HTTP Log exporters.
+The :envvar:`OTEL_PYTHON_EXPORTER_OTLP_LOGS_CREDENTIAL_PROVIDER` provides either `grpc.ChannelCredentials` for the grpc OTLP Log exporter,
+or `requests.Session` for the HTTP OTLP Log exporter. Entry point providers should implement the following functions:
+
+.. code-block:: python
+    import requests, grpc
+
+    # Add a reference to this function under the `opentelemetry_otlp_credential_provider` entry point.
+    def request_session_provder() -> requests.Session:
+
+    # Add a reference to this function under the `opentelemetry_otlp_credential_provider` entry point.
+    def channel_credential_provider() -> grpc.ChannelCredentials:
+
 """
 OTEL_PYTHON_EXPORTER_OTLP_CREDENTIAL_PROVIDER = (
     "OTEL_PYTHON_EXPORTER_OTLP_CREDENTIAL_PROVIDER"
 )
 """
 .. envvar:: OTEL_PYTHON_EXPORTER_OTLP_CREDENTIAL_PROVIDER
 
-The :envvar:`OTEL_PYTHON_EXPORTER_OTLP_CREDENTIAL_PROVIDER` provides either ChannelCredentials for all grpc OTLP exporters,
-or request.Session for HTTP exporters.
+The :envvar:`OTEL_PYTHON_EXPORTER_OTLP_CREDENTIAL_PROVIDER` provides either `grpc.ChannelCredentials` for all grpc OTLP exporters,
+or `requests.Session` for all HTTP OTLP exporters. Entry point providers should implement the following functions:
+
+.. code-block:: python
+    import requests, grpc
+
+    # Add a reference to this function under the `opentelemetry_otlp_credential_provider` entry point.
+    def request_session_provder() -> requests.Session:
+
+    # Add a reference to this function under the `opentelemetry_otlp_credential_provider` entry point.
+    def channel_credential_provider() -> grpc.ChannelCredentials:
+
 """
 OTEL_PYTHON_EXPORTER_OTLP_TRACES_CREDENTIAL_PROVIDER = (
     "OTEL_PYTHON_EXPORTER_OTLP_TRACES_CREDENTIAL_PROVIDER"
 )
 """
 .. envvar:: OTEL_PYTHON_EXPORTER_OTLP_TRACES_CREDENTIAL_PROVIDER
 
-The :envvar:`OTEL_PYTHON_EXPORTER_OTLP_TRACES_CREDENTIAL_PROVIDER` provides either ChannelCredentials for grpc OTLP Span exporters,
-or request.Session for HTTP Span exporters.
+The :envvar:`OTEL_PYTHON_EXPORTER_OTLP_TRACES_CREDENTIAL_PROVIDER` provides either `grpc.ChannelCredentials` for the grpc OTLP Span exporter,
+or `requests.Session` for the HTTP OTLP Span exporter. Entry point providers should implement the following functions:
+
+.. code-block:: python
+    import requests, grpc
+
+    # Add a reference to this function under the `opentelemetry_otlp_credential_provider` entry point.
+    def request_session_provder() -> requests.Session:
+
+    # Add a reference to this function under the `opentelemetry_otlp_credential_provider` entry point.
+    def channel_credential_provider() -> grpc.ChannelCredentials:
+
 """
 OTEL_PYTHON_EXPORTER_OTLP_METRICS_CREDENTIAL_PROVIDER = (
     "OTEL_PYTHON_EXPORTER_OTLP_METRICS_CREDENTIAL_PROVIDER"
 )
 """
 .. envvar:: OTEL_PYTHON_EXPORTER_OTLP_METRICS_CREDENTIAL_PROVIDER
 
-The :envvar:`OTEL_PYTHON_EXPORTER_OTLP_METRICS_CREDENTIAL_PROVIDER` provides either ChannelCredentials for grpc OTLP Metric exporters,
-or request.Session for HTTP Metric exporters.
+The :envvar:`OTEL_PYTHON_EXPORTER_OTLP_METRICS_CREDENTIAL_PROVIDER` provides either `grpc.ChannelCredentials` for the grpc OTLP Metric exporter,
+or `requests.Session` for the HTTP OTLP Log exporter. Entry point providers should implement the following functions:
+
+.. code-block:: python
+    import requests, grpc
+
+    # Add a reference to this function under the `opentelemetry_otlp_credential_provider` entry point.
+    def request_session_provder() -> requests.Session:
+
+    # Add a reference to this function under the `opentelemetry_otlp_credential_provider` entry point.
+    def channel_credential_provider() -> grpc.ChannelCredentials:
+
 """
 
 OTEL_EXPORTER_OTLP_TRACES_CERTIFICATE = "OTEL_EXPORTER_OTLP_TRACES_CERTIFICATE"