docs(nimbus): add telemetry discovery, querying, and config walkthrough guides#819
Open
jaredlockhart wants to merge 4 commits intomainfrom
Open
docs(nimbus): add telemetry discovery, querying, and config walkthrough guides#819jaredlockhart wants to merge 4 commits intomainfrom
jaredlockhart wants to merge 4 commits intomainfrom
Conversation
…gh guides Because * Experiment owners need practical guidance on finding product telemetry in BigQuery but current docs only cover Nimbus lifecycle events * No query examples exist for Jetstream results tables or raw telemetry * The Jetstream configuration reference covers syntax but lacks real-world walkthroughs showing graduated examples This commit * Adds "Finding Telemetry in BigQuery" guide covering the pipeline from metrics.yaml to BQ tables, column naming, and a five-step discovery workflow * Adds "Querying Experiment Data in BigQuery" with SQL patterns for both Jetstream results tables and raw telemetry filtered by experiment * Adds "Configuration Walkthrough" with five graduated examples from minimal config to custom metrics, segments, and exposure signals * Adds cross-reference tip boxes to telemetry.md and data-products.md * Adds results table schema to data-products.md * Updates sidebar navigation with all three new docs Fixes #818
jaredlockhart
requested review from
freshstrangemusic,
mikewilli,
relud and
yashikakhurana
as code owners
…overy Because * "*(omitted)*" in the routing table looked like redacted sensitive data This commit * Changes wording to "Not specified (default)" for clarity
…isting doc Because * The new configuration-walkthrough.md largely duplicated content already in configuration.md This commit * Removes configuration-walkthrough.md and its sidebar entry * Adds common select_expression patterns (binary/count/sum) and a cross-link to the telemetry discovery guide to configuration.md
Because
* Troubleshooting docs listed error categories but not the specific
exception types users see in logs, making triage guesswork
* Monitoring table schemas in data-products.md were incomplete, missing
columns critical for debugging (experiment_slug, error_reason, metric)
* Overview docs did not explain which experiments Jetstream analyzes or
the 90-day cutoff, surprising experiment owners
* The enrollment_status event (a richer enrollment debugging signal) was
completely absent from telemetry docs
* experiments_column_type and enrollment_period resolution priority were
undocumented in the configuration reference
This commit
* Adds common exception types table to troubleshooting.md with meanings
and recommended actions
* Completes monitoring table schemas in data-products.md (logs, query_cost,
experimenter_experiments_v1)
* Adds experiment selection rules section to overview.md
* Adds enrollment_status event documentation with query example to
telemetry.md
* Documents experiments_column_type values ("native" vs "none") and
enrollment_period resolution priority in configuration.md
* Adds preenrollment period names to querying-experiment-data.md
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.
Because
in BigQuery but current docs only cover Nimbus lifecycle events
walkthroughs showing graduated examples
This commit
metrics.yaml to BQ tables, column naming formula, events routing, and a
five-step discovery workflow
Jetstream results tables and raw telemetry filtered by experiment enrollment
config, pre-defined metrics, custom metrics with data sources, segments,
and custom exposure signals
Fixes #818