Overview

Use tag enrichment rules to add team and system tags to your APM spans without code changes or redeployment. Datadog automatically pulls tag values from service metadata you’ve already defined in Software Catalog.

Prerequisites

You must have the Datadog Admin Role to create tag enrichment rules. See Role-based access control for details.

Create a tag enrichment rule

Default tag enrichment rules

To enable a default rule, navigate to IDP > Manage > Tag Enrichment and toggle on the default rule for team or system at the bottom of the page.

Enabling a default rule applies team or system to all telemetry of services based on the Entity Metadata defined in IDP. Only services with Entity Metadata populated are enriched. Tags are added only when the service’s telemetry does not already have a value for that tag.

Custom tag enrichment rules

Custom rules let you target a specific set of services and configure exactly how each tag value is sourced and applied.

1. In Datadog, navigate to IDP > Manage > Tag Enrichment and click + Add Rule.
2. Select entities to enrich. As you select entities, a query is built in the background. To edit the query, select Build Advanced Query.
   • Select Add Condition to add an AND condition to your query.
   • Add multiple values in the Value field to create an OR condition.
3. Choose tags and enrichment methods:
   • Select the team tag, system tag, or both.
   • For each tag, select whether the tag value comes from Entity Metadata, the value of a different tag, or a fixed value.
   • Choose whether the value is applied only when it doesn’t already exist, or is appended to the current list of values for that tag.
4. By default, tags are added to all telemetry. Select which telemetry types to enrich.
5. Optionally, enter a descriptive name for the rule.
6. Review and save your rule. After you save the rule, it can take up to an hour for enrichment to be fully applied to incoming telemetry.

Add a tag enrichment rule from a service page

On any service page that is missing a team or system tag, click Add Tags on the top banner to enrich telemetry for that service.

Tag enrichment behavior

• Impacted telemetry: Tag enrichment applies to APM spans only.
• Historical data: Tag enrichment rules apply only to telemetry ingested while a rule is active. Past data is not updated retroactively. Deleting or modifying a rule stops it from applying to new telemetry, but does not update previously ingested data.
• Metadata updates: Updating or adding Entity Metadata to services for team or system while an enrichment rule is enabled, including the default rule, automatically updates those tags.
• Rule processing order: Tag enrichment rules are applied in the order in which they were created. Rules at the top of the list take precedence over rules below them.
• Interaction with remapping rules: Tag enrichment rules are applied after service remapping rules. If a service remapping rule modifies the service tag, enrichment uses the updated service name when looking up IDP metadata.

Further reading

Additional helpful documentation, links, and articles:

Service remapping rulesDOCUMENTATION Software CatalogDOCUMENTATION