Skip to content

runbook.md

Latest commit

 

History

History
59 lines (40 loc) · 2.77 KB

runbook.md

File metadata and controls

59 lines (40 loc) · 2.77 KB

DEPRECATED

⚠️ Did this test just fail, and you want to fix it? ⚠️

Here's what you need to do!

test_telemetry.py

test_config_telemetry_completeness

Summary

This can be fixed with ~5 minutes of effort.

This is caused by adding a new config option without adding the associated config normalization rules to telemetry intake

The impact is that these configs are not visible in Metabase, REDAPL, or anywhere else

Runbook

  1. Check the test failure to see exactly which configs are missing.
  2. Add config normalization rules here following the existing pattern. Note that the PR should be made against the prod (default) branch.
    1. This can be merged with any review from @apm-sdk.
    2. Bonus Points: Run the auto-formatter _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
    1. This can be run from the root by running ./utils/telemetry/intake/update.sh
      1. If this fails, try re-running with USE_GIT_SSH=1 to force a git@github.com: URL
    2. This can be merged with any review from @apm-ecosystems
  4. You're all set - your tests should pass 🏁

Details

The specific test that failed is:

tests.test_telemetry.test_config_telemetry_completeness

This asserts that config telemetry is handled properly by telemetry intake

Some files are manually copied from dd-go from/to the following paths using utils/telemetry/intake/update.sh from: https://github.com/DataDog/dd-go/blob/prod/trace/apps/tracer-telemetry-intake/telemetry-payload/static/ to: utils/telemetry/intake/static

If this test fails, it means that a telemetry key was found in config telemetry that does not exist in any of the files listed above in dd-go The impact is that telemetry will not be reported to the Datadog backend won't be unusable

To fix this, you must update dd-go to either

  1. Add an exact config key to match config_norm_rules.json
  2. Add a prefix that matches the config keys to config_prefix_block_list.json
  3. Add a prefix rule that fits an existing prefix to config_aggregation_list.json
  4. (Discouraged) Add a language-specific rule to _config_rules.json

Once dd-go is updated, you can copy over the files to this repo and merge them in as part of your changes This can be done by running the following from the src root

Usage: ./utils/telemetry/intake/update.sh