You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/send-data/opentelemetry-collector/remote-management/overview.md
+17-22Lines changed: 17 additions & 22 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,33 +8,32 @@ import useBaseUrl from '@docusaurus/useBaseUrl';
8
8
9
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
10
11
-
## Key benefits of Remote Management
11
+
## Key benefits of remote management
12
12
13
-
* Simplified setup and configuration via the Sumo Logic UI.
14
-
* Tag-based collector grouping for efficient data collection.
15
-
* Centralized configuration using [Source Templates](/docs/send-data/opentelemetry-collector/remote-management/source-templates).
16
-
* No server access required after installation.
17
-
* Faster time to value and reduced manual errors.
13
+
* Simplified setup and configuration via the Sumo Logic UI
14
+
* Tag-based collector grouping for efficient data collection
15
+
* Centralized configuration using [source templates](/docs/send-data/opentelemetry-collector/remote-management/source-templates)
16
+
* No server access required after installation
17
+
* Faster time to value and reduced manual errors
18
18
19
19
## Common use cases
20
20
21
-
* Monitoring error logs across multiple Apache servers.
22
-
* Grouping collectors by environment (for example, production, staging).
23
-
* Expanding data collection for new services with minimal effort.
24
-
* Simplifying migration from legacy monitoring solutions.
21
+
* Monitoring error logs across multiple Apache servers
22
+
* Grouping collectors by environment (for example, production, staging)
23
+
* Expanding data collection for new services with minimal effort
24
+
* Simplifying migration from legacy monitoring solutions
25
25
26
-
27
-
## Remote Management features
26
+
## Remote management features
28
27
29
28
### Collector tags
30
29
31
30
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.
32
31
33
32
### Source templates
34
33
35
-
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.
34
+
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.
36
35
37
-
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.
36
+
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.
38
37
39
38
## How it works
40
39
@@ -52,7 +51,7 @@ First, you'll need to install the OpenTelemetry collectors on each of the 50 ser
52
51
1. Leave the **Collector Settings** at their default values.
53
52
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"/>
54
53
1. After installation is complete, click **Next** to proceed.
55
-
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.
54
+
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.
56
55
57
56
To revisit this screen later, navigate to:
58
57
*[**Classic UI**](/docs/get-started/sumo-logic-ui-classic): In the main Sumo Logic menu, select **Manage Data > Collection > Source Template**.
@@ -62,15 +61,11 @@ To revisit this screen later, navigate to:
62
61
63
62
Next, you'll create a data collection configuration to gather Apache error logs and link it to all collectors tagged `"application = Apache"`.
64
63
65
-
1. Complete the Source Template form with the **Name** and **File Path** for your error logs, then click **Next**.
64
+
1. Complete the source template form with the **Name** and **File Path** for your error logs, then click **Next**.
66
65
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" style={{border: '1px solid gray'}} width="300"/>
67
-
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"/>
68
-
1. Click **Next** to complete Source Template creation. The system will apply the configuration to all linked collectors and start collecting Apache error logs.
66
+
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"/>
67
+
1. Click **Next** to complete source template creation. The system will apply the configuration to all linked collectors and start collecting Apache error logs.
69
68
70
69
### Step 3: Monitor logs
71
70
72
71
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.
73
-
74
-
## Try it now
75
-
76
-
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).
description: Use Sumo Logic processing rules for an OpenTelemetry agent with an OpenTelemetry remote management (OTRM) source template.
3
+
title: Processing Rules for OpenTelemetry Remote Managment
4
+
description: Use Sumo Logic processing rules for an OpenTelemetry agent with an OpenTelemetry remote management source template.
5
5
---
6
6
7
7
import useBaseUrl from '@docusaurus/useBaseUrl';
8
8
9
-
Processing rules can be used with OpenTelemetry Collector for different source templates in OTRM (OpenTelemetry remote management). These processing rules can filter and can mask the data sent to Sumo Logic from OpenTelemetry Collector which is remotely managed by Sumo Logic. The rules affect only the data sent to Sumo Logic; logs and metrics on your end remain intact and unchanged. Data filtered by OpenTelemetry Collector using processing rules does not count towards your daily data volume quota.
10
-
11
-
Processing rules for logs collection support the following rule types:
12
-
13
-
*[Exclude messages that match](include-and-exclude-rules.md). Remove messages that you do not want to send to Sumo Logic at all ("denylist" filter). These messages are skipped by OpenTelemetry Collector and are not uploaded to Sumo Logic.
14
-
*[Include messages that match](include-and-exclude-rules.md). Send only the data you'd like in your Sumo Logic account (an "allowlist" filter). This type of rule can be useful, for example, if you only want to include messages coming from a firewall.
15
-
*[Mask messages that match](mask-rules.md). Replace an expression with a mask string that you can customize. This is another way to your protect data, such as passwords, that you do not normally track.
16
-
17
-
18
-
Processing Rules for metrics collection support the following rule types:
19
-
20
-
*[Exclude metrics that match](metrics-include-and-exclude-rules.md). Remove metrics that you do not want to send to Sumo Logic at all ("denylist" filter).
21
-
*[Include metrics that match](metrics-include-and-exclude-rules.md). Send only selected metrics to your Sumo Logic account (an "allowlist" filter).
22
-
23
-
## Limitations
24
-
25
-
* Regular expressions must be [RE2 compliant](https://github.com/google/re2/wiki/Syntax).
26
-
* Processing Rules are tested with maximum of 20 rules.
27
-
28
-
## How do processing rules work together?
29
-
30
-
You can create one or more processing rules for a Source Template, combining the different types of filters to generate the exact data set you want sent to Sumo Logic.
31
-
32
-
When a Source has multiple rules they are processed in the following order: includes, excludes, masks.
33
-
34
-
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.
35
-
36
-
## Guide contents
9
+
Use our OpenTelemetry Collector remote management (OTRM) source template processing rules to filter and mask data sent to Sumo Logic from OpenTelemetry Collector. The collector itself is remotely managed by Sumo Logic.
37
10
38
11
In this section, we'll introduce the following concepts:
39
12
40
13
<divclassName="box-wrapper" >
41
14
<divclassName="box smallbox card">
42
15
<divclassName="container">
43
-
<ahref="/docs/send-data/opentelemetry-collector/remote-management/processing-rules/include-and-exclude-rules"><img src={useBaseUrl('img/icons/operations/rules.png')} alt="icon" width="40"/><h4>Include and Exclude Rules for OpenTelemetry </h4></a>
44
-
<p>Use include and exclude processing rules to specify what kind of data is sent to Sumo Logic using OpenTelemetry Collector.</p>
16
+
<ahref="/docs/send-data/opentelemetry-collector/remote-management/processing-rules/include-and-exclude-rules"><img src={useBaseUrl('img/icons/operations/rules.png')} alt="icon" width="40"/><h4>OTRM Include and Exclude Rules</h4></a>
17
+
<p>Use OTRM include and exclude processing rules to specify which data you want to send to Sumo Logic.</p>
18
+
</div>
19
+
</div>
20
+
<divclassName="box smallbox card">
21
+
<divclassName="container">
22
+
<ahref="/docs/send-data/opentelemetry-collector/remote-management/processing-rules/metrics-include-and-exclude-rules"><img src={useBaseUrl('img/icons/operations/rules.png')} alt="icon" width="40"/><h4>OTRM Metrics Include and Exclude Rules</h4></a>
23
+
<p>Use OTRM metrics processing rules to specify which metrics data you want to send to Sumo Logic.</p>
<p>Create an OTRM mask rule to replace an expression with a mask string.</p>
45
30
</div>
46
31
</div>
47
32
<divclassName="box smallbox card">
48
33
<divclassName="container">
49
-
<ahref="/docs/send-data/opentelemetry-collector/remote-management/processing-rules/metrics-include-and-exclude-rules"><img src={useBaseUrl('img/icons/operations/rules.png')} alt="icon" width="40"/><h4>Metrics Include and Exclude Rules for OpenTelemetry</h4></a>
50
-
<p>Use metrics processing rules to specify what metrics are sent to Sumo Logic using OpenTelemetry Collector.</p>
34
+
<ahref="/docs/send-data/opentelemetry-collector/remote-management/processing-rules/mask-rules-windows"><img src={useBaseUrl('img/icons/operations/rules.png')} alt="icon" width="40"/><h4>OTRM Windows Source Template Mask Rules</h4></a>
35
+
<p>Create an OTRM Windows source template mask rule to replace an expression with a mask string.</p>
Copy file name to clipboardExpand all lines: docs/send-data/opentelemetry-collector/remote-management/processing-rules/metrics-include-and-exclude-rules.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,8 +1,8 @@
1
1
---
2
2
id: metrics-include-and-exclude-rules
3
-
title: Metrics Include and Exclude Rules for OpenTelemetry
3
+
title: OpenTelemetry Remote Management Metrics Include and Exclude Rules
4
4
sidebar_label: Metrics Include and Exclude Rules
5
-
description: You can use metrics processing rules to specify what metrics are sent to Sumo Logic using OpenTelemetry Collector.
5
+
description: You can use metrics processing rules to specify what metrics are sent to Sumo Logic using OpenTelemetry remote management.
Processing rules affect only the data sent to Sumo Logic; logs and metrics on your end remain intact and unchanged. Data filtered by OpenTelemetry Collector using processing rules will not count towards your daily data volume quota.
10
+
11
+
## Logs collection
12
+
13
+
Processing rules for logs collection support the following rule types:
14
+
15
+
*[Exclude messages that match](include-and-exclude-rules.md). Remove messages that you do not want to send to Sumo Logic at all ("denylist" filter). These messages are skipped by OpenTelemetry Collector and are not uploaded to Sumo Logic.
16
+
*[Include messages that match](include-and-exclude-rules.md). Send only the data you'd like in your Sumo Logic account (an "allowlist" filter). This type of rule can be useful, for example, if you only want to include messages coming from a firewall.
17
+
*[Mask messages that match](mask-rules.md). Replace an expression with a mask string that you can customize. This is another way to your protect data, such as passwords, that you do not normally track.
18
+
19
+
## Metrics collection
20
+
21
+
Processing rules for metrics collection support the following rule types:
22
+
23
+
*[Exclude metrics that match](metrics-include-and-exclude-rules.md). Remove metrics that you do not want to send to Sumo Logic at all ("denylist" filter).
24
+
*[Include metrics that match](metrics-include-and-exclude-rules.md). Send only selected metrics to your Sumo Logic account (an "allowlist" filter).
25
+
26
+
## How do processing rules work together?
27
+
28
+
You can create one or more processing rules for a source template, combining the different types of filters to generate the exact data set you want sent to Sumo Logic.
29
+
30
+
When a Source has multiple rules they are processed in the following order: includes, excludes, masks.
31
+
32
+
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.
33
+
34
+
## Limitations
35
+
36
+
* Regular expressions must be [RE2 compliant](https://github.com/google/re2/wiki/Syntax).
37
+
* Processing rules are tested with maximum of 20 rules.
@@ -40,7 +42,7 @@ Utilize collector tags for grouping collectors, and associate source templates t
40
42
41
43
Follow the below steps to install the collector and add uniquely identifiable tags:
42
44
43
-
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**.
45
+
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**.
44
46
1. On the **OpenTelemetry Collection** page, click **Add Collector**.
45
47
1. In the **Set up Collector** step, select **Linux** as the platform.<br/><img src={useBaseUrl('img/send-data/linux-install.png')} alt="linux-install" style={{border: '1px solid gray'}} width="800"/>
46
48
1. Enter your **Installation Token**.
@@ -75,8 +77,8 @@ To edit a source template:
75
77
1. In the main Sumo Logic menu, select **Manage Data > Collection > Source Template**.
76
78
1. Select the Source Template that you need to edit, and click **Edit**. Or, click the kebab menu against the selected source template and click **Edit** from the dropdown.
77
79
1. Change the required configuration in the source template configuration page, and click **Next**.
78
-
1. If required, update the collectors on the **Link Collectors** page.
79
-
1. Click **Next** to complete editing the source template.
80
+
1. If required, update the collectors on the **Link Collectors** page.
81
+
1. Click **Next** to complete editing the source template.
0 commit comments