document the telemetry stack#452
Merged
Merged
Conversation
a guide covering the three pieces of pith's observability: std.metrics + std.prometheus for pull-based metrics, std.trace for spans and context propagation, and std.otlp/std.obs for OTLP push export. shows the zero-code OTEL_* path, the metrics the std http/grpc clients register on their own, how spans nest and cross a spawn, W3C traceparent propagation, and the OTEL_* environment variables. also lists what isn't there yet (OTLP/grpc transport, OTLP logs, sampling). links it from the readme's stdlib overview.
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
1 participant
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.
summary
adds
docs/telemetry.md, a guide to pith's observability stack, and links itfrom the readme's standard-library overview. the four modules landed in #448-#451
but had no prose tying them together; this is that page.
it covers:
OTEL_SERVICE_NAME+OTEL_EXPORTER_OTLP_ENDPOINT,call
obs.init(), and the std http/grpc clients produce traces and RED metricsstd.metricscounters/gauges/histograms with labels, and the metric names thestd clients register on their own
/metricsfor prometheus withstd.prometheusstd.trace: spans, ambient per-thread nesting, and the one explicit case —crossing a
spawntraceparentpropagation across services (client injection, thebegin/end_server_spanserver helpers)OTEL_*environment variables and the background OTLP/HTTP exporterfixed histogram buckets)
what was tested
docs-only plus the one-line readme link. verified every api and metric name in
the doc against the current source (
std/obs.pith,std/trace.pith,std/metrics.pith,std/prometheus.pith,std/otlp.pith, and the grpc/httpinstrumentation). no code changes.
design notes
matches the house doc voice: lowercase headings, runnable snippets, and a
closing limitations section like
docs/limitations.md. the module count in thereadme's layout section was already stale before this change and is left alone.