-
Notifications
You must be signed in to change notification settings - Fork 1.2k
New doc for service override removal #33535
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
domalessi
wants to merge
9
commits into
master
Choose a base branch
from
domalessi/service-override-removal
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+112
−59
Open
Changes from all commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
2fc8464
move removal content from service override page into service override…
domalessi 0dba74a
add screenshots, copy refinements
domalessi 43deaa8
tweak final secxtion
domalessi 7b6ac4e
edit call-out to removal page on the service overrides guide page
domalessi a4729a0
Update content/en/tracing/guide/service_overrides.md
domalessi 97c8fcb
flesh out first paragraph
domalessi b6d685c
move service override removal page
domalessi 95f2dc2
title tweak for consistency with other pages
domalessi 6731440
change title of page reference
domalessi File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
101 changes: 101 additions & 0 deletions
101
content/en/tracing/services/service_override_removal.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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,101 @@ | ||
| --- | ||
| title: Service Override Removal | ||
| description: Learn how to remove integration service overrides from Datadog. | ||
| disable_toc: false | ||
| further_reading: | ||
| - link: "/tracing/guide/service_overrides" | ||
| tag: "Documentation" | ||
| text: "Service Overrides" | ||
| - link: "/tracing/services/inferred_services" | ||
| tag: "Documentation" | ||
| text: "Inferred Services" | ||
| --- | ||
|
|
||
| This page explains how to remove integration service overrides, which use integration-specific service names to represent calls to other services. For conceptual background, see [Service Overrides][10] and [Inferred Services][8]. | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| Before you remove integration service overrides: | ||
|
|
||
| 1. You must have the `apm_service_renaming_write` permission. | ||
| 1. Your Datadog SDK version must support override removal. See [SDK version requirements](#sdk-version-requirements). | ||
|
|
||
| ### SDK version requirements | ||
|
|
||
| | Language | Minimum supported version | | ||
| |------------|---------------------------| | ||
| | .NET | [3.4.0][1] | | ||
| | Go | [1.55.0][2] | | ||
| | Java | [1.20.0][3] | | ||
| | Node.js | [4.16.0][4] | | ||
| | PHP | [0.94.1][5] | | ||
| | Python | [1.19.0][6] | | ||
| | Ruby | [1.15.0][7] | | ||
|
|
||
| ## Remove service overrides | ||
|
|
||
| To remove service overrides in Datadog: | ||
|
|
||
| 1. Navigate to **Software Catalog** > **Manage** > [**Manage Remapping Rules**][12], and click **Manage Overrides**. | ||
|
|
||
| {{< img src="tracing/guide/service_overrides/SO_removal_page.png" alt="Service Overrides page showing migration progress and removal options" style="width:100%;" >}} | ||
|
|
||
| 1. For each override you plan to remove, review the related monitors and dashboards. | ||
|
|
||
| These assets reference the overridden service name and stop matching after removal. Update them to use the base service name (`service:<DD_SERVICE>`) to preserve functionality. | ||
|
|
||
| {{< img src="tracing/guide/service_overrides/SO_removal_page_sidepanel.png" alt="Service override side panel showing affected monitors and dashboards" style="width:100%;" >}} | ||
|
|
||
| 1. Remove overrides individually or in bulk: | ||
| - **Select specific overrides to remove**: Choose individual integration service overrides to remove. A **Migration Progress** bar shows your progress as you remove overrides. This action is reversible. | ||
| - **Remove all overrides**: Select **Remove All Overrides** to permanently remove all integration service overrides and prevent future ones from appearing as APM usage increases. Custom service overrides are not affected. | ||
|
|
||
| <div class="alert alert-danger">Removing all integration service overrides is permanent and cannot be undone.</div> | ||
|
|
||
| ## Examples: Service naming after removal | ||
|
|
||
| Removing service overrides changes how client spans are tagged and how downstream dependencies are identified. After overrides are removed, client spans use the calling service's name (`service:<DD_SERVICE>`) instead of the integration-specific name. The called dependency is identified using [`peer.*` attributes][11] (for example, database or queue). | ||
|
|
||
| **gRPC example:** | ||
|
|
||
| | Scenario | Service name | Additional `peer.*` attributes | | ||
| |---------------------------|-----------------------------------------------------------|--------------------------------| | ||
| | With service overrides | `service:my-service-grpc-client` or `service:grpc-client` | None | | ||
| | Without service overrides | `service:myservice` | `@peer.service:otherservice` | | ||
|
|
||
| **MySQL example:** | ||
|
|
||
| | Scenario | Service name | Additional `peer.*` attributes | | ||
| |----------|--------------|--------------------------------| | ||
| | With service overrides | `service:my-service-mysql` or `service:mysql` | None | | ||
| | Without service overrides | `service:myservice` | `@peer.db.name:user-db`, `@peer.db.system:mysql` | | ||
|
|
||
| ## Configuration-based removal | ||
|
|
||
| You can also remove integration service overrides by setting an environment variable in your application configuration. This approach is useful if you cannot access the Datadog UI. | ||
|
|
||
| 1. Confirm that your SDK meets the [minimum version requirements](#sdk-version-requirements). | ||
| 2. Set the following environment variable: | ||
| ```sh | ||
| DD_TRACE_REMOVE_INTEGRATION_SERVICE_NAMES_ENABLED=true | ||
| ``` | ||
|
|
||
| This ensures the `service` attribute always uses the base service name instead of appending the integration name (for example, `*-postgres`, `*-http-client`). Custom service overrides are not affected and must be removed directly in your code. | ||
|
|
||
| ## Further reading | ||
|
|
||
| {{< partial name="whats-next/whats-next.html" >}} | ||
|
|
||
| [1]: https://github.com/DataDog/dd-trace-dotnet/releases/tag/v3.4.0 | ||
| [2]: https://github.com/DataDog/dd-trace-go/releases/tag/v1.55.0 | ||
| [3]: https://github.com/DataDog/dd-trace-java/releases/tag/v1.20.0 | ||
| [4]: https://github.com/DataDog/dd-trace-js/releases/tag/v4.16.0 | ||
| [5]: https://github.com/DataDog/dd-trace-php/releases/tag/0.94.1 | ||
| [6]: https://github.com/DataDog/dd-trace-py/releases/tag/v1.19.0 | ||
| [7]: https://github.com/DataDog/dd-trace-rb/releases/tag/v1.15.0 | ||
| [8]: /tracing/services/inferred_services | ||
| [9]: https://app.datadoghq.com/apm/settings/service-naming | ||
| [10]: /tracing/guide/service_overrides | ||
| [11]: /tracing/services/inferred_services/#peer-tags | ||
| [12]: https://app.datadoghq.com/software/settings/service-remapping | ||
|
|
||
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+426 KB
static/images/tracing/guide/service_overrides/SO_removal_page_sidepanel.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.