Skip to content

Commit

Permalink
Improve docs for telemetry completeness tests (#3794)
Browse files Browse the repository at this point in the history
  • Loading branch information
bm1549 authored Jan 9, 2025
1 parent d030f08 commit 3d75933
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 1 deletion.
1 change: 1 addition & 0 deletions docs/edit/runbook.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ The impact is that these **configs are not visible** in Metabase, REDAPL, or any
1. Check the test failure to see exactly which configs are missing
2. Add config normalization rules [here](https://github.com/DataDog/dd-go/tree/prod/trace/apps/tracer-telemetry-intake/telemetry-payload/static/) following the existing pattern
1. This can be merged with any review from [@apm-ecosystems](https://github.com/orgs/DataDog/teams/apm-ecosystems)
2. Bonus Points: Run the auto-formatter [_format.py](https://github.com/DataDog/dd-go/blob/prod/trace/apps/tracer-telemetry-intake/telemetry-payload/static/_format.py) from the `dd-go` root via `python ./trace/apps/tracer-telemetry-intake/telemetry-payload/static/_format.py`
3. After merging, update system-tests by running [update.sh](/tests/telemetry_intake/update.sh)
1. This can be run from the root by running `./tests/telemetry_intake/update.sh`
2. This can be merged with any review from [@apm-ecosystems](https://github.com/orgs/DataDog/teams/apm-ecosystems)
Expand Down
2 changes: 1 addition & 1 deletion tests/test_telemetry.py
Original file line number Diff line number Diff line change
Expand Up @@ -674,7 +674,7 @@ def is_key_accepted_by_telemetry(key, allowed_keys, allowed_prefixes):
if len(missing_config_keys) != 0:
logger.error(json.dumps(missing_config_keys, indent=2))
raise ValueError(
"(NOT A FLAKE) Found unexpected config telemetry keys. Runbook: https://github.com/DataDog/system-tests/blob/main/docs/edit/runbook.md#test_config_telemetry_completeness"
"(NOT A FLAKE) Read this quick runbook to update allowed configs: https://github.com/DataDog/system-tests/blob/main/docs/edit/runbook.md#test_config_telemetry_completeness"
)

@missing_feature(library="cpp")
Expand Down

0 comments on commit 3d75933

Please sign in to comment.