OTEL Remote Management GA

blog-service/2025-01-08-otel-remote-management.md

@@ -0,0 +1,23 @@
+---
+title: Remote Management for OpenTelemetry Collector (Collection)
+image: https://help.sumologic.com/img/sumo-square.png
+keywords:
+  - collection
+  - opentelemetry
+  - otel
+  - remote-management
+hide_table_of_contents: true    
+---
+
+import useBaseUrl from '@docusaurus/useBaseUrl';
+
+<a href="https://help.sumologic.com/release-notes-service/rss.xml"><img src={useBaseUrl('img/release-notes/rss-orange2.png')} alt="icon" width="50"/></a>
+
+The Sumo Logic Distribution for OpenTelemetry Collector now supports remote management, enabling you to configure and manage data collection directly from the Sumo Logic UI. With this feature, you can:  
+
+* **Simplify configuration**. Set up and manage data collection for multiple collectors without server access.  
+* **Streamline workflows**. Use tags to group collectors and apply centralized data source templates, reducing redundancy and manual effort.  
+* **Enhance automation**. Automatically monitor new servers by tagging them during setup.  
+* **Accelerate time to value**. Start collecting data in minutes with an intuitive UI and no need to manage configuration files.  
+
+This release provides a faster, more efficient way to manage large-scale data collection, supporting scalable and automated operations. [Learn more](/docs/send-data/opentelemetry-collector/remote-management).  

cid-redirects.json

@@ -2672,7 +2672,7 @@
   "/cid/9008": "/docs/alerts/webhook-connections/new-relic",
   "/cid/10333": "/docs/send-data/opentelemetry-collector/remote-management/processing-rules",
   "/cid/10334": "/docs/send-data/opentelemetry-collector/remote-management/processing-rules/include-and-exclude-rules",
-  "/cid/10335": "/docs/send-data/opentelemetry-collector/remote-management/processing-rules/metrics-include-and-exclude-rules",
+  "/cid/10335": "/docs/send-data/opentelemetry-collector/remote-management/processing-rules/include-and-exclude-rules",
   "/cid/10336": "/docs/send-data/opentelemetry-collector/remote-management/processing-rules/mask-rules",
   "/cid/9010": "/docs/send-data/opentelemetry-collector",
   "/cid/9011": "/docs/send-data/opentelemetry-collector/install-collector/linux",

docs/reuse/apps/opentelemetry/collector-installation.md

@@ -2,16 +2,16 @@ import useBaseUrl from '@docusaurus/useBaseUrl';
 
 In this step, we will install the collector and add a uniquely identifiable tag to these collectors.
 
-1. [**Classic UI**](/docs/get-started/sumo-logic-ui-classic). In the main Sumo Logic menu, select **Manage Data > Collection > OpenTelemetry Collection**. <br/>[**New UI**](/docs/get-started/sumo-logic-ui). In the Sumo Logic top menu select **Configuration**, and then under **Data Collection** select **OpenTelemetry Collection**. You can also click the **Go To...** menu at the top of the screen and select **OpenTelemetry Collection**. 
+1. [**Classic UI**](/docs/get-started/sumo-logic-ui-classic). In the main Sumo Logic menu, select **Manage Data > Collection > OpenTelemetry Collection**. <br/>[**New UI**](/docs/get-started/sumo-logic-ui). In the Sumo Logic top menu select **Configuration**, and then under **Data Collection** select **OpenTelemetry Collection**. You can also click the **Go To...** menu at the top of the screen and select **OpenTelemetry Collection**.
 1. On the **OpenTelemetry Collection** page, click **Add Collector**.
 1. Select the platform of the remote host in the **Set up Collector**  section.<br/><img src={useBaseUrl('img/send-data/linux-install.png')} alt="Linux-install" style={{border: '1px solid gray'}} width="800"/>
 1. Enter your **Installation Token**.
 1. Under **Tag data on Collector level**, add a new key-value pair by clicking **+New tags**, for example, `application = Apache` to identify these collectors as having Apache running on them.
 1. For **Collector Settings**, leave it as default.
 1. Under **Generate and run the command to install the collector**, copy the command and execute it in your system terminal, where the collector needs to be installed.<br/><img src={useBaseUrl('img/send-data/linux-terminal-installation.png')} alt="Linux-terminal-installation" width="800"/>
 1. Wait for the installation process to complete, then click **Next** to proceed.
