Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

OTEL Remote Management GA #4875

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions blog-service/2025-01-06-otel-remote-management.md
Original file line number Diff line number Diff line change
@@ -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 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).
70 changes: 17 additions & 53 deletions docs/send-data/opentelemetry-collector/remote-management/index.md
Original file line number Diff line number Diff line change
@@ -1,62 +1,26 @@
---
slug: /send-data/opentelemetry-collector/remote-management
title: OpenTelemetry Remote Management
title: Remote Management for OpenTelemetry Collector
sidebar_label: Remote Management
---

import useBaseUrl from '@docusaurus/useBaseUrl';

<head>
<meta name="robots" content="noindex" />
</head>

<p><a href="/docs/beta"><span className="beta">Beta</span></a></p>

This feature is in Beta. To participate, contact your Sumo Logic account executive.

The Sumo Logic Distribution for OpenTelemetry Collector simplifies remote management of data collection, allowing setup from the Sumo Logic UI and deployment to multiple collectors.

## Remote Management features

### 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.

### Source templates

Remote management data configuration for OpenTelemetry collectors is handled using Source templates. This feature extends the [Installed Collector Source](/docs/send-data/installed-collectors/sources) template, allowing association with multiple collectors.

Use collector tags to group collectors and associate Source templates to these groups, reducing redundancy in data collection setup. This process, known as *Collector Linking*, streamlines configuration management.

## 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 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. 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="linux-install" 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”`.
1. Leave the **Collector Settings** at their default values.
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="linux-terminal-installation" 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.

To revisit this screen later, 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**. [**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

Next, you'll create a data collection configuration to gather Apache error logs and link it to all collectors tagged `"application = Apache"`.

1. Complete the Source Template form with the **Name** and **File Path** for your error logs, then click **Next**.
1. Under **Link Collectors**, add the tag `"application = Apache"`.<br/><img src={useBaseUrl('img/send-data/local-file-apache.png')} alt="local-file-apache" 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 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). Additionally, use our [Dashboards](/docs/dashboards) to analyze the logs and gain insights from your Apache servers.
In this section, we'll introduce the following concepts:

<div className="box-wrapper" >
<div className="box smallbox card">
<div className="container">
<a href="/docs/send-data/opentelemetry-collector/remote-management/processing-rules"><img src={useBaseUrl('img/send-data/otel-color.svg')} alt="OTel thumbnail icon" width="25"/><h4>Processing Rules</h4></a>
<p>Use Sumo Logic processing rules for an OTel agent with an OTel remote management (OTRM) source template.</p>
</div>
</div>
<div className="box smallbox card">
<div className="container">
<a href="/docs/send-data/opentelemetry-collector/remote-management/source-templates"><img src={useBaseUrl('img/send-data/otel-color.svg')} alt="OTel thumbnail icon" width="25"/><h4>Source Templates</h4></a>
<p>Sumo Logic OTRM source templates.</p>
</div>
</div>
</div>
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
---
id: overview
title: OpenTelemetry Remote Management Overview
sidebar_label: Overview
---

import useBaseUrl from '@docusaurus/useBaseUrl';

The Sumo Logic Distribution for OpenTelemetry Collector simplifies remote management of data collection, allowing setup from the Sumo Logic UI and deployment to multiple collectors.

## Key benefits of Remote Management

* Simplified setup and configuration via the Sumo Logic UI.
* Tag-based collector grouping 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

* Monitoring error logs across multiple Apache servers.
* Grouping collectors by environment (e.g., production, staging).
* Expanding data collection for new services with minimal effort.
* Simplifying migration from legacy monitoring solutions.


## Remote Management features

### 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.

### Source templates

Remote management data configuration for OpenTelemetry collectors is handled using Source templates. This feature extends the [Installed Collector Source](/docs/send-data/installed-collectors/sources) template, allowing association with multiple collectors.

Use collector tags to group collectors and associate Source templates to these groups, reducing redundancy in data collection setup. This process, known as *Collector Linking*, streamlines configuration management.

