docs(observability): update example to signal-specific OTel env var names - #353
Open
AryanKansagara wants to merge 1 commit into
Open
AryanKansagara wants to merge 1 commit into
AryanKansagara wants to merge 1 commit into
Conversation
…ames The example README and docker-compose comment still referenced TANGLE_OTEL_EXPORTER_ENDPOINT and TANGLE_OTEL_EXPORTER_PROTOCOL, which were replaced in TangleML#125 by separate trace and metric variables. Following the example as written silently disables telemetry export. Also corrects the documented TANGLE_ENV default from development to unknown to match configuration.resolve(). Closes TangleML#352 Signed-off-by: Aryan Kansagara <aryankk07@gmail.com>
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
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.
Closes #352
What
Updates the example observability stack documentation to use the current OpenTelemetry environment variable names.
examples/observability/otel-jaeger-prometheus/README.md: the variable table, the shell example, the.envexample, and the closing sentence about when export is disabled now useTANGLE_OTEL_TRACE_EXPORTER_*andTANGLE_OTEL_METRIC_EXPORTER_*. Added one sentence noting that traces and metrics are configured independently. Corrected the documentedTANGLE_ENVdefault fromdevelopmenttounknown.examples/observability/otel-jaeger-prometheus/docker-compose.yml: the header comment now lists the four current variables.Why
#125 replaced the generic
TANGLE_OTEL_EXPORTER_ENDPOINTandTANGLE_OTEL_EXPORTER_PROTOCOLwith signal-specific variables and updated the code and tests, but the example directory was not updated. A user following the README gets no traces or metrics and no error, becauseconfiguration.resolve()returnsNonewhen neither of the current endpoint variables is set.Verification
Loading the config with the variables from the updated
.envblock:prints
http://localhost:4317 http://localhost:4317 tangle-unknown. The same command with the old variable names printsNone.git grep TANGLE_OTEL_EXPORTER_now returns no results.Documentation only, no code changes.