|
1 | | -import useBaseUrl from '@docusaurus/useBaseUrl'; |
2 | | - |
3 | | -In this step, we'll create a data collection configuration and link them to all the collectors that have particular tags. |
4 | | - |
5 | | -1. Complete the Source Template form by providing the necessary details, then click **Next**. |
6 | | -1. On the **Link Collectors** step, you will have the option to link the collectors using the Collector name or by adding tags to find the group of collectors. For our scenario, we will add the tag `application = Apache`.<br/><img src={useBaseUrl('img/send-data/local-file-apache.png')} alt="local-file-apache" style={{border: '1px solid gray'}} width="300"/> |
7 | | -1. Click **Preview Collector(s)** to see the list of collectors that will be linked to the newly created source template.<br/><img src={useBaseUrl('img/send-data/link-collectors.png')} alt="link-collectors" style={{border: '1px solid grey'}} width="800"/> |
8 | | -1. Click **Next** to complete the Source Template creation. In the background, the system will apply the configuration to all the linked collectors and will start collecting the respective telemetry data from the remote host. |
9 | | -1. Click the **Log Search** or **Metric Search** icon to search for data collected for this Source Template. |
| 1 | +:::info |
| 2 | +A new source template will always be created with the latest version of the source template. |
| 3 | +::: |
| 4 | + |
| 5 | +Follow the below steps to create a data collection configuration to gather the required logs and link them to all the collectors with the help of collector tags. |
| 6 | + |
| 7 | +1. Complete the source template form with the name and file path for your logs (for example, error logs or access logs), then click **Next**. |
| 8 | +1. Under **Link Collectors**, you will have the option to link the collectors using the collector name or by adding tags to find the group of collectors (for example, `application = Apache`).<br/><img src="/img/send-data/local-file-apache.png" alt="Screenshot of the file path configuration for Apache logs" style={{border:'1px solid gray'}} width="80%" /> |
| 9 | +1. Preview and confirm the collectors that will be linked (fetched automatically) to the newly created source template.<br/><img src="/img/send-data/preview-collectors1.png" alt="Screenshot showing the linked collectors preview" style={{border:'1px solid gray'}} width="90%" /><br/><img src="/img/send-data/preview-collectors2.png" alt="Screenshot showing the linked collectors preview" style={{border:'1px solid gray'}} width="90%" /> |
| 10 | +1. Click **Next** to complete the source template creation. In the background, the system will apply the configuration to all the linked collectors and will start collecting the respective telemetry data from the remote host (in the example, it would start collecting Apache error logs). |
| 11 | +1. Click the **Log Search** or **Metrics Search** icons to search for and analyze your data collected for this source template. |
| 12 | + |
| 13 | +<!-- Remove temporarily; not yet released |
| 14 | +
|
| 15 | +### Collector tags |
| 16 | +
|
| 17 | +#### Add a collector tag |
| 18 | +
|
| 19 | +You can add collector tags during OTEL collector setup - as described in the previous section - or after creation: |
| 20 | +
|
| 21 | +1. Navigate to the **OpenTelemetry Collection** page. |
| 22 | +1. Click on the desired collector where you need to add collector tags. |
| 23 | +1. In the right pane, scroll to the **Collector Tags** section and click **Edit**. |
| 24 | +1. In the edit window, click **+ Add tags**. |
| 25 | +1. Add the required tags and click **Proceed**. |
| 26 | +1. A new **Update Collector Tag(s)** window appears. Click the **click here** link to understand the impact of this update. |
| 27 | +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. |
| 28 | +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. |
| 29 | +1. Once the source template is upgraded and is compatible, enter **PROCEED** and click **Confirm**. |
| 30 | +
|
| 31 | +#### Edit or delete a collector tag |
| 32 | +
|
| 33 | +:::note |
| 34 | +- For default collector tags, you can only edit the **Values**. |
| 35 | +- System collector tags like `sumo.disco.enabled` cannot be edited. |
| 36 | +::: |
| 37 | +
|
| 38 | +To edit or delete a collector tag: |
| 39 | +
|
| 40 | +1. Go to the **OpenTelemetry Collection** page. |
| 41 | +1. Click on the desired collector where you need to add the collector tags. |
| 42 | +1. In the right pane, scroll to the **Collector Tags** section and click **Edit**. |
| 43 | +1. Edit or delete the required tags and click **Proceed**. |
| 44 | +1. A new **Update Collector Tag(s)** window appears. Click the **click here** button to see the impact of this update. |
| 45 | +1. You will be redirected to a **Mapped Source Template** section, which displays the mapped source templates for the edited or deleted collector tags, along with **Compatible** and **Incompatible Version** details. |
| 46 | +1. If find you find an incompatible source template, [upgrade the source template](/docs/send-data/opentelemetry-collector/remote-management/source-templates/manage-source-templates/#upgrade-a-source-template). |
| 47 | +1. Once the source template is upgraded and is compatible, enter **PROCEED** and click **Confirm**. |
| 48 | +--> |
0 commit comments