-1. On the next screen, you will see a list of available Source Templates.
+1. On the next screen, you will see a list of available source templates.
 
 :::note
-If you close this Source template creation screen, you can navigate back. [**Classic UI**](/docs/get-started/sumo-logic-ui-classic). In the main Sumo Logic menu, select **Manage Data > Collection > Source Template**. <br/>[**New UI**](/docs/get-started/sumo-logic-ui). In the Sumo Logic top menu select **Configuration**, and then under **Data Collection** select **Source Template**. You can also click the **Go To...** menu at the top of the screen and select **Source Template**. 
+If you close this source template creation screen, you can navigate back. [**Classic UI**](/docs/get-started/sumo-logic-ui-classic). In the main Sumo Logic menu, select **Manage Data > Collection > Source Template**. <br/>[**New UI**](/docs/get-started/sumo-logic-ui). In the Sumo Logic top menu select **Configuration**, and then under **Data Collection** select **Source Template**. You can also click the **Go To...** menu at the top of the screen and select **Source Template**. 
 :::

docs/reuse/apps/opentelemetry/data-configuration.md

@@ -1,9 +1,9 @@
 import useBaseUrl from '@docusaurus/useBaseUrl';
 
 In this step, we'll create a data collection configuration and link them to all the collectors that have particular tags.
-		
-1. Complete the Source Template form by providing the necessary details, then click **Next**.
-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"/>
+
+1. Complete the source template form by providing the necessary details, then click **Next**.
+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. In this Apache example, 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"/>
 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"/>
-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.
-1. Click the **Log Search** or **Metric Search** icon to search for data collected for this Source Template.
+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.
+1. Click the **Log Search** or **Metric Search** icon to search for data collected for this source template.

docs/send-data/opentelemetry-collector/remote-management/configure-collector.md

@@ -0,0 +1,109 @@
+---
+id: configure-collector
+title: Configure OpenTelemetry Collector for Remote Management
+sidebar_label: Configure OpenTelemetry Collector
+description: Learn how to install and tag Your OpenTelemetry Collector to set up remote management of data collection.
+---
+
+import useBaseUrl from '@docusaurus/useBaseUrl';
+
+The [Sumo Logic Distribution for OpenTelemetry Collector](/docs/send-data/opentelemetry-collector) simplifies remote management of data collection. It allows you to set up and configure collectors from the Sumo Logic UI, deploy to multiple collectors at once, and centrally manage configurations using source templates.
+
+You can tag your OpenTelemetry collectors to categorize and group them. These tags are enriched in your data so you can use them in dashboards and searches.
+
+Remote management data configuration is handled using source templates. This feature extends our [Installed Collector](/docs/send-data/installed-collectors/sources) source template to support multiple collectors.
+
+By associating source templates with collector tags—a process called *Collector Linking*—you reduce redundancy in data collection setup and streamline configuration management across your environment.
+
+## Key benefits of remote management
+
+* Simplified setup and configuration via the Sumo Logic UI
+* [Tag-based collector grouping](#collector-tags) for efficient data collection
+* Centralized configuration using [source templates](/docs/send-data/opentelemetry-collector/remote-management/source-templates)
+* No server access required after installation
+* Faster time to value and reduced manual errors
+
+## Common use cases
+
+* Grouping collectors by environment (for example, production, staging)
+* Expanding data collection for new services with minimal effort
+* Simplifying migration from legacy monitoring solutions
+* Monitoring error logs across multiple Apache servers
+
+## How it works
+
+To illustrate the setup and configuration process, let's walk through an example scenario where you'd need to monitor Apache error logs from 50 Linux servers.
+
+### Step 1: Install and tag collectors
+
+First, you'll need to install the OpenTelemetry collectors on each of the 50 servers and tag them to indicate that they are running Apache.
+
+1. [**Classic UI**](/docs/get-started/sumo-logic-ui-classic). In the main Sumo Logic menu, select **Manage Data > Collection > OpenTelemetry Collection**. <br/>[**New UI**](/docs/get-started/sumo-logic-ui). In the Sumo Logic top menu, select **Configuration**, and then under **Data Collection** select **OpenTelemetry Collection**.
+1. On the **OpenTelemetry Collection** page, click **Add Collector**.
+1. In the **Set up Collector** step, choose **Linux** as the platform.<br/><img src={useBaseUrl('img/send-data/linux-install.png')} alt="Screenshot showing the Linux installation options for the collector" style={{border: '1px solid gray'}} width="800"/>
+1. Enter your **Installation Token**.
+1. Under **Tag data on Collector level**, add a new tag, `“application = Apache”`, to identify these collectors as having Apache running on them.
+1. Leave the **Collector Settings** at their default values to configure collectors as remotely managed.
+1. Under **Generate and run the command to install the collector**, copy and run the installation command in your system terminal where the collector needs to be installed.<br/><img src={useBaseUrl('img/send-data/linux-terminal-installation.png')} alt="Screenshot showing the terminal command to install the collector" width="800"/>
+1. After installation is complete, click **Next** to proceed.
+1. On the next screen, you will see a list of available source templates. Select the **Apache Source Template** to apply the source template to start collecting logs from all linked collectors, then proceed with the data configuration.
+
+To revisit this screen later, navigate to:
+* [**Classic UI**](/docs/get-started/sumo-logic-ui-classic): In the main Sumo Logic menu, select **Manage Data > Collection > Source Template**.
+* [**New UI**](/docs/get-started/sumo-logic-ui): In the Sumo Logic top menu select **Configuration**, and then under **Data Collection**, select **Source Template**.  
+
+
+### Step 2: Configure data collection
+
+:::info
+A new source template will always be created with the latest version of the source template.
+:::
+
+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:
+
+1. Complete the source template form with the name and file path for your error logs, then click **Next**.<br/><img src={useBaseUrl('img/send-data/local-file-apache.png')} alt="Screenshot of the file path configuration for Apache logs" style={{border: '1px solid gray'}} width="700"/>
+1. Under **Link Collectors**, add the tag `"application = Apache"`.<br/><img src={useBaseUrl('img/send-data/link-collectors.png')} alt="Screenshot showing the linked collectors preview" style={{border: '1px solid gray'}} width="800"/>
+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/preview-collectors.png')} alt="Screenshot showing the linked collectors preview" style={{border: '1px solid gray'}} width="800"/>
+1. Click **Next** to complete source template creation. The system will apply the configuration to all linked collectors and start collecting Apache error logs.
+
+### Step 3: Monitor logs
+
+After configuring data collection, you can monitor the collected Apache error logs using the [Log Search](/docs/search) and leverage [Dashboards](/docs/dashboards) to analyze the logs and gain insights from your Apache servers.
+
+## Collector tags
+
+### Add a collector tag
+
+There are place ways to add collector tags: [while creating the OTEL collector](#step-1-install-and-tag-collectors) and after creating the collector. To add a collector tag after the collector is created:
+
+1. [**Classic UI**](/docs/get-started/sumo-logic-ui-classic/). In the main Sumo Logic menu, select **Manage Data > Collection > OpenTelemetry Collection**. <br/>[**New UI**](/docs/get-started/sumo-logic-ui/). In the Sumo Logic top menu, select **Configuration** and then under **Data Collection**, select **OpenTelemetry Collection**.
+1. Click on the required collector where you need to add collector tags.
+1. In the right pane, scroll to the **Collector Tags** section and click **Edit**.
+1. In the edit window, click **+ Add tags**.
+1. Add the required tags and click **Proceed**.
+1. A new **Update Collector Tag(s)** window appears. Click the **click here** link to understand the impact of this update.
+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.
+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**.
+
+### Edit or delete a collector tag
+
+:::note
+- For default collector tags, you can only edit the **Values**.
+- System collector tags like `sumo.disco.enabled` cannot be edited.
+:::
+
+To edit or delete a collector tag:
+
+1. [**Classic UI**](/docs/get-started/sumo-logic-ui-classic/). In the main Sumo Logic menu, select **Manage Data > Collection > OpenTelemetry Collection**. <br/>[**New UI**](/docs/get-started/sumo-logic-ui/). In the Sumo Logic top menu select **Configuration**, and then under **Data Collection**, select **OpenTelemetry Collection**.
+1. Click on the required collector where you need to add the collector tags.
+1. In the right pane, scroll to the **Collector Tags** section and click **Edit**.
+1. Edit or delete the required tags and click **Proceed**.
+1. A new **Update Collector Tag(s)** window appears. Click the **click here** button to see the impact of this update.
+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.
+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).
+1. Once the source template is upgraded and is compatible, enter **PROCEED** and click **Confirm**.
+
+## Source templates
+
+See [Managing Source Templates](/docs/send-data/opentelemetry-collector/remote-management/source-templates/manage-source-templates) to learn how to create and manage OpenTelemetry remote management source templates.