Skip to content

Commit a9fc9b8

Browse files
weyerttrentmpichlermarc
authored
refactor(otlp-exporter-base): use get*FromEnv() for otlp exporter config (#5583)
Signed-off-by: Weyert de Boer <wdb@innerfuse.biz> Co-authored-by: Trent Mick <trentm@gmail.com> Co-authored-by: Marc Pichler <marc.pichler@dynatrace.com>
1 parent 2d37608 commit a9fc9b8

File tree

3 files changed

+13
-13
lines changed

3 files changed

+13
-13
lines changed

experimental/CHANGELOG.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@ For notes on migrating to 2.x / 0.200.x see [the upgrade guide](doc/upgrade-to-2
1616

1717
### :house: Internal
1818

19+
* refactor(otlp-exporter-base): use get*FromEnv() for otlp exporter config. [#5583](https://github.com/open-telemetry/opentelemetry-js/issues/5583) @weyert
20+
1921
## 0.205.0
2022

2123
### :boom: Breaking Changes

experimental/packages/otlp-exporter-base/src/configuration/shared-env-configuration.ts

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -13,22 +13,23 @@
1313
* See the License for the specific language governing permissions and
1414
* limitations under the License.
1515
*/
16+
import { getNumberFromEnv, getStringFromEnv } from '@opentelemetry/core';
1617
import { OtlpSharedConfiguration } from './shared-configuration';
1718
import { diag } from '@opentelemetry/api';
1819

1920
function parseAndValidateTimeoutFromEnv(
2021
timeoutEnvVar: string
2122
): number | undefined {
22-
const envTimeout = process.env[timeoutEnvVar]?.trim();
23-
if (envTimeout != null && envTimeout !== '') {
24-
const definedTimeout = Number(envTimeout);
25-
if (Number.isFinite(definedTimeout) && definedTimeout > 0) {
26-
return definedTimeout;
23+
const envTimeout = getNumberFromEnv(timeoutEnvVar);
24+
if (envTimeout != null) {
25+
if (Number.isFinite(envTimeout) && envTimeout > 0) {
26+
return envTimeout;
2727
}
2828
diag.warn(
2929
`Configuration: ${timeoutEnvVar} is invalid, expected number greater than 0 (actual: ${envTimeout})`
3030
);
3131
}
32+
3233
return undefined;
3334
}
3435

@@ -46,10 +47,7 @@ function getTimeoutFromEnv(signalIdentifier: string) {
4647
function parseAndValidateCompressionFromEnv(
4748
compressionEnvVar: string
4849
): 'none' | 'gzip' | undefined {
49-
const compression = process.env[compressionEnvVar]?.trim();
50-
if (compression === '') {
51-
return undefined;
52-
}
50+
const compression = getStringFromEnv(compressionEnvVar)?.trim();
5351

5452
if (compression == null || compression === 'none' || compression === 'gzip') {
5553
return compression;

experimental/packages/otlp-exporter-base/test/node/configuration/shared-env-configuration.test.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -78,25 +78,25 @@ export function testSharedConfigurationFromEnvironment(
7878
sinon.assert.calledTwice(spyLoggerWarn);
7979
sinon.assert.calledWithExactly(
8080
spyLoggerWarn,
81-
'Configuration: OTEL_EXPORTER_OTLP_METRICS_TIMEOUT is invalid, expected number greater than 0 (actual: NaN)'
81+
`Unknown value 'NaN' for OTEL_EXPORTER_OTLP_METRICS_TIMEOUT, expected a number, using defaults`
8282
);
8383
sinon.assert.calledWithExactly(
8484
spyLoggerWarn,
85-
'Configuration: OTEL_EXPORTER_OTLP_TIMEOUT is invalid, expected number greater than 0 (actual: foo)'
85+
`Unknown value 'foo' for OTEL_EXPORTER_OTLP_TIMEOUT, expected a number, using defaults`
8686
);
8787
assert.strictEqual(config.timeoutMillis, undefined);
8888
});
8989
it('should not define timeoutMillis when specific and non-specific timeout values are infinite', function () {
9090
const spyLoggerWarn = sinon.stub(diag, 'warn');
91-
process.env.OTEL_EXPORTER_OTLP_METRICS_TIMEOUT = '-Infinitiy';
91+
process.env.OTEL_EXPORTER_OTLP_METRICS_TIMEOUT = '-Infinity';
9292
process.env.OTEL_EXPORTER_OTLP_TIMEOUT = 'Infinity';
9393

9494
const config = sut('METRICS');
9595

9696
sinon.assert.calledTwice(spyLoggerWarn);
9797
sinon.assert.calledWithExactly(
9898
spyLoggerWarn,
99-
'Configuration: OTEL_EXPORTER_OTLP_METRICS_TIMEOUT is invalid, expected number greater than 0 (actual: -Infinitiy)'
99+
`Configuration: OTEL_EXPORTER_OTLP_TIMEOUT is invalid, expected number greater than 0 (actual: Infinity)`
100100
);
101101
sinon.assert.calledWithExactly(
102102
spyLoggerWarn,

0 commit comments

Comments
 (0)