diff --git a/docs/send-data/opentelemetry-collector/remote-management/source-templates/manage-source-templates.md b/docs/send-data/opentelemetry-collector/remote-management/source-templates/manage-source-templates.md index a35d46c4a7..8bed443832 100644 --- a/docs/send-data/opentelemetry-collector/remote-management/source-templates/manage-source-templates.md +++ b/docs/send-data/opentelemetry-collector/remote-management/source-templates/manage-source-templates.md @@ -65,7 +65,6 @@ To monitor Nginx access logs from a group of web servers: For more details on source templates, see [Installed Collector Sources](/docs/send-data/installed-collectors/sources). ::: - ## Edit a source template To edit a source template: @@ -76,7 +75,6 @@ To edit a source template: 1. If required, update the collectors on the **Link Collectors** page. 1. Click **Next** to complete editing the source template. - ## Upgrade a source template You cannot upgrade a source template if there are any incompatible collector versions Make sure you update those collectors first. @@ -96,3 +94,33 @@ You cannot upgrade a source template if there are any incompatible collector ver 1. From the **Source Template** page, select the source template that you need to delete. 1. Click the **Delete** button (or use the kebab menu against the selected source template, click **Delete** from the dropdown). 1. Confirm the deletion. The source template will be removed from the **Source Template** page and unlinked from all collectors. + +## Collector tags + +With remote management, you can tag your [OpenTelemetry Collectors](/docs/send-data/opentelemetry-collector) to categorize and group them. These tags are also enriched in your data, enabling you to use them in your dashboards and searches. + +:::note +- Collector tags will only be editable for collectors with version `0.114.0` and above. +- For default collector tags, you can only edit the **Values**. +- System collector tags like `sumo.disco.enabled` cannot be added, updated, or deleted. +::: + +You can add collector tags during OTEL collector setup as described in the previous section. Follow the below steps to add, update, or delete the collector tags after creation: + +1. Navigate to the **OpenTelemetry Collection** page.
opentelemetry-collection +1. Click on the desired collector where you need to add collector tags. +1. In the right pane, scroll to the **Collector Tags** section and click **Edit**.
collector-tags-edit +1. In the edit window, click **+ Add tags** to add a new tag. You can also update or delete the required tags. Then click **Proceed**.
add-delete-update-tags +1. A new **Update Collector Tag(s)** window appears. Click the **click here** link to understand the impact of this update.
update-tags-click-here +1. You will be redirected to the **Mapped Source Template** section, which displays the mapped source templates for the collector tags added. This window also displays the **Compatible** and **Incompatible Version** details for the mapped source template for the collector.
mapped-source-templates +1. If there are any incompatible source templates, [upgrade the source template](/docs/send-data/opentelemetry-collector/remote-management/source-templates/manage-source-templates/#upgrade-a-source-template) to ensure compatibility. +1. Once the source template is upgraded and is compatible, enter **PROCEED** and click **Confirm**.
confirm-the-tags + +:::info +If you try to add or update any collector tags using the API, the following validations will occur in the backend: +1. Validates if the collector is remotely managed. +1. Validates if the key/value is empty string. +1. Validates the agent version. +1. Validates if the disco tags are added, updated, or deleted. +1. Validates if the default tags are added or deleted. +::: diff --git a/static/img/send-data/add-delete-update-tags.png b/static/img/send-data/add-delete-update-tags.png new file mode 100644 index 0000000000..3fabf64b0d Binary files /dev/null and b/static/img/send-data/add-delete-update-tags.png differ diff --git a/static/img/send-data/collector-tags-edit.png b/static/img/send-data/collector-tags-edit.png new file mode 100644 index 0000000000..914d4ea368 Binary files /dev/null and b/static/img/send-data/collector-tags-edit.png differ diff --git a/static/img/send-data/confirm-the-tags.png b/static/img/send-data/confirm-the-tags.png new file mode 100644 index 0000000000..48b39a841e Binary files /dev/null and b/static/img/send-data/confirm-the-tags.png differ diff --git a/static/img/send-data/mapped-source-templates.png b/static/img/send-data/mapped-source-templates.png new file mode 100644 index 0000000000..a8bdc00c64 Binary files /dev/null and b/static/img/send-data/mapped-source-templates.png differ diff --git a/static/img/send-data/opentelemetry-collection.png b/static/img/send-data/opentelemetry-collection.png new file mode 100644 index 0000000000..8cbdcb4acb Binary files /dev/null and b/static/img/send-data/opentelemetry-collection.png differ diff --git a/static/img/send-data/update-tags-click-here.png b/static/img/send-data/update-tags-click-here.png new file mode 100644 index 0000000000..85b61baeed Binary files /dev/null and b/static/img/send-data/update-tags-click-here.png differ