Skip to content

Commit 48651da

Browse files
Update renaming_rules.md (#32789)
1 parent df23f41 commit 48651da

File tree

1 file changed

+8
-12
lines changed

1 file changed

+8
-12
lines changed

content/en/tracing/services/renaming_rules.md

Lines changed: 8 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,6 @@ further_reading:
77
text: "Inferred services"
88
---
99

10-
{{< callout url="https://www.datadoghq.com/product-preview/renaming-rules-for-inferred-entities" d_target="#signupModal" btn_hidden="false" header="Join the preview for renaming rules for inferred entities!" >}}
11-
{{< /callout >}}
12-
1310
## Overview
1411

1512
In Datadog, you can rename inferred entities, including datastores and queues, to make them easier to identify and manage. Renaming rules let you override the `peer.service` tag on spans with custom names, or generate names dynamically using tags and regular expressions. This functionality applies across all of APM, not only in the [Software Catalog][3]. After a rule is created, the updated names appear consistently in service maps, Trace Explorer, monitors, dashboards, and any other APM view.
@@ -27,36 +24,35 @@ You must have the `apm_service_renaming_write` permission to create renaming rul
2724

2825
## Create a renaming rule
2926

30-
### Step 1: Select entities to rename
27+
### Step 1: Select renaming action and entities to target
3128

32-
1. In Datadog, navigate to **APM > Settings > Service Renaming** and click **+ Add Rule**.
29+
1. In Datadog, navigate to **APM > Software Catalog > Manage > Manage Renaming Rules** and click **+ Add Rule**.
3330

3431
Alternatively, navigate to **APM > Software Catalog** and click on a service to open the service side panel. From there, click **Service Page > Service Renaming**.
3532

3633
{{< img src="tracing/services/renaming_rules/service-side-panel.png" alt="The side panel for a particular service, showing the Service Page dropdown menu with a Service Renaming option" style="width:100%;" >}}
3734

35+
1. Choose a renaming action you want to perform for your new renaming rule.
36+
1. You can select to split a single entity, rename an entity, merge multiple entites together, or rename several entities.
37+
3838
1. Use the search bar to select the entities you want to rename.
3939
1. You can select one or more entities, but all must be of the same type (service, datastore, or queue).
40-
1. As you select entities, a span query is built in the background. To edit the query, select the code icon to the right of the search bar.
40+
1. As you select entities, a span query is built in the background. To edit the query, select **Build Advanced Query**.
4141

42-
{{< img src="tracing/services/renaming_rules/create-service-rename-rule-search.png" alt="Step 1 in the Create Service Rename Rule UI, prompting the user to filter and select the entities to rename" style="width:100%;" >}}
4342

44-
### Step 2: Choose a rename method
43+
### Step 2: Specify new entity name
4544

4645
1. In the text box, enter a unique name for the selected entity (or entities). Alternatively, use tag values with the `{{tagName}}` syntax to rename based on an entity's tags.
4746
1. If tag values follow a pattern, apply a regular expression to extract only the portion you want in the name.
4847

49-
{{< img src="tracing/services/renaming_rules/create-service-rename-rule-tags.png" alt="Step 2 in the Create Service Rename Rule UI, prompting the user to choose how to rename the selected entities" style="width:100%;" >}}
50-
5148

5249
### Step 3: Name your rule and review
5350

54-
1. Enter a descriptive name for the renaming rule so you can identify it later.
51+
1. Optionally, enter a descriptive name for the renaming rule so you can identify it later.
5552
1. Review and save your renaming rule.
5653

5754
**Note:** Rules are processed at intake and applied to data as it comes in. Changes affect only spans ingested while a rule is active, and past data is not updated retroactively. Deleting or modifying a rule stops it from applying to new data, but does not revert names on previously ingested data.
5855

59-
{{< img src="tracing/services/renaming_rules/create-service-rename-rule-reviewandsave.png" alt="The final step of the Create Service Rename Rule UI, prompting the user to review and save their renaming rule" style="width:100%;" >}}
6056

6157
## Further reading
6258

0 commit comments

Comments
 (0)