Skip to content

Commit 53c088f

Browse files
JV0812jpipkin1
andauthored
Otel Collector tags information added (#5050)
* Otel Collector tags * added screenshots * added images * Update docs/send-data/opentelemetry-collector/remote-management/source-templates/manage-source-templates.md Co-authored-by: John Pipkin (Sumo Logic) <[email protected]> * Update docs/send-data/opentelemetry-collector/remote-management/source-templates/manage-source-templates.md Co-authored-by: John Pipkin (Sumo Logic) <[email protected]> * Update docs/send-data/opentelemetry-collector/remote-management/source-templates/manage-source-templates.md Co-authored-by: John Pipkin (Sumo Logic) <[email protected]> * Update docs/send-data/opentelemetry-collector/remote-management/source-templates/manage-source-templates.md Co-authored-by: John Pipkin (Sumo Logic) <[email protected]> * Update manage-source-templates.md * Update docs/send-data/opentelemetry-collector/remote-management/source-templates/manage-source-templates.md * Update docs/send-data/opentelemetry-collector/remote-management/source-templates/manage-source-templates.md * Update docs/send-data/opentelemetry-collector/remote-management/source-templates/manage-source-templates.md --------- Co-authored-by: John Pipkin (Sumo Logic) <[email protected]>
1 parent c9b2145 commit 53c088f

File tree

7 files changed

+30
-2
lines changed

7 files changed

+30
-2
lines changed

docs/send-data/opentelemetry-collector/remote-management/source-templates/manage-source-templates.md

Lines changed: 30 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,6 @@ To monitor Nginx access logs from a group of web servers:
6565
For more details on source templates, see [Installed Collector Sources](/docs/send-data/installed-collectors/sources).
6666
:::
6767

68-
6968
## Edit a source template
7069

7170
To edit a source template:
@@ -76,7 +75,6 @@ To edit a source template:
7675
1. If required, update the collectors on the **Link Collectors** page.
7776
1. Click **Next** to complete editing the source template.
7877

79-
8078
## Upgrade a source template
8179

8280
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
9694
1. From the **Source Template** page, select the source template that you need to delete.
9795
1. Click the **Delete** button (or use the kebab menu against the selected source template, click **Delete** from the dropdown).
9896
1. Confirm the deletion. The source template will be removed from the **Source Template** page and unlinked from all collectors.
97+
98+
## Collector tags
99+
100+
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.
101+
102+
:::note
103+
- Collector tags will only be editable for collectors with version `0.114.0` and above.
104+
- For default collector tags, you can only edit the **Values**.
105+
- System collector tags like `sumo.disco.enabled` cannot be added, updated, or deleted.
106+
:::
107+
108+
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:
109+
110+
1. Navigate to the **OpenTelemetry Collection** page.<br/><img src={useBaseUrl('img/send-data/opentelemetry-collection.png')} alt="opentelemetry-collection" style={{border:'1px solid gray'}} width="700"/>
111+
1. Click on the desired collector where you need to add collector tags.
112+
1. In the right pane, scroll to the **Collector Tags** section and click **Edit**.<br/><img src={useBaseUrl('img/send-data/collector-tags-edit.png')} alt="collector-tags-edit" style={{border:'1px solid gray'}} width="500"/>
113+
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**.<br/><img src={useBaseUrl('img/send-data/add-delete-update-tags.png')} alt="add-delete-update-tags" style={{border:'1px solid gray'}} width="500"/>
114+
1. A new **Update Collector Tag(s)** window appears. Click the **click here** link to understand the impact of this update.<br/><img src={useBaseUrl('img/send-data/update-tags-click-here.png')} alt="update-tags-click-here" style={{border:'1px solid gray'}} width="500"/>
115+
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.<br/><img src={useBaseUrl('img/send-data/mapped-source-templates.png')} alt="mapped-source-templates" style={{border:'1px solid gray'}} width="500"/>
116+
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.
117+
1. Once the source template is upgraded and is compatible, enter **PROCEED** and click **Confirm**.<br/><img src={useBaseUrl('img/send-data/confirm-the-tags.png')} alt="confirm-the-tags" style={{border:'1px solid gray'}} width="500"/>
118+
119+
:::info
120+
If you try to add or update any collector tags using the API, the following validations will occur in the backend:
121+
1. Validates if the collector is remotely managed.
122+
1. Validates if the key/value is empty string.
123+
1. Validates the agent version.
124+
1. Validates if the disco tags are added, updated, or deleted.
125+
1. Validates if the default tags are added or deleted.
126+
:::
176 KB
Loading
936 KB
Loading
220 KB
Loading
364 KB
Loading
726 KB
Loading
152 KB
Loading

0 commit comments

Comments
 (0)