refactor: reduce and simplify usage of getEnv() (#4799)

* refactor: reduce and simplify usage of getEnv() * docs: update CHANGELOG * fixup! docs: update CHANGELOG --------- Co-authored-by: Marc Pichler <marc.pichler@dynatrace.com>
open-telemetry · Jun 25, 2024 · 3fdadd5 · 3fdadd5
1 parent 73fad98
commit 3fdadd5
Show file tree

Hide file tree

Showing 13 changed files with 217 additions and 128 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -18,6 +18,8 @@ For experimental package changes, see the [experimental CHANGELOG](experimental/
 
 ### :house: (Internal)
 
+* refactor: Simplify the code for the `getEnv` function [#4799](https://github.com/open-telemetry/opentelemetry-js/pull/4799) @danstarns
+
 ## 1.25.1
 
 ### :books: (Refine Doc)

diff --git a/experimental/CHANGELOG.md b/experimental/CHANGELOG.md
@@ -15,6 +15,8 @@ All notable changes to experimental packages in this project will be documented
 
 ### :house: (Internal)
 
+* refactor: Simplify the code for the `getEnv` function [#4799](https://github.com/open-telemetry/opentelemetry-js/pull/4799) @danstarns
+
 ## 0.52.1
 
 ### :rocket: (Enhancement)

diff --git a/experimental/packages/exporter-logs-otlp-http/src/platform/config.ts b/experimental/packages/exporter-logs-otlp-http/src/platform/config.ts
@@ -30,14 +30,21 @@ export const DEFAULT_COLLECTOR_URL = `http://localhost:4318/${DEFAULT_COLLECTOR_
  * @returns url string
  */
 export function getDefaultUrl(config: OTLPExporterConfigBase): string {
- return typeof config.url === 'string'
- ? config.url
- : getEnv().OTEL_EXPORTER_OTLP_LOGS_ENDPOINT.length > 0
- ? appendRootPathToUrlIfNeeded(getEnv().OTEL_EXPORTER_OTLP_LOGS_ENDPOINT)
- : getEnv().OTEL_EXPORTER_OTLP_ENDPOINT.length > 0
- ? appendResourcePathToUrl(
- getEnv().OTEL_EXPORTER_OTLP_ENDPOINT,
- DEFAULT_COLLECTOR_RESOURCE_PATH
- )
- : DEFAULT_COLLECTOR_URL;
+ if (typeof config.url === 'string') {
+ return config.url;
+ }
+
+ const env = getEnv();
+ if (env.OTEL_EXPORTER_OTLP_LOGS_ENDPOINT.length > 0) {
+ return appendRootPathToUrlIfNeeded(env.OTEL_EXPORTER_OTLP_LOGS_ENDPOINT);
+ }
+
+ if (env.OTEL_EXPORTER_OTLP_ENDPOINT.length > 0) {
+ return appendResourcePathToUrl(
+ env.OTEL_EXPORTER_OTLP_ENDPOINT,
+ DEFAULT_COLLECTOR_RESOURCE_PATH
+ );
+ }
+
+ return DEFAULT_COLLECTOR_URL;
 }
diff --git a/experimental/packages/exporter-logs-otlp-proto/src/platform/browser/OTLPLogExporter.ts b/experimental/packages/exporter-logs-otlp-proto/src/platform/browser/OTLPLogExporter.ts
@@ -40,24 +40,30 @@ export class OTLPLogExporter
 {
  constructor(config: OTLPExporterConfigBase = {}) {
  super(config, ProtobufLogsSerializer, 'application/x-protobuf');
+ const env = getEnv();
  this._headers = Object.assign(
  this._headers,
- baggageUtils.parseKeyPairsIntoRecord(
- getEnv().OTEL_EXPORTER_OTLP_LOGS_HEADERS
- )
+ baggageUtils.parseKeyPairsIntoRecord(env.OTEL_EXPORTER_OTLP_LOGS_HEADERS)
  );
  }
 
  getDefaultUrl(config: OTLPExporterConfigBase): string {
- return typeof config.url === 'string'
- ? config.url
- : getEnv().OTEL_EXPORTER_OTLP_LOGS_ENDPOINT.length > 0
- ? appendRootPathToUrlIfNeeded(getEnv().OTEL_EXPORTER_OTLP_LOGS_ENDPOINT)
- : getEnv().OTEL_EXPORTER_OTLP_ENDPOINT.length > 0
- ? appendResourcePathToUrl(
- getEnv().OTEL_EXPORTER_OTLP_ENDPOINT,
- DEFAULT_COLLECTOR_RESOURCE_PATH
- )
- : DEFAULT_COLLECTOR_URL;
+ if (typeof config.url === 'string') {
+ return config.url;
+ }
+
+ const env = getEnv();
+ if (env.OTEL_EXPORTER_OTLP_LOGS_ENDPOINT.length > 0) {
+ return appendRootPathToUrlIfNeeded(env.OTEL_EXPORTER_OTLP_LOGS_ENDPOINT);
+ }
+
+ if (env.OTEL_EXPORTER_OTLP_ENDPOINT.length > 0) {
+ return appendResourcePathToUrl(
+ env.OTEL_EXPORTER_OTLP_ENDPOINT,
+ DEFAULT_COLLECTOR_RESOURCE_PATH
+ );
+ }
+
+ return DEFAULT_COLLECTOR_URL;
  }
 }
diff --git a/experimental/packages/exporter-logs-otlp-proto/src/platform/node/OTLPLogExporter.ts b/experimental/packages/exporter-logs-otlp-proto/src/platform/node/OTLPLogExporter.ts
@@ -46,26 +46,34 @@ export class OTLPLogExporter
 {
  constructor(config: OTLPExporterConfigBase = {}) {
  super(config, ProtobufLogsSerializer, 'application/x-protobuf');
+ const env = getEnv();
  this.headers = {
  ...this.headers,
  ...USER_AGENT,
  ...baggageUtils.parseKeyPairsIntoRecord(
- getEnv().OTEL_EXPORTER_OTLP_LOGS_HEADERS
+ env.OTEL_EXPORTER_OTLP_LOGS_HEADERS
  ),
  ...parseHeaders(config?.headers),
  };
  }
 
  getDefaultUrl(config: OTLPExporterConfigBase): string {
- return typeof config.url === 'string'
- ? config.url
- : getEnv().OTEL_EXPORTER_OTLP_LOGS_ENDPOINT.length > 0
- ? appendRootPathToUrlIfNeeded(getEnv().OTEL_EXPORTER_OTLP_LOGS_ENDPOINT)
- : getEnv().OTEL_EXPORTER_OTLP_ENDPOINT.length > 0
- ? appendResourcePathToUrl(
- getEnv().OTEL_EXPORTER_OTLP_ENDPOINT,
- DEFAULT_COLLECTOR_RESOURCE_PATH
- )
- : DEFAULT_COLLECTOR_URL;
+ if (typeof config.url === 'string') {
+ return config.url;
+ }
+
+ const env = getEnv();
+ if (env.OTEL_EXPORTER_OTLP_LOGS_ENDPOINT.length > 0) {
+ return appendRootPathToUrlIfNeeded(env.OTEL_EXPORTER_OTLP_LOGS_ENDPOINT);
+ }
+
+ if (env.OTEL_EXPORTER_OTLP_ENDPOINT.length > 0) {
+ return appendResourcePathToUrl(
+ env.OTEL_EXPORTER_OTLP_ENDPOINT,
+ DEFAULT_COLLECTOR_RESOURCE_PATH
+ );
+ }
+
+ return DEFAULT_COLLECTOR_URL;
  }
 }
diff --git a/experimental/packages/exporter-trace-otlp-http/src/platform/browser/OTLPTraceExporter.ts b/experimental/packages/exporter-trace-otlp-http/src/platform/browser/OTLPTraceExporter.ts
@@ -39,24 +39,34 @@ export class OTLPTraceExporter
 {
  constructor(config: OTLPExporterConfigBase = {}) {
  super(config, JsonTraceSerializer, 'application/json');
+ const env = getEnv();
  this._headers = Object.assign(
  this._headers,
  baggageUtils.parseKeyPairsIntoRecord(
- getEnv().OTEL_EXPORTER_OTLP_TRACES_HEADERS
+ env.OTEL_EXPORTER_OTLP_TRACES_HEADERS
  )
  );
  }
 
  getDefaultUrl(config: OTLPExporterConfigBase): string {
- return typeof config.url === 'string'
- ? config.url
- : getEnv().OTEL_EXPORTER_OTLP_TRACES_ENDPOINT.length > 0
- ? appendRootPathToUrlIfNeeded(getEnv().OTEL_EXPORTER_OTLP_TRACES_ENDPOINT)
- : getEnv().OTEL_EXPORTER_OTLP_ENDPOINT.length > 0
- ? appendResourcePathToUrl(
- getEnv().OTEL_EXPORTER_OTLP_ENDPOINT,
- DEFAULT_COLLECTOR_RESOURCE_PATH
- )
- : DEFAULT_COLLECTOR_URL;
+ if (typeof config.url === 'string') {
+ return config.url;
+ }
+
+ const env = getEnv();
+ if (env.OTEL_EXPORTER_OTLP_TRACES_ENDPOINT.length > 0) {
+ return appendRootPathToUrlIfNeeded(
+ env.OTEL_EXPORTER_OTLP_TRACES_ENDPOINT
+ );
+ }
+
+ if (env.OTEL_EXPORTER_OTLP_ENDPOINT.length > 0) {
+ return appendResourcePathToUrl(
+ env.OTEL_EXPORTER_OTLP_ENDPOINT,
+ DEFAULT_COLLECTOR_RESOURCE_PATH
+ );
+ }
+
+ return DEFAULT_COLLECTOR_URL;
  }
 }
diff --git a/experimental/packages/exporter-trace-otlp-http/src/platform/node/OTLPTraceExporter.ts b/experimental/packages/exporter-trace-otlp-http/src/platform/node/OTLPTraceExporter.ts
@@ -44,26 +44,36 @@ export class OTLPTraceExporter
 {
  constructor(config: OTLPExporterNodeConfigBase = {}) {
  super(config, JsonTraceSerializer, 'application/json');
+ const env = getEnv();
  this.headers = {
  ...this.headers,
  ...USER_AGENT,
  ...baggageUtils.parseKeyPairsIntoRecord(
- getEnv().OTEL_EXPORTER_OTLP_TRACES_HEADERS
+ env.OTEL_EXPORTER_OTLP_TRACES_HEADERS
  ),
  ...parseHeaders(config?.headers),
  };
  }
 
  getDefaultUrl(config: OTLPExporterNodeConfigBase): string {
- return typeof config.url === 'string'
- ? config.url
- : getEnv().OTEL_EXPORTER_OTLP_TRACES_ENDPOINT.length > 0
- ? appendRootPathToUrlIfNeeded(getEnv().OTEL_EXPORTER_OTLP_TRACES_ENDPOINT)
- : getEnv().OTEL_EXPORTER_OTLP_ENDPOINT.length > 0
- ? appendResourcePathToUrl(
- getEnv().OTEL_EXPORTER_OTLP_ENDPOINT,
- DEFAULT_COLLECTOR_RESOURCE_PATH
- )
- : DEFAULT_COLLECTOR_URL;
+ if (typeof config.url === 'string') {
+ return config.url;
+ }
+
+ const env = getEnv();
+ if (env.OTEL_EXPORTER_OTLP_TRACES_ENDPOINT.length > 0) {
+ return appendRootPathToUrlIfNeeded(
+ env.OTEL_EXPORTER_OTLP_TRACES_ENDPOINT
+ );
+ }
+
+ if (env.OTEL_EXPORTER_OTLP_ENDPOINT.length > 0) {
+ return appendResourcePathToUrl(
+ env.OTEL_EXPORTER_OTLP_ENDPOINT,
+ DEFAULT_COLLECTOR_RESOURCE_PATH
+ );
+ }
+
+ return DEFAULT_COLLECTOR_URL;
  }
 }
diff --git a/experimental/packages/exporter-trace-otlp-proto/src/platform/browser/OTLPTraceExporter.ts b/experimental/packages/exporter-trace-otlp-proto/src/platform/browser/OTLPTraceExporter.ts
@@ -39,24 +39,34 @@ export class OTLPTraceExporter
 {
  constructor(config: OTLPExporterConfigBase = {}) {
  super(config, ProtobufTraceSerializer, 'application/x-protobuf');
+ const env = getEnv();
  this._headers = Object.assign(
  this._headers,
  baggageUtils.parseKeyPairsIntoRecord(
- getEnv().OTEL_EXPORTER_OTLP_TRACES_HEADERS
+ env.OTEL_EXPORTER_OTLP_TRACES_HEADERS
  )
  );
  }
 
  getDefaultUrl(config: OTLPExporterConfigBase): string {
- return typeof config.url === 'string'
- ? config.url
- : getEnv().OTEL_EXPORTER_OTLP_TRACES_ENDPOINT.length > 0
- ? appendRootPathToUrlIfNeeded(getEnv().OTEL_EXPORTER_OTLP_TRACES_ENDPOINT)
- : getEnv().OTEL_EXPORTER_OTLP_ENDPOINT.length > 0
- ? appendResourcePathToUrl(
- getEnv().OTEL_EXPORTER_OTLP_ENDPOINT,
- DEFAULT_COLLECTOR_RESOURCE_PATH
- )
- : DEFAULT_COLLECTOR_URL;
+ if (typeof config.url === 'string') {
+ return config.url;
+ }
+
+ const env = getEnv();
+ if (env.OTEL_EXPORTER_OTLP_TRACES_ENDPOINT.length > 0) {
+ return appendRootPathToUrlIfNeeded(
+ env.OTEL_EXPORTER_OTLP_TRACES_ENDPOINT
+ );
+ }
+
+ if (env.OTEL_EXPORTER_OTLP_ENDPOINT.length > 0) {
+ return appendResourcePathToUrl(
+ env.OTEL_EXPORTER_OTLP_ENDPOINT,
+ DEFAULT_COLLECTOR_RESOURCE_PATH
+ );
+ }
+
+ return DEFAULT_COLLECTOR_URL;
  }
 }
diff --git a/experimental/packages/exporter-trace-otlp-proto/src/platform/node/OTLPTraceExporter.ts b/experimental/packages/exporter-trace-otlp-proto/src/platform/node/OTLPTraceExporter.ts
@@ -44,26 +44,36 @@ export class OTLPTraceExporter
 {
  constructor(config: OTLPExporterNodeConfigBase = {}) {
  super(config, ProtobufTraceSerializer, 'application/x-protobuf');
+ const env = getEnv();
  this.headers = {
  ...this.headers,
  ...USER_AGENT,
  ...baggageUtils.parseKeyPairsIntoRecord(
- getEnv().OTEL_EXPORTER_OTLP_TRACES_HEADERS
+ env.OTEL_EXPORTER_OTLP_TRACES_HEADERS
  ),
  ...parseHeaders(config?.headers),
  };
  }
 
  getDefaultUrl(config: OTLPExporterNodeConfigBase) {
- return typeof config.url === 'string'
- ? config.url
- : getEnv().OTEL_EXPORTER_OTLP_TRACES_ENDPOINT.length > 0
- ? appendRootPathToUrlIfNeeded(getEnv().OTEL_EXPORTER_OTLP_TRACES_ENDPOINT)
- : getEnv().OTEL_EXPORTER_OTLP_ENDPOINT.length > 0
- ? appendResourcePathToUrl(
- getEnv().OTEL_EXPORTER_OTLP_ENDPOINT,
- DEFAULT_COLLECTOR_RESOURCE_PATH
- )
- : DEFAULT_COLLECTOR_URL;
+ if (typeof config.url === 'string') {
+ return config.url;
+ }
+
+ const env = getEnv();
+ if (env.OTEL_EXPORTER_OTLP_TRACES_ENDPOINT.length > 0) {
+ return appendRootPathToUrlIfNeeded(
+ env.OTEL_EXPORTER_OTLP_TRACES_ENDPOINT
+ );
+ }
+
+ if (env.OTEL_EXPORTER_OTLP_ENDPOINT.length > 0) {
+ return appendResourcePathToUrl(
+ env.OTEL_EXPORTER_OTLP_ENDPOINT,
+ DEFAULT_COLLECTOR_RESOURCE_PATH
+ );
+ }
+
+ return DEFAULT_COLLECTOR_URL;
  }
 }
diff --git a/...kages/opentelemetry-exporter-metrics-otlp-http/src/platform/browser/OTLPMetricExporter.ts b/...kages/opentelemetry-exporter-metrics-otlp-http/src/platform/browser/OTLPMetricExporter.ts
@@ -38,27 +38,35 @@ class OTLPExporterBrowserProxy extends OTLPExporterBrowserBase<
 > {
  constructor(config?: OTLPMetricExporterOptions & OTLPExporterConfigBase) {
  super(config, JsonMetricsSerializer, 'application/json');
+ const env = getEnv();
  this._headers = Object.assign(
  this._headers,
  baggageUtils.parseKeyPairsIntoRecord(
- getEnv().OTEL_EXPORTER_OTLP_METRICS_HEADERS
+ env.OTEL_EXPORTER_OTLP_METRICS_HEADERS
  )
  );
  }
 
  getDefaultUrl(config: OTLPExporterConfigBase): string {
- return typeof config.url === 'string'
- ? config.url
- : getEnv().OTEL_EXPORTER_OTLP_METRICS_ENDPOINT.length > 0
- ? appendRootPathToUrlIfNeeded(
- getEnv().OTEL_EXPORTER_OTLP_METRICS_ENDPOINT
- )
- : getEnv().OTEL_EXPORTER_OTLP_ENDPOINT.length > 0
- ? appendResourcePathToUrl(
- getEnv().OTEL_EXPORTER_OTLP_ENDPOINT,
- DEFAULT_COLLECTOR_RESOURCE_PATH
- )
- : DEFAULT_COLLECTOR_URL;
+ if (typeof config.url === 'string') {
+ return config.url;
+ }
+
+ const env = getEnv();
+ if (env.OTEL_EXPORTER_OTLP_METRICS_ENDPOINT.length > 0) {
+ return appendRootPathToUrlIfNeeded(
+ env.OTEL_EXPORTER_OTLP_METRICS_ENDPOINT
+ );
+ }
+
+ if (env.OTEL_EXPORTER_OTLP_ENDPOINT.length > 0) {
+ return appendResourcePathToUrl(
+ env.OTEL_EXPORTER_OTLP_ENDPOINT,
+ DEFAULT_COLLECTOR_RESOURCE_PATH
+ );
+ }
+
+ return DEFAULT_COLLECTOR_URL;
  }
 }