Skip to content

Commit 250fc07

Browse files
kimsaucekimsauce
committed
OTEL Remote Management GA
1 parent 3fce183 commit 250fc07

File tree

9 files changed

+230
-223
lines changed

9 files changed

+230
-223
lines changed

‎docs/send-data/opentelemetry-collector/remote-management/index.md‎

Lines changed: 16 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -6,57 +6,21 @@ sidebar_label: Remote Management
66

77
import useBaseUrl from '@docusaurus/useBaseUrl';
88

9-
<head>
10-
<meta name="robots" content="noindex" />
11-
</head>
12-
13-
<p><a href="/docs/beta"><span className="beta">Beta</span></a></p>
14-
15-
This feature is in Beta. To participate, contact your Sumo Logic account executive.
16-
179
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.
1810

19-
## Remote Management features
20-
21-
### Collector tags
22-
23-
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.
24-
25-
### Source templates
26-
27-
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.
28-
29-
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.
30-
31-
## How it works
32-
33-
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.
34-
35-
### Step 1: Install collectors
36-
37-
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.
38-
39-
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**.
40-
1. Click **Add Collector**.
41-
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"/>
42-
1. Enter your **Installation Token**.
43-
1. Under **Tag data on Collector level**, add a new tag, `“application = Apache”`.
44-
1. Leave the **Collector Settings** at their default values.
45-
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"/>
46-
1. After installation is complete, click **Next** to proceed.
47-
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.
48-
49-
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**).
50-
51-
### Step 2: Configure data collection
52-
53-
Next, you'll create a data collection configuration to gather Apache error logs and link it to all collectors tagged `"application = Apache"`.
54-
55-
1. Complete the Source Template form with the **Name** and **File Path** for your error logs, then click **Next**.
56-
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"/>
57-
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"/>
58-
1. Click **Next** to complete Source Template creation. The system will apply the configuration to all linked collectors and start collecting Apache error logs.
59-
60-
### Step 3: Monitor logs
61-
62-
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.
11+
In this section, we'll introduce the following concepts:
12+
13+
<div className="box-wrapper" >
14+
<div className="box smallbox card">
15+
<div className="container">
16+
<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>
17+
<p>Use Sumo Logic processing rules for an OTel agent with an OTel remote management (OTRM) source template.</p>
18+
</div>
19+
</div>
20+
<div className="box smallbox card">
21+
<div className="container">
22+
<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>
23+
<p>Sumo Logic OTRM source templates.</p>
24+
</div>
25+
</div>
26+
</div>

‎docs/send-data/opentelemetry-collector/remote-management/overview.md‎

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
---
2+
id: overview
3+
title: OpenTelemetry Remote Management Overview
4+
sidebar_label: Overview
5+
---
6+
7+
import useBaseUrl from '@docusaurus/useBaseUrl';
8+
9+
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.
10+
11+
## Remote Management features
12+
13+
### Collector tags
14+
15+
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.
16+
17+
### Source templates
18+
19+
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.
20+
21+
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.
22+
23+
## How it works
24+
25+
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.
26+
27+
### Step 1: Install collectors
28+
29+
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.
30+
31+
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**.
32+
1. Click **Add Collector**.
33+
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"/>
34+
1. Enter your **Installation Token**.
35+
1. Under **Tag data on Collector level**, add a new tag, `“application = Apache”`.
36+
1. Leave the **Collector Settings** at their default values.
37+
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"/>
38+
1. After installation is complete, click **Next** to proceed.
39+
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.
40+
41+
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**).
42+
43+
### Step 2: Configure data collection
44+
45+
Next, you'll create a data collection configuration to gather Apache error logs and link it to all collectors tagged `"application = Apache"`.
46+
47+
1. Complete the Source Template form with the **Name** and **File Path** for your error logs, then click **Next**.
48+
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"/>
49+
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"/>
50+
1. Click **Next** to complete Source Template creation. The system will apply the configuration to all linked collectors and start collecting Apache error logs.
51+
52+
### Step 3: Monitor logs
53+
54+
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.

‎docs/send-data/opentelemetry-collector/remote-management/processing-rules/include-and-exclude-rules.md‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
id: include-and-exclude-rules
3-
title: Include and Exclude Rules for OpenTelemetry (Beta)
3+
title: Include and Exclude Rules for OpenTelemetry
4+
sidebar_label: Include and Exclude Rules
45
description: Use include and exclude processing rules to specify what kind of data is sent to Sumo Logic using OpenTelemetry Collector.
56
---
67

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

1314
import useBaseUrl from '@docusaurus/useBaseUrl';
1415

15-
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.
16+
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.
1617

1718
* An exclude rule functions as a denylist filter where the matching data is not sent to Sumo Logic.
1819
* An include rule functions as an allowlist filter where only matching data is sent to Sumo Logic.

‎docs/send-data/opentelemetry-collector/remote-management/processing-rules/index.md‎

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,8 @@
11
---
22
slug: /send-data/opentelemetry-collector/remote-management/processing-rules
3-
title: Processing Rules for OpenTelemetry (Beta)
3+
title: Processing Rules for OpenTelemetry
44
description: Use Sumo Logic processing rules for an OpenTelemetry agent with an OpenTelemetry remote management (OTRM) source template.
55
---
6-
<head>
7-
<meta name="robots" content="noindex" />
8-
</head>
9-
10-
<p><a href="/docs/beta"><span className="beta">Beta</span></a></p>
116

127
import useBaseUrl from '@docusaurus/useBaseUrl';
138

‎docs/send-data/opentelemetry-collector/remote-management/processing-rules/mask-rules-windows.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
id: mask-rules-windows
3-
title: Mask Rules for Windows Source Template (Beta)
3+
title: Mask Rules for the Windows Source Template
44
sidebar_label: Mask Rules for Windows
55
description: Create a mask rule to replace an expression with a mask string.
66
---
@@ -142,7 +142,7 @@ Using the above masking options would provide the following result:
142142
}
143143
```
144144

145-
:::note
145+
:::note
146146
- 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:
147147
- $ must be escaped as $$ to bypass environment variable substitution logic.
148148
- To input a literal $, use $$$.

‎docs/send-data/opentelemetry-collector/remote-management/processing-rules/mask-rules.md‎

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
id: mask-rules
3-
title: Mask Rules (Beta)
4-
sidebar_label: Mask Rules
3+
title: Mask Rules
54
description: Create a mask rule to replace an expression with a mask string.
65
---
76
<head>
@@ -56,8 +55,8 @@ Using the masking string `auth=User:AAA` would provide the following result:
5655
```
5756
"auth"\s*:\s*"Basic\s*[^"]+"
5857
```
59-
60-
If the masking string given here is `"auth":"#####"`, then the log output will be:
58+
59+
If the masking string given here is `"auth":"#####"`, then the log output will be:
6160
6261
```
6362
{
@@ -82,7 +81,7 @@ Using the masking string `auth=User:AAA` would provide the following result:
8281
auth=User\:(.*(?s).*session=.*?)\]
8382
```
8483
85-
:::note
84+
:::note
8685
- 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:
8786
- $ must be escaped as $$ to bypass environment variable substitution logic.
8887
- To input a literal $, use $$$.

‎docs/send-data/opentelemetry-collector/remote-management/processing-rules/metrics-include-and-exclude-rules.md‎

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
id: metrics-include-and-exclude-rules
3-
title: Metrics Include and Exclude Rules for OpenTelemetry (Beta)
3+
title: Metrics Include and Exclude Rules for OpenTelemetry
4+
sidebar_label: Metrics Include and Exclude Rules
45
description: You can use metrics processing rules to specify what metrics are sent to Sumo Logic using OpenTelemetry Collector.
56
---
67
<head>
@@ -11,7 +12,7 @@ description: You can use metrics processing rules to specify what metrics are se
1112

1213
import useBaseUrl from '@docusaurus/useBaseUrl';
1314

14-
You can use include and exclude processing rules to specify what metrics 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 metrics filtered.
15+
You can use include and exclude processing rules to specify what metrics 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 metrics filtered.
1516

1617
* An exclude rule functions as a denylist filter where all data is sent except matching data to Sumo Logic.
1718
* An include rule functions as an allowlist filter where only matching data is sent to Sumo Logic.
@@ -23,32 +24,32 @@ As a best practice, specify these rules to match the lesser volume of data.
2324

2425
## Metric filter examples
2526

26-
For filtering metrics data in source template you can add a metrics filter to the source template. You can then provide the name of the filter followed by **Type** (filter to include or exclude) and **Filter by**.
27+
For filtering metrics data in source template you can add a metrics filter to the source template. You can then provide the name of the filter followed by **Type** (filter to include or exclude) and **Filter by**.
2728

28-
There are three ways to use metrics filter in source template:
29+
There are three ways to use metrics filter in source template:
2930
* Filter by metrics name
3031
* Filter by dimension
3132
* Filter by metrics name and dimension
3233

3334
### Filter by metrics name
3435

35-
If you need to filter by name of the metrics, then you can select this option and provide the regex which matched with the metric name.
36+
If you need to filter by name of the metrics, then you can select this option and provide the regex which matched with the metric name.
3637

37-
For example when collecting host metrics, if you need to collect only network metrics, then you can give `network` in the metric name.
38+
For example when collecting host metrics, if you need to collect only network metrics, then you can give `network` in the metric name.
3839

3940
<img src={useBaseUrl('img/send-data/opentelemetry-collector/processingrule-include-metricname.png')} alt="collector-installation-completion-page" style={{border:'1px solid gray'}} width="700" />
4041

4142
### Filter by dimension
4243

43-
If you need to filter by dimension of the metrics, then you can select this option and provide the list of keys and values in the dimension table. Key needs to be the exact dimension name and value can be a regex which matches against the value for the key given. All of these key value pairs will have the `AND` condition between them.
44+
If you need to filter by dimension of the metrics, then you can select this option and provide the list of keys and values in the dimension table. Key needs to be the exact dimension name and value can be a regex which matches against the value for the key given. All of these key value pairs will have the `AND` condition between them.
4445

4546
For example, when collecting host metrics you can filter CPU metrics data for a specific CPU (say `cpu0`), and you can mention the respective key value pair in the dimension table.
4647

4748
<img src={useBaseUrl('img/send-data/opentelemetry-collector/processingrule-include-metricdimension.png')} alt="collector-installation-completion-page" style={{border:'1px solid gray'}} width="700" />
4849

4950
### Filter by metrics name and dimension
5051

51-
If you need to filter by metrics name and dimension, then you can select this option and provide the metric name regex and dimension key and value. Key needs to be the exact dimension name and value can be a regex which matches against the value for the key given. All inputs here (that is, metric name) and all key value pairs will have the `AND` condition between them.
52+
If you need to filter by metrics name and dimension, then you can select this option and provide the metric name regex and dimension key and value. Key needs to be the exact dimension name and value can be a regex which matches against the value for the key given. All inputs here (that is, metric name) and all key value pairs will have the `AND` condition between them.
5253

5354
For example, when collecting host metrics, you can filter network metrics for a specific device and direction by giving metric name regex as `network`, and in the dimension table key value pair you can specify `device=lo` and `direction=transmit`.
5455

‎docs/send-data/opentelemetry-collector/remote-management/source-templates/index.md‎

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,6 @@ title: Source Templates
55

66
import useBaseUrl from '@docusaurus/useBaseUrl';
77

8-
<head>
9-
<meta name="robots" content="noindex" />
10-
</head>
11-
12-
<p><a href="/docs/beta"><span className="beta">Beta</span></a></p>
13-
14-
This feature is in Beta. To participate, contact your Sumo Logic account executive.
15-
168
Source templates in Sumo Logic provide efficient, scalable data collection management by applying consistent setups across multiple collectors. They reduce redundancy and simplify configuration, making it easier to manage and scale your data collection efforts.
179

1810
## Benefits

0 commit comments

Comments
 (0)