Skip to content

OTEL Remote Management GA #4875

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

Merged
merged 50 commits into from
Jan 9, 2025
Merged
Show file tree
Hide file tree
Changes from 8 commits
Commits
Show all changes
50 commits
Select commit Hold shift + click to select a range
250fc07
OTEL Remote Management GA
kimsauce Dec 13, 2024
d8b8694
release note
kimsauce Dec 13, 2024
916f9ab
Edits to release note & doc
kimsauce Dec 15, 2024
217f338
Processing rule edits
kimsauce Dec 20, 2024
1e10216
Update docs/send-data/opentelemetry-collector/remote-management/proce…
kimsauce Dec 20, 2024
461bfdb
edits
kimsauce Dec 20, 2024
8d20963
Update docs/send-data/opentelemetry-collector/remote-management/proce…
kimsauce Dec 20, 2024
dc38a22
Merge branch 'main' into DOCS-146
kimsauce Dec 20, 2024
8446b69
Update docs/send-data/opentelemetry-collector/remote-management/overv…
kimsauce Dec 28, 2024
149b288
Update docs/send-data/opentelemetry-collector/remote-management/overv…
kimsauce Dec 28, 2024
11cbc2e
Merge branch 'main' into DOCS-146
kimsauce Dec 28, 2024
2e68bd4
More edits
kimsauce Dec 28, 2024
2972ab2
Update docs/send-data/opentelemetry-collector/remote-management/index.md
kimsauce Dec 28, 2024
78fcfa9
Update docs/send-data/opentelemetry-collector/remote-management/proce…
kimsauce Dec 28, 2024
4d72f2e
more edits
kimsauce Dec 29, 2024
60f5725
Merge branch 'DOCS-146' of github.com:SumoLogic/sumologic-documentati…
kimsauce Dec 29, 2024
2442b5c
Update docs/send-data/opentelemetry-collector/remote-management/remot…
kimsauce Dec 29, 2024
21d9174
Update docs/send-data/opentelemetry-collector/remote-management/remot…
kimsauce Dec 29, 2024
7428120
edits for consistency
kimsauce Dec 30, 2024
472cb48
Merge branch 'DOCS-146' of github.com:SumoLogic/sumologic-documentati…
kimsauce Dec 30, 2024
ad9d382
Update macos.md
kimsauce Dec 30, 2024
7a412dd
Update linux.md
kimsauce Dec 30, 2024
eab6871
Update windows.md
kimsauce Dec 30, 2024
880cc91
Update linux.md
kimsauce Dec 30, 2024
0346beb
Update macos.md
kimsauce Dec 30, 2024
43bd518
Update puppet.md
kimsauce Dec 30, 2024
c7ec414
Update windows.md
kimsauce Dec 30, 2024
527295c
last edits
kimsauce Dec 30, 2024
af9e447
link fix
kimsauce Dec 30, 2024
054318c
link fix
kimsauce Dec 30, 2024
45dee38
Update blog-service/2025-01-06-otel-remote-management.md
kimsauce Jan 2, 2025
667c2c5
Add/Edit/Delete collector tag info added (#4841)
JV0812 Jan 6, 2025
19aac0c
Merge branch 'main' into DOCS-146
kimsauce Jan 6, 2025
fdd5d81
Merge branch 'main' into DOCS-146
kimsauce Jan 6, 2025
4685e14
Updates
kimsauce Jan 7, 2025
c56917d
Merge branch 'DOCS-146' of github.com:SumoLogic/sumologic-documentati…
kimsauce Jan 7, 2025
8c17b81
broken anchor
kimsauce Jan 7, 2025
7717ec9
links
kimsauce Jan 7, 2025
9b2ffa3
Update docs/send-data/opentelemetry-collector/remote-management/sourc…
kimsauce Jan 7, 2025
dfaac11
Merge branch 'main' into DOCS-146
kimsauce Jan 7, 2025
142d1d1
Merge branch 'main' into DOCS-146
kimsauce Jan 8, 2025
463f794
swap screenshots
kimsauce Jan 8, 2025
f15c8af
Merge branch 'main' into DOCS-146
kimsauce Jan 8, 2025
d8a5df2
Consolidating docs
kimsauce Jan 9, 2025
26f7ee7
last edits
kimsauce Jan 9, 2025
571e051
link fix
kimsauce Jan 9, 2025
4a4452b
links
kimsauce Jan 9, 2025
1c076f6
Merge branch 'main' into DOCS-146
kimsauce Jan 9, 2025
56776c9
last fixes
kimsauce Jan 9, 2025
dab3877
Merge branch 'DOCS-146' of github.com:SumoLogic/sumologic-documentati…
kimsauce Jan 9, 2025
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,28 +1,23 @@
---
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.
---

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

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

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 define which data is sent to Sumo Logic using the OpenTelemetry Collector. These rules internally utilize the [filter processor](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/processor/filterprocessor) to filter the data.

* 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.
* An exclude rule functions as a denylist filter, ensuring that matching data is not sent to Sumo Logic.
* An include rule functions as an allowlist filter, ensuring that only matching data is sent to Sumo Logic.

As a best practice, specify these rules to match the lesser volume of data.
As a best practice, configure these rules to filter the smaller volume of data for optimal performance:

* If you want to **collect the majority of data** from a source template, provide **exclude** rules to match (filter out) the lesser volume of data.
* If you want to **collect a small set of data** from a source template, provide **include** rules to match (filter in) the lesser volume of data.
* If you want to **collect the majority of data** from a source template, use **exclude** rules to match (filter out) the lesser volume of data.
* If you want to **collect a small set of data** from a source template, use **include** rules to match (filter in) the lesser volume of data.

For example, to include only messages coming from a Windows Event log with ID `8015`, you can add a Logs Filter to the source template and select the **Type** of the filter as "Include message that match", and can use the following filter regular expression:
For example, to include only messages from a Windows Event log with ID `8015`, you can add a Logs Filter to the source template. Select the **Type** of the filter as "Include messages that match" and use the following filter regular expression:

```
.*"id":8015.*
Expand All @@ -32,10 +27,10 @@ For example, to include only messages coming from a Windows Event log with ID `8

## Rules and limitations

When writing regular expression rules, you must follow these rules:
When creating regular expression rules, adhere to the following guidelines:

* Your rule must be [RE2 compliant](https://github.com/google/re2/wiki/Syntax).
* If your rule matches *only a section* of the log line, the full log line will be matched.
* For *single line messages*, it is not mandatory to prefix and suffix the regex expression with `.\*`.
* Exclude rules take priority over include rules. Include rules are processed first. However, if an exclude rule matches data that matched the include rule filter, the data is excluded.
* If two or more rules are listed, the assumed Boolean operator is `OR`.
- Your rule must comply with [RE2 syntax](https://github.com/google/re2/wiki/Syntax).
- If your rule matches *any part* of a log line, the entire log line will be matched.
- For *single-line messages*, it is not necessary to prefix or suffix the regex with `.*`.
- *Exclude rules* take precedence over *include rules*. Include rules are processed first, but if an exclude rule matches data that also matches the include rule, the data will be excluded.
- When multiple rules are listed, the assumed Boolean operator is `OR`.
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
Loading
Loading