chore(otel-node): add env var parser #442
Merged
Conversation
This file contains 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
trentm
approved these changes
Nov 20, 2024
| @@ -64,6 +64,7 @@ | |||
| }, | |||
| "types": "types/index.d.ts", | |||
| "dependencies": { | |||
| "@opentelemetry/core": "1.27.0", | |||
There was a problem hiding this comment.
Perhaps a caret dep, like the others? Also, FWIW I notice that the ".../resources" dep below is ^1.26.0. I don't think that matters. It depends on the package-lock.
There was a problem hiding this comment.
I was hesitating but I'm going to add it
| * @property {number} OTEL_METRIC_EXPORT_TIMEOUT | ||
| * @property {boolean} ELASTIC_OTEL_METRICS_DISABLED | ||
| */ | ||
| const otelEnv = getEnv(); |
There was a problem hiding this comment.
FWIW, there was discussion about getting rid of this getEnv() facility. Not soon, though.
There was a problem hiding this comment.
Looking at the criteria of open-telemetry/opentelemetry-js#5172 getEnv is used in several packages so I thought it was safe. I'll add a note. Thanks for the heads up :)
There was a problem hiding this comment.
Yah, should be fine. Just noting. getEnv() might survive for a long while.
trentm
reviewed
Nov 20, 2024
| */ | ||
| export function getEnvVar(name: string): string | undefined; | ||
| export function getEnvVar<T extends "OTEL_TRACES_EXPORTER" | "OTEL_LOG_LEVEL" | "OTEL_SDK_DISABLED" | "OTEL_BSP_EXPORT_TIMEOUT" | "OTEL_BSP_MAX_EXPORT_BATCH_SIZE" | "OTEL_BSP_MAX_QUEUE_SIZE" | "OTEL_BSP_SCHEDULE_DELAY" | "OTEL_BLRP_EXPORT_TIMEOUT" | "OTEL_BLRP_MAX_EXPORT_BATCH_SIZE" | "OTEL_BLRP_MAX_QUEUE_SIZE" | "OTEL_BLRP_SCHEDULE_DELAY" | "OTEL_ATTRIBUTE_VALUE_LENGTH_LIMIT" | "OTEL_ATTRIBUTE_COUNT_LIMIT" | "OTEL_SPAN_ATTRIBUTE_VALUE_LENGTH_LIMIT" | "OTEL_SPAN_ATTRIBUTE_COUNT_LIMIT" | "OTEL_LOGRECORD_ATTRIBUTE_VALUE_LENGTH_LIMIT" | "OTEL_LOGRECORD_ATTRIBUTE_COUNT_LIMIT" | "OTEL_SPAN_EVENT_COUNT_LIMIT" | "OTEL_SPAN_LINK_COUNT_LIMIT" | "OTEL_SPAN_ATTRIBUTE_PER_EVENT_COUNT_LIMIT" | "OTEL_SPAN_ATTRIBUTE_PER_LINK_COUNT_LIMIT" | "OTEL_EXPORTER_OTLP_TIMEOUT" | "OTEL_EXPORTER_OTLP_TRACES_TIMEOUT" | "OTEL_EXPORTER_OTLP_METRICS_TIMEOUT" | "OTEL_EXPORTER_OTLP_LOGS_TIMEOUT" | "OTEL_EXPORTER_JAEGER_AGENT_PORT" | "OTEL_NO_PATCH_MODULES" | "OTEL_PROPAGATORS" | "OTEL_SEMCONV_STABILITY_OPT_IN" | "CONTAINER_NAME" | "ECS_CONTAINER_METADATA_URI_V4" | "ECS_CONTAINER_METADATA_URI" | "HOSTNAME" | "KUBERNETES_SERVICE_HOST" | "NAMESPACE" | "OTEL_EXPORTER_JAEGER_AGENT_HOST" | "OTEL_EXPORTER_JAEGER_ENDPOINT" | "OTEL_EXPORTER_JAEGER_PASSWORD" | "OTEL_EXPORTER_JAEGER_USER" | "OTEL_EXPORTER_OTLP_ENDPOINT" | "OTEL_EXPORTER_OTLP_TRACES_ENDPOINT" | "OTEL_EXPORTER_OTLP_METRICS_ENDPOINT" | "OTEL_EXPORTER_OTLP_LOGS_ENDPOINT" | "OTEL_EXPORTER_OTLP_HEADERS" | "OTEL_EXPORTER_OTLP_TRACES_HEADERS" | "OTEL_EXPORTER_OTLP_METRICS_HEADERS" | "OTEL_EXPORTER_OTLP_LOGS_HEADERS" | "OTEL_EXPORTER_ZIPKIN_ENDPOINT" | "OTEL_RESOURCE_ATTRIBUTES" | "OTEL_SERVICE_NAME" | "OTEL_TRACES_SAMPLER_ARG" | "OTEL_TRACES_SAMPLER" | "OTEL_LOGS_EXPORTER" | "OTEL_EXPORTER_OTLP_INSECURE" | "OTEL_EXPORTER_OTLP_TRACES_INSECURE" | "OTEL_EXPORTER_OTLP_METRICS_INSECURE" | "OTEL_EXPORTER_OTLP_LOGS_INSECURE" | "OTEL_EXPORTER_OTLP_CERTIFICATE" | "OTEL_EXPORTER_OTLP_TRACES_CERTIFICATE" | "OTEL_EXPORTER_OTLP_METRICS_CERTIFICATE" | "OTEL_EXPORTER_OTLP_LOGS_CERTIFICATE" | "OTEL_EXPORTER_OTLP_COMPRESSION" | "OTEL_EXPORTER_OTLP_TRACES_COMPRESSION" | "OTEL_EXPORTER_OTLP_METRICS_COMPRESSION" | "OTEL_EXPORTER_OTLP_LOGS_COMPRESSION" | "OTEL_EXPORTER_OTLP_CLIENT_KEY" | "OTEL_EXPORTER_OTLP_TRACES_CLIENT_KEY" | "OTEL_EXPORTER_OTLP_METRICS_CLIENT_KEY" | "OTEL_EXPORTER_OTLP_LOGS_CLIENT_KEY" | "OTEL_EXPORTER_OTLP_CLIENT_CERTIFICATE" | "OTEL_EXPORTER_OTLP_TRACES_CLIENT_CERTIFICATE" | "OTEL_EXPORTER_OTLP_METRICS_CLIENT_CERTIFICATE" | "OTEL_EXPORTER_OTLP_LOGS_CLIENT_CERTIFICATE" | "OTEL_EXPORTER_OTLP_PROTOCOL" | "OTEL_EXPORTER_OTLP_TRACES_PROTOCOL" | "OTEL_EXPORTER_OTLP_METRICS_PROTOCOL" | "OTEL_EXPORTER_OTLP_LOGS_PROTOCOL" | "OTEL_EXPORTER_OTLP_METRICS_TEMPORALITY_PREFERENCE" | keyof EdotEnv>(name: T): T extends "OTEL_TRACES_EXPORTER" | "OTEL_LOG_LEVEL" | "OTEL_SDK_DISABLED" | "OTEL_BSP_EXPORT_TIMEOUT" | "OTEL_BSP_MAX_EXPORT_BATCH_SIZE" | "OTEL_BSP_MAX_QUEUE_SIZE" | "OTEL_BSP_SCHEDULE_DELAY" | "OTEL_BLRP_EXPORT_TIMEOUT" | "OTEL_BLRP_MAX_EXPORT_BATCH_SIZE" | "OTEL_BLRP_MAX_QUEUE_SIZE" | "OTEL_BLRP_SCHEDULE_DELAY" | "OTEL_ATTRIBUTE_VALUE_LENGTH_LIMIT" | "OTEL_ATTRIBUTE_COUNT_LIMIT" | "OTEL_SPAN_ATTRIBUTE_VALUE_LENGTH_LIMIT" | "OTEL_SPAN_ATTRIBUTE_COUNT_LIMIT" | "OTEL_LOGRECORD_ATTRIBUTE_VALUE_LENGTH_LIMIT" | "OTEL_LOGRECORD_ATTRIBUTE_COUNT_LIMIT" | "OTEL_SPAN_EVENT_COUNT_LIMIT" | "OTEL_SPAN_LINK_COUNT_LIMIT" | "OTEL_SPAN_ATTRIBUTE_PER_EVENT_COUNT_LIMIT" | "OTEL_SPAN_ATTRIBUTE_PER_LINK_COUNT_LIMIT" | "OTEL_EXPORTER_OTLP_TIMEOUT" | "OTEL_EXPORTER_OTLP_TRACES_TIMEOUT" | "OTEL_EXPORTER_OTLP_METRICS_TIMEOUT" | "OTEL_EXPORTER_OTLP_LOGS_TIMEOUT" | "OTEL_EXPORTER_JAEGER_AGENT_PORT" | "OTEL_NO_PATCH_MODULES" | "OTEL_PROPAGATORS" | "OTEL_SEMCONV_STABILITY_OPT_IN" | "CONTAINER_NAME" | "ECS_CONTAINER_METADATA_URI_V4" | "ECS_CONTAINER_METADATA_URI" | "HOSTNAME" | "KUBERNETES_SERVICE_HOST" | "NAMESPACE" | "OTEL_EXPORTER_JAEGER_AGENT_HOST" | "OTEL_EXPORTER_JAEGER_ENDPOINT" | "OTEL_EXPORTER_JAEGER_PASSWORD" | "OTEL_EXPORTER_JAEGER_USER" | "OTEL_EXPORTER_OTLP_ENDPOINT" | "OTEL_EXPORTER_OTLP_TRACES_ENDPOINT" | "OTEL_EXPORTER_OTLP_METRICS_ENDPOINT" | "OTEL_EXPORTER_OTLP_LOGS_ENDPOINT" | "OTEL_EXPORTER_OTLP_HEADERS" | "OTEL_EXPORTER_OTLP_TRACES_HEADERS" | "OTEL_EXPORTER_OTLP_METRICS_HEADERS" | "OTEL_EXPORTER_OTLP_LOGS_HEADERS" | "OTEL_EXPORTER_ZIPKIN_ENDPOINT" | "OTEL_RESOURCE_ATTRIBUTES" | "OTEL_SERVICE_NAME" | "OTEL_TRACES_SAMPLER_ARG" | "OTEL_TRACES_SAMPLER" | "OTEL_LOGS_EXPORTER" | "OTEL_EXPORTER_OTLP_INSECURE" | "OTEL_EXPORTER_OTLP_TRACES_INSECURE" | "OTEL_EXPORTER_OTLP_METRICS_INSECURE" | "OTEL_EXPORTER_OTLP_LOGS_INSECURE" | "OTEL_EXPORTER_OTLP_CERTIFICATE" | "OTEL_EXPORTER_OTLP_TRACES_CERTIFICATE" | "OTEL_EXPORTER_OTLP_METRICS_CERTIFICATE" | "OTEL_EXPORTER_OTLP_LOGS_CERTIFICATE" | "OTEL_EXPORTER_OTLP_COMPRESSION" | "OTEL_EXPORTER_OTLP_TRACES_COMPRESSION" | "OTEL_EXPORTER_OTLP_METRICS_COMPRESSION" | "OTEL_EXPORTER_OTLP_LOGS_COMPRESSION" | "OTEL_EXPORTER_OTLP_CLIENT_KEY" | "OTEL_EXPORTER_OTLP_TRACES_CLIENT_KEY" | "OTEL_EXPORTER_OTLP_METRICS_CLIENT_KEY" | "OTEL_EXPORTER_OTLP_LOGS_CLIENT_KEY" | "OTEL_EXPORTER_OTLP_CLIENT_CERTIFICATE" | "OTEL_EXPORTER_OTLP_TRACES_CLIENT_CERTIFICATE" | "OTEL_EXPORTER_OTLP_METRICS_CLIENT_CERTIFICATE" | "OTEL_EXPORTER_OTLP_LOGS_CLIENT_CERTIFICATE" | "OTEL_EXPORTER_OTLP_PROTOCOL" | "OTEL_EXPORTER_OTLP_TRACES_PROTOCOL" | "OTEL_EXPORTER_OTLP_METRICS_PROTOCOL" | "OTEL_EXPORTER_OTLP_LOGS_PROTOCOL" | "OTEL_EXPORTER_OTLP_METRICS_TEMPORALITY_PREFERENCE" ? import("@opentelemetry/core").ENVIRONMENT[T] : EdotEnv[T]; |
There was a problem hiding this comment.
This is big. Should that be concerning?
There was a problem hiding this comment.
TS is expanding the type keyof ENVIRONMENT. It shouldn't be a problem since this will be kept updated by running npm run gen:types. I'll check if there is a way to tell TS to make it shorter
There was a problem hiding this comment.
Did some type gymnastics to avoid the key expansion without luck. The way it could be fixed is to update TS, I've tried with latest v5.6.3 and it works. Maybe we should consider updating it (in a future PR).
Co-authored-by: Trent Mick <[email protected]>
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.
Upgrades the
getEnvVarfunction:It also removes the code meant to override the
user-agentheader of the exporters since is not possible anymore after the refactoring of exporters, with breaking changes, in several PRsFixes: #441