## 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 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. 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”`.
1. Leave the **Collector Settings** at their default values.
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.

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

Next, you'll create a data collection configuration to gather Apache error logs and link it to all collectors tagged `"application = Apache"`.

1. Complete the Source Template form with the **Name** and **File Path** for your error logs, then click **Next**.
1. Under **Link Collectors**, add the tag `"application = Apache"`.<br/><img src={useBaseUrl('img/send-data/local-file-apache.png')} alt="Screenshot of the file path configuration for Apache logs" 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="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.

## Try it now

Start simplifying your data collection today by using remote management with OpenTelemetry collectors. For feedback or assistance, contact [Support](https://support.sumologic.com/support/s).
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
id: include-and-exclude-rules
title: Include and Exclude Rules for OpenTelemetry (Beta)
title: Include and Exclude Rules for OpenTelemetry
sidebar_label: Include and Exclude Rules
description: Use include and exclude processing rules to specify what kind of data is sent to Sumo Logic using OpenTelemetry Collector.
---

Expand All @@ -12,7 +13,7 @@ description: Use include and exclude processing rules to specify what kind of da

import useBaseUrl from '@docusaurus/useBaseUrl';

You can use include and exclude processing rules to specify what data is sent to Sumo Logic using OpenTelemetry Collector. Internally these will use [filter processor](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/processor/filterprocessor) to get the data filtered.
You can use include and exclude processing rules to specify what data is sent to Sumo Logic using OpenTelemetry Collector. Internally these will use [filter processor](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/processor/filterprocessor) to get the data filtered.

* An exclude rule functions as a denylist filter where the matching data is not sent to Sumo Logic.
* An include rule functions as an allowlist filter where only matching data is sent to Sumo Logic.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,13 +1,8 @@
---
slug: /send-data/opentelemetry-collector/remote-management/processing-rules
title: Processing Rules for OpenTelemetry (Beta)
title: Processing Rules for OpenTelemetry
description: Use Sumo Logic processing rules for an OpenTelemetry agent with an OpenTelemetry remote management (OTRM) source template.
---
<head>
<meta name="robots" content="noindex" />
</head>

<p><a href="/docs/beta"><span className="beta">Beta</span></a></p>

import useBaseUrl from '@docusaurus/useBaseUrl';

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: mask-rules-windows
title: Mask Rules for Windows Source Template (Beta)
title: Mask Rules for the Windows Source Template
sidebar_label: Mask Rules for Windows
description: Create a mask rule to replace an expression with a mask string.
---
Expand Down Expand Up @@ -142,7 +142,7 @@ Using the above masking options would provide the following result:
}
```

:::note
:::note
- For masking, we use the [replace_pattern](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/pkg/ottl/ottlfuncs/README.md#replace_pattern) OTTL function. In this function:
- $ must be escaped as $$ to bypass environment variable substitution logic.
- To input a literal $, use $$$.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
---
id: mask-rules
title: Mask Rules (Beta)
sidebar_label: Mask Rules
title: Mask Rules
description: Create a mask rule to replace an expression with a mask string.
---
<head>
Expand Down Expand Up @@ -56,8 +55,8 @@ Using the masking string `auth=User:AAA` would provide the following result:
```
"auth"\s*:\s*"Basic\s*[^"]+"
```
If the masking string given here is `"auth":"#####"`, then the log output will be:

If the masking string given here is `"auth":"#####"`, then the log output will be:

```
{
Expand All @@ -82,7 +81,7 @@ Using the masking string `auth=User:AAA` would provide the following result:
auth=User\:(.*(?s).*session=.*?)\]
```

:::note
:::note
- For masking, we use the [replace_pattern](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/pkg/ottl/ottlfuncs/README.md#replace_pattern) OTTL function. In this function:
- $ must be escaped as $$ to bypass environment variable substitution logic.
- To input a literal $, use $$$.
Expand Down
Loading
Loading