diff --git a/CHANGELOG.md b/CHANGELOG.md index 3aee06257a..c1560ab729 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -60,7 +60,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### Removed - Removed unused `get_hexadecimal_trace_id` and `get_hexadecimal_span_id` methods. - ([#1675])(https://github.com/open-telemetry/opentelemetry-python/pull/1675) + ([#1675](https://github.com/open-telemetry/opentelemetry-python/pull/1675)) +- Remove `OTEL_EXPORTER_*_ INSECURE` env var + ([#1682](https://github.com/open-telemetry/opentelemetry-python/pull/1682)) ## [0.18b0](https://github.com/open-telemetry/opentelemetry-python/releases/tag/v0.18b0) - 2021-02-16 diff --git a/exporter/opentelemetry-exporter-jaeger-proto/src/opentelemetry/exporter/jaeger/proto/util.py b/exporter/opentelemetry-exporter-jaeger-proto/src/opentelemetry/exporter/jaeger/proto/util.py index 4a72c1817c..4f943a0e4c 100644 --- a/exporter/opentelemetry-exporter-jaeger-proto/src/opentelemetry/exporter/jaeger/proto/util.py +++ b/exporter/opentelemetry-exporter-jaeger-proto/src/opentelemetry/exporter/jaeger/proto/util.py @@ -19,22 +19,10 @@ from opentelemetry.sdk.environment_variables import ( OTEL_EXPORTER_JAEGER_CERTIFICATE, - OTEL_EXPORTER_JAEGER_INSECURE, ) logger = logging.getLogger(__name__) -DEFAULT_INSECURE = False - - -def _get_insecure(param): - if param is not None: - return param - insecure_env = environ.get(OTEL_EXPORTER_JAEGER_INSECURE) - if insecure_env is not None: - return insecure_env.lower() == "true" - return DEFAULT_INSECURE - def _load_credential_from_file(path) -> ChannelCredentials: try: diff --git a/exporter/opentelemetry-exporter-otlp/src/opentelemetry/exporter/otlp/__init__.py b/exporter/opentelemetry-exporter-otlp/src/opentelemetry/exporter/otlp/__init__.py index d7de7a979a..705f14d7c2 100644 --- a/exporter/opentelemetry-exporter-otlp/src/opentelemetry/exporter/otlp/__init__.py +++ b/exporter/opentelemetry-exporter-otlp/src/opentelemetry/exporter/otlp/__init__.py @@ -26,14 +26,12 @@ - :envvar:`OTEL_EXPORTER_OTLP_TRACES_TIMEOUT` - :envvar:`OTEL_EXPORTER_OTLP_TRACES_PROTOCOL` -- :envvar:`OTEL_EXPORTER_OTLP_TRACES_INSECURE` - :envvar:`OTEL_EXPORTER_OTLP_TRACES_HEADERS` - :envvar:`OTEL_EXPORTER_OTLP_TRACES_ENDPOINT` - :envvar:`OTEL_EXPORTER_OTLP_TRACES_COMPRESSION` - :envvar:`OTEL_EXPORTER_OTLP_TRACES_CERTIFICATE` - :envvar:`OTEL_EXPORTER_OTLP_TIMEOUT` - :envvar:`OTEL_EXPORTER_OTLP_PROTOCOL` -- :envvar:`OTEL_EXPORTER_OTLP_INSECURE` - :envvar:`OTEL_EXPORTER_OTLP_HEADERS` - :envvar:`OTEL_EXPORTER_OTLP_ENDPOINT` - :envvar:`OTEL_EXPORTER_OTLP_COMPRESSION` diff --git a/exporter/opentelemetry-exporter-otlp/src/opentelemetry/exporter/otlp/exporter.py b/exporter/opentelemetry-exporter-otlp/src/opentelemetry/exporter/otlp/exporter.py index f5da0609f3..e3a42a24c5 100644 --- a/exporter/opentelemetry-exporter-otlp/src/opentelemetry/exporter/otlp/exporter.py +++ b/exporter/opentelemetry-exporter-otlp/src/opentelemetry/exporter/otlp/exporter.py @@ -42,7 +42,6 @@ OTEL_EXPORTER_OTLP_COMPRESSION, OTEL_EXPORTER_OTLP_ENDPOINT, OTEL_EXPORTER_OTLP_HEADERS, - OTEL_EXPORTER_OTLP_INSECURE, OTEL_EXPORTER_OTLP_TIMEOUT, ) from opentelemetry.sdk.resources import Resource as SDKResource @@ -159,6 +158,15 @@ def _load_credential_from_file(filepath) -> ChannelCredentials: return None +def _get_credentials(creds, environ_key): + if creds is not None: + return creds + creds_env = environ.get(environ_key) + if creds_env: + return _load_credential_from_file(creds_env) + return ssl_channel_credentials() + + # pylint: disable=no-member class OTLPExporterMixin( ABC, Generic[SDKDataT, ExportServiceRequestT, ExportResultT] @@ -185,26 +193,17 @@ def __init__( ): super().__init__() - endpoint = ( - endpoint - or environ.get(OTEL_EXPORTER_OTLP_ENDPOINT) - or "localhost:4317" + endpoint = endpoint or environ.get( + OTEL_EXPORTER_OTLP_ENDPOINT, "localhost:4317" ) - if insecure is None: - insecure = environ.get(OTEL_EXPORTER_OTLP_INSECURE) - if insecure is None: - insecure = False - self._headers = headers or environ.get(OTEL_EXPORTER_OTLP_HEADERS) if isinstance(self._headers, str): self._headers = tuple( tuple(item.split("=")) for item in self._headers.split(",") ) - self._timeout = ( - timeout - or int(environ.get(OTEL_EXPORTER_OTLP_TIMEOUT, 0)) - or 10 # default: 10 seconds + self._timeout = timeout or int( + environ.get(OTEL_EXPORTER_OTLP_TIMEOUT, 10) ) self._collector_span_kwargs = None @@ -218,22 +217,13 @@ def __init__( self._client = self._stub( insecure_channel(endpoint, compression=compression) ) - return - - # secure mode - if ( - credentials is None - and environ.get(OTEL_EXPORTER_OTLP_CERTIFICATE) is None - ): - # use the default location chosen by gRPC runtime - credentials = ssl_channel_credentials() else: - credentials = credentials or _load_credential_from_file( - environ.get(OTEL_EXPORTER_OTLP_CERTIFICATE) + credentials = _get_credentials( + credentials, OTEL_EXPORTER_OTLP_CERTIFICATE + ) + self._client = self._stub( + secure_channel(endpoint, credentials, compression=compression) ) - self._client = self._stub( - secure_channel(endpoint, credentials, compression=compression) - ) @abstractmethod def _translate_data( diff --git a/exporter/opentelemetry-exporter-otlp/src/opentelemetry/exporter/otlp/trace_exporter/__init__.py b/exporter/opentelemetry-exporter-otlp/src/opentelemetry/exporter/otlp/trace_exporter/__init__.py index bbc43956cb..a8b3cc79b4 100644 --- a/exporter/opentelemetry-exporter-otlp/src/opentelemetry/exporter/otlp/trace_exporter/__init__.py +++ b/exporter/opentelemetry-exporter-otlp/src/opentelemetry/exporter/otlp/trace_exporter/__init__.py @@ -21,7 +21,7 @@ from opentelemetry.exporter.otlp.exporter import ( OTLPExporterMixin, - _load_credential_from_file, + _get_credentials, _translate_key_values, environ_to_compression, get_resource_data, @@ -44,7 +44,6 @@ OTEL_EXPORTER_OTLP_TRACES_COMPRESSION, OTEL_EXPORTER_OTLP_TRACES_ENDPOINT, OTEL_EXPORTER_OTLP_TRACES_HEADERS, - OTEL_EXPORTER_OTLP_TRACES_INSECURE, OTEL_EXPORTER_OTLP_TRACES_TIMEOUT, ) from opentelemetry.sdk.trace import Span as ReadableSpan @@ -85,15 +84,12 @@ def __init__( timeout: Optional[int] = None, compression: Optional[Compression] = None, ): - if insecure is None: - insecure = environ.get(OTEL_EXPORTER_OTLP_TRACES_INSECURE) - if ( not insecure and environ.get(OTEL_EXPORTER_OTLP_TRACES_CERTIFICATE) is not None ): - credentials = credentials or _load_credential_from_file( - environ.get(OTEL_EXPORTER_OTLP_TRACES_CERTIFICATE) + credentials = _get_credentials( + credentials, OTEL_EXPORTER_OTLP_TRACES_CERTIFICATE ) environ_timeout = environ.get(OTEL_EXPORTER_OTLP_TRACES_TIMEOUT) diff --git a/opentelemetry-sdk/src/opentelemetry/sdk/environment_variables/__init__.py b/opentelemetry-sdk/src/opentelemetry/sdk/environment_variables/__init__.py index 6ff1dee222..c3329caf76 100644 --- a/opentelemetry-sdk/src/opentelemetry/sdk/environment_variables/__init__.py +++ b/opentelemetry-sdk/src/opentelemetry/sdk/environment_variables/__init__.py @@ -199,11 +199,6 @@ .. envvar:: OTEL_EXPORTER_OTLP_TRACES_TIMEOUT """ -OTEL_EXPORTER_JAEGER_INSECURE = "OTEL_EXPORTER_JAEGER_INSECURE" -""" -.. envvar:: OTEL_EXPORTER_JAEGER_INSECURE -""" - OTEL_EXPORTER_JAEGER_CERTIFICATE = "OTEL_EXPORTER_JAEGER_CERTIFICATE" """ .. envvar:: OTEL_EXPORTER_JAEGER_CERTIFICATE @@ -215,13 +210,3 @@ """ .. envvar:: OTEL_EXPORTER_JAEGER_AGENT_SPLIT_OVERSIZED_BATCHES """ - -OTEL_EXPORTER_OTLP_INSECURE = "OTEL_EXPORTER_OTLP_INSECURE" -""" -.. envvar:: OTEL_EXPORTER_OTLP_INSECURE -""" - -OTEL_EXPORTER_OTLP_TRACES_INSECURE = "OTEL_EXPORTER_OTLP_TRACES_INSECURE" -""" -.. envvar:: OTEL_EXPORTER_OTLP_TRACES_INSECURE -"""