Skip to content

feat(opentelemetry-node): include OTEL_ and ELASTIC_OTEL_ envvars in preamble log.info#1151

Merged
trentm merged 3 commits intomainfrom
trentm-better-preamble-config
Nov 10, 2025
Merged

feat(opentelemetry-node): include OTEL_ and ELASTIC_OTEL_ envvars in preamble log.info#1151
trentm merged 3 commits intomainfrom
trentm-better-preamble-config

Conversation

@trentm
Copy link
Copy Markdown
Member

@trentm trentm commented Nov 7, 2025

This includes all likely to be relevant envvars in the preamble log
message to help with clarity and debugging. The value of envvars are
included if they are on the allowlist of known to not be sensitive
envvars. Otherwise the value is redacted.

(I think there would still be value to a string representation of the
SDK components. However that is larger work that could be done
separately.)

Closes: #1018

@trentm
feat(opentelemetry-node): include OTEL_ and ELASTIC_OTEL_ envvars in …
2ceb66c 
…preamble log.info

This includes all likely to be relevant envvars in the preamble log
message to help with clarity and debugging. The *value* of envvars are
included if they are on the allowlist of known to not be sensitive
envvars. Otherwise the value is redacted.

(I think there would still be value to a string representation of the
SDK components. However that is larger work that could be done
separately.)

Closes: #1018
@trentm trentm self-assigned this Nov 7, 2025
@trentm trentm requested a review from a team as a code owner November 7, 2025 20:31
@trentm
Copy link
Copy Markdown
Member Author

trentm commented Nov 7, 2025

Here is an example. I have a few o... aliases (e.g. oquiet and opamp) that I use for setting some convenience envvars to configure EDOT Node.js and OTel JS for local dev. Now the preamble conveniently shows the actual envvars that were set:

% ofast opamp  oquiet npm run example | pino-pretty

> @elastic/opentelemetry-node@1.6.0 example
> cd ../../examples && node --import @elastic/opentelemetry-node simple-http-request.js

[12:31:58.616] WARN (elastic-otel-node): Unsupported OTLP metrics protocol: "undefined". Using http/protobuf.
[12:31:58.620] INFO (elastic-otel-node): start EDOT Node.js
    preamble: true
    distroVersion: "1.6.0"
    system: {
      "os": "darwin 24.6.0",
      "arch": "arm64",
      "runtime": "Node.js v20.19.1"
    }
    edotEnv: {
      "OTEL_METRIC_EXPORT_TIMEOUT": "5000",
      "OTEL_NODE_DISABLED_INSTRUMENTATIONS": "dns,net,runtime-node",
      "ELASTIC_OTEL_HOST_METRICS_DISABLED": "true",
      "ELASTIC_OTEL_OPAMP_ENDPOINT": "http://localhost:4320",
      "OTEL_METRIC_EXPORT_INTERVAL": "5000",
      "OTEL_NODE_RESOURCE_DETECTORS": "env,host,os,process,serviceinstance",
      "ELASTIC_OTEL_EXPERIMENTAL_OPAMP_HEARTBEAT_INTERVAL": "5000"
    }
    configInfo: {
      "logLevel": "info"
    }
...

@trentm trentm requested a review from a team as a code owner November 7, 2025 20:35
@github-actions
Copy link
Copy Markdown

github-actions bot commented Nov 7, 2025

🔍 Preview links for changed docs

@trentm trentm merged commit 50120cd into main Nov 10, 2025
13 checks passed
@trentm trentm deleted the trentm-better-preamble-config branch November 10, 2025 16:36
@trentm trentm mentioned this pull request Nov 24, 2025
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@david-luna david-luna david-luna approved these changes

@theletterf theletterf theletterf approved these changes

Assignees

@trentm trentm

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

dump configuration on startup

3 participants

@trentm @david-luna @theletterf