refactor(otlp-exporter-base): use get*FromEnv() for otlp exporter config #5583
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Migrated away from using `process.env` to use the `getStringFromEnv`-function Signed-off-by: Weyert de Boer <[email protected]>
…tFromEnv`-functions Signed-off-by: Weyert de Boer <[email protected]>
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #5583 +/- ##
==========================================
- Coverage 95.03% 95.02% -0.02%
==========================================
Files 310 310
Lines 7952 7952
Branches 1605 1605
==========================================
- Hits 7557 7556 -1
- Misses 395 396 +1
🚀 New features to boost your workflow:
|
weyert
changed the title
Signed-off-by: Weyert de Boer <[email protected]>
weyert
commented
Apr 6, 2025
...imental/packages/otlp-exporter-base/test/node/configuration/shared-env-configuration.test.ts
Show resolved
Hide resolved
maryliag
changed the title
trentm
requested changes
Apr 9, 2025
| if (Number.isFinite(definedTimeout) && definedTimeout > 0) { | ||
| return definedTimeout; | ||
| const envTimeout = getNumberFromEnv(timeoutEnvVar); | ||
| if (envTimeout) { |
There was a problem hiding this comment.
I believe this will accidentally not go through this if-statement if the envvar value is '0':
> process.env.FOO
'0'
> core.getNumberFromEnv('FOO')
0
> delete process.env.FOO
true
> process.env.FOO
undefined
> core.getNumberFromEnv('FOO')
undefined
The side-effect will be that OTEL_EXPORTER_OTLP_METRICS_TIMEOUT=0 will not result in the diag.warn(...) message.
Suggested change
| if (envTimeout) { | |
| if (envTimeout !== undefined) { |
Comment on lines
+50
to
53
| const compression = getStringFromEnv(compressionEnvVar)?.trim(); | ||
| if (compression === '') { | ||
| return undefined; | ||
| } |
There was a problem hiding this comment.
This can be simplified. getStringFromEnv will handle trimming and returning undefined if the envvar is an empty string.
Suggested change
| const compression = getStringFromEnv(compressionEnvVar)?.trim(); | |
| if (compression === '') { | |
| return undefined; | |
| } | |
| const compression = getStringFromEnv(compressionEnvVar); |
...imental/packages/otlp-exporter-base/test/node/configuration/shared-env-configuration.test.ts
Show resolved
Hide resolved
| @@ -96,7 +96,7 @@ export function testSharedConfigurationFromEnvironment( | |||
| sinon.assert.calledTwice(spyLoggerWarn); | |||
| sinon.assert.calledWithExactly( | |||
| spyLoggerWarn, | |||
| 'Configuration: OTEL_EXPORTER_OTLP_METRICS_TIMEOUT is invalid, expected number greater than 0 (actual: -Infinitiy)' | |||
| `Unknown value '-Infinitiy' for OTEL_EXPORTER_OTLP_METRICS_TIMEOUT, expected a number, using defaults` | |||
There was a problem hiding this comment.
I'm surprised at this one. I would expect getNumberFromEnv to pass on '-Infinity':
> process.env.FOO = '-Infinity'
'-Infinity'
> core.getNumberFromEnv('FOO')
-Infinity
Co-authored-by: Trent Mick <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Which problem is this PR solving?
Migrated away from using
process.envto use thegetStringFromEnv-functionFixes #5562
Short description of the changes
Replaced the usage of
process.envwith the built-in getEnv utility functionsType of change
How Has This Been Tested?
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration
Checklist: