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

@@ -2674,7 +2674,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

@@ -1,17 +1,14 @@
-import useBaseUrl from '@docusaurus/useBaseUrl';
+In this step, we'll install the collector and add a uniquely identifiable tag to these collectors.
 
-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. On the **OpenTelemetry Collection** page, click **+ Add Collector**.
+1. In the **Set up Collector** step:
+   1. Choose your platform (for example, Linux).
+   1. Enter your **Installation Token**.
+   1. Under **Tag data on Collector level**, add a new tag to identify these collectors as having Apache running on them (for example, `application = Apache`).
+   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.
+1. After installation is complete, click **Next** to proceed.
+1. Select a source template (for example, Apache source template) to start collecting logs from all linked collectors, then proceed with the data configuration.<br/><img src="/img/send-data/source-template.png" alt="source template page" style={{border:'1px solid gray'}} width="90%" />
 
-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.
-
-:::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**. 
-:::
+To revisit this screen later: From the [**Classic UI**](/docs/get-started/sumo-logic-ui-classic), select **Manage Data > Collection > Source Template**. From the [**New UI**](/docs/get-started/sumo-logic-ui), select **Configuration** > **Source Template**.

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

@@ -1,9 +1,48 @@
-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. 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.
+:::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 logs (for example, error logs or access logs), then click **Next**.
+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%" />
+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%" />
+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).
+1. Click the **Log Search** or **Metrics Search** icons to search for and analyze your data collected for this source template.
+
+<!-- Remove temporarily; not yet released
+
+### Collector tags
+
+#### Add a collector tag
+
+You can add collector tags during OTEL collector setup - as described in the previous section - or after creation:
+
+1. Navigate to the **OpenTelemetry Collection** page.
+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**.
+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. Go to the **OpenTelemetry Collection** page.
+1. Click on the desired 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**.
+-->

docs/reuse/apps/opentelemetry/logs-advance-option-otel.md

@@ -1,6 +1,5 @@
-**Advance options** for log collection can be used as follows : 
-
-    **Timestamp Format**. By default, Sumo Logic will automatically detect the timestamp format of your logs. However, you can manually specify a timestamp format for a source by specifying the following:
-        - **Timestamp locator**. This will be a [Go regular expression](https://github.com/google/re2/wiki/Syntax) which should have timestamp matched using a named capture group. Name of this captured group should be “timestamp_field”.
-        - **Layout**. The exact layout of the timestamp to be parsed for example - %Y-%m-%dT%H:%M:%S.%LZ. To learn more about the rules, [refer here](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/internal/coreinternal/timeutils/internal/ctimefmt/ctimefmt.go#L68).
-        - **Location (Time zone)** : The geographic location (timezone) to use when parsing a timestamp that does not include a timezone. The available locations depend on the local IANA Time Zone database. [This page](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) contains many examples, such as America/New_York.
+**Advance options** for log collection can be used as follows:
+   * **Timestamp Format**. By default, Sumo Logic will automatically detect the timestamp format of your logs. However, you can manually specify a timestamp format for a source by configuring the following:
+      - **Timestamp locator**. Use a [Go regular expression](https://github.com/google/re2/wiki/Syntax) to match the timestamp in your logs. Ensure the regular expression includes a named capture group called `timestamp_field`.
+      - **Layout**. Specify the exact layout of the timestamp to be parsed. For example, `- %Y-%m-%dT%H:%M:%S.%LZ`. To learn more about the formatting rules, refer to [this guide](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/internal/coreinternal/timeutils/internal/ctimefmt/ctimefmt.go#L68).
+      - **Location (Time zone)**. Define the geographic location (timezone) to use when parsing a timestamp that does not include a timezone. The available locations depend on the local IANA Time Zone database. For example, `America/New_York`. See more examples [here](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).