From 250fc0759911f416e8e24ad4831a24fb894e8209 Mon Sep 17 00:00:00 2001 From: Kim Pohas Date: Thu, 12 Dec 2024 18:45:34 -0800 Subject: [PATCH 1/3] OTEL Remote Management GA --- .../remote-management/index.md | 68 +---- .../remote-management/overview.md | 54 ++++ .../include-and-exclude-rules.md | 5 +- .../processing-rules/index.md | 7 +- .../processing-rules/mask-rules-windows.md | 4 +- .../processing-rules/mask-rules.md | 9 +- .../metrics-include-and-exclude-rules.md | 17 +- .../source-templates/index.md | 8 - sidebars.ts | 281 +++++++++--------- 9 files changed, 230 insertions(+), 223 deletions(-) create mode 100644 docs/send-data/opentelemetry-collector/remote-management/overview.md diff --git a/docs/send-data/opentelemetry-collector/remote-management/index.md b/docs/send-data/opentelemetry-collector/remote-management/index.md index 5505637e43..9a5a6c60c9 100644 --- a/docs/send-data/opentelemetry-collector/remote-management/index.md +++ b/docs/send-data/opentelemetry-collector/remote-management/index.md @@ -6,57 +6,21 @@ sidebar_label: Remote Management import useBaseUrl from '@docusaurus/useBaseUrl'; - - - - -

Beta

- -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**.
[**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.
linux-install -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.
linux-terminal-installation -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"`.
local-file-apache -1. Click **Preview Collector(s)** to see the list of collectors that will be linked to the newly created Source Template.
link-collectors -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: + +
+
+
+ OTel thumbnail icon

Processing Rules

 +

Use Sumo Logic processing rules for an OTel agent with an OTel remote management (OTRM) source template.

+
+
+
+
+ OTel thumbnail icon

Source Templates

 +

Sumo Logic OTRM source templates.

+
+
+
diff --git a/docs/send-data/opentelemetry-collector/remote-management/overview.md b/docs/send-data/opentelemetry-collector/remote-management/overview.md new file mode 100644 index 0000000000..f9cd1290ce --- /dev/null +++ b/docs/send-data/opentelemetry-collector/remote-management/overview.md @@ -0,0 +1,54 @@ +--- +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. + +## 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**.
[**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.
linux-install +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.
linux-terminal-installation +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"`.
local-file-apache +1. Click **Preview Collector(s)** to see the list of collectors that will be linked to the newly created Source Template.
link-collectors +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. diff --git a/docs/send-data/opentelemetry-collector/remote-management/processing-rules/include-and-exclude-rules.md b/docs/send-data/opentelemetry-collector/remote-management/processing-rules/include-and-exclude-rules.md index 1693bafc2d..fd1d38c72e 100644 --- a/docs/send-data/opentelemetry-collector/remote-management/processing-rules/include-and-exclude-rules.md +++ b/docs/send-data/opentelemetry-collector/remote-management/processing-rules/include-and-exclude-rules.md @@ -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. --- @@ -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. diff --git a/docs/send-data/opentelemetry-collector/remote-management/processing-rules/index.md b/docs/send-data/opentelemetry-collector/remote-management/processing-rules/index.md index 6cc6375788..26517c42c0 100644 --- a/docs/send-data/opentelemetry-collector/remote-management/processing-rules/index.md +++ b/docs/send-data/opentelemetry-collector/remote-management/processing-rules/index.md @@ -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. --- - - - - -

Beta

import useBaseUrl from '@docusaurus/useBaseUrl'; diff --git a/docs/send-data/opentelemetry-collector/remote-management/processing-rules/mask-rules-windows.md b/docs/send-data/opentelemetry-collector/remote-management/processing-rules/mask-rules-windows.md index f65d060163..b802640626 100644 --- a/docs/send-data/opentelemetry-collector/remote-management/processing-rules/mask-rules-windows.md +++ b/docs/send-data/opentelemetry-collector/remote-management/processing-rules/mask-rules-windows.md @@ -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. --- @@ -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 $$$. diff --git a/docs/send-data/opentelemetry-collector/remote-management/processing-rules/mask-rules.md b/docs/send-data/opentelemetry-collector/remote-management/processing-rules/mask-rules.md index d3d6b53544..de526291c6 100644 --- a/docs/send-data/opentelemetry-collector/remote-management/processing-rules/mask-rules.md +++ b/docs/send-data/opentelemetry-collector/remote-management/processing-rules/mask-rules.md @@ -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. --- @@ -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: ``` { @@ -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 $$$. diff --git a/docs/send-data/opentelemetry-collector/remote-management/processing-rules/metrics-include-and-exclude-rules.md b/docs/send-data/opentelemetry-collector/remote-management/processing-rules/metrics-include-and-exclude-rules.md index 8ddfd4f46f..e4e567fa56 100644 --- a/docs/send-data/opentelemetry-collector/remote-management/processing-rules/metrics-include-and-exclude-rules.md +++ b/docs/send-data/opentelemetry-collector/remote-management/processing-rules/metrics-include-and-exclude-rules.md @@ -1,6 +1,7 @@ --- id: metrics-include-and-exclude-rules -title: Metrics Include and Exclude Rules for OpenTelemetry (Beta) +title: Metrics Include and Exclude Rules for OpenTelemetry +sidebar_label: Metrics Include and Exclude Rules description: You can use metrics processing rules to specify what metrics are sent to Sumo Logic using OpenTelemetry Collector. --- @@ -11,7 +12,7 @@ description: You can use metrics processing rules to specify what metrics are se import useBaseUrl from '@docusaurus/useBaseUrl'; -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. +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. * An exclude rule functions as a denylist filter where all data is sent except matching data to Sumo Logic. * An include rule functions as an allowlist filter where only matching data is sent to Sumo Logic. @@ -23,24 +24,24 @@ As a best practice, specify these rules to match the lesser volume of data. ## Metric filter examples -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**. +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**. -There are three ways to use metrics filter in source template: +There are three ways to use metrics filter in source template: * Filter by metrics name * Filter by dimension * Filter by metrics name and dimension ### Filter by metrics name -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. +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. -For example when collecting host metrics, if you need to collect only network metrics, then you can give `network` in the metric name. +For example when collecting host metrics, if you need to collect only network metrics, then you can give `network` in the metric name. collector-installation-completion-page ### Filter by dimension -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. +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. 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. @@ -48,7 +49,7 @@ For example, when collecting host metrics you can filter CPU metrics data for a ### Filter by metrics name and dimension -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. +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. 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`. diff --git a/docs/send-data/opentelemetry-collector/remote-management/source-templates/index.md b/docs/send-data/opentelemetry-collector/remote-management/source-templates/index.md index 6e168d4b4e..d357afed01 100644 --- a/docs/send-data/opentelemetry-collector/remote-management/source-templates/index.md +++ b/docs/send-data/opentelemetry-collector/remote-management/source-templates/index.md @@ -5,14 +5,6 @@ title: Source Templates import useBaseUrl from '@docusaurus/useBaseUrl'; - - - - -

Beta

- -This feature is in Beta. To participate, contact your Sumo Logic account executive. - 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. ## Benefits diff --git a/sidebars.ts b/sidebars.ts index 7e2d71086e..5199c900ec 100644 --- a/sidebars.ts +++ b/sidebars.ts @@ -118,146 +118,147 @@ module.exports = { 'send-data/opentelemetry-collector/data-source-configurations/additional-configurations-reference', ] }, -// { -// type: 'category', -// label: 'Remote Management', -// collapsible: true, -// collapsed: true, -// link: {type: 'doc', id: 'send-data/opentelemetry-collector/remote-management/index'}, -// items:[ -// { -// type: 'category', -// label: 'Processing Rules', -// collapsible: true, -// collapsed: true, -// link: {type: 'doc', id: 'send-data/opentelemetry-collector/remote-management/processing-rules/index'}, -// items:[ -// 'send-data/opentelemetry-collector/remote-management/processing-rules/include-and-exclude-rules', -// 'send-data/opentelemetry-collector/remote-management/processing-rules/metrics-include-and-exclude-rules', -// 'send-data/opentelemetry-collector/remote-management/processing-rules/mask-rules', -// ], -// }, -// { -// type: 'category', -// label: 'Source Templates', -// collapsible: true, -// collapsed: true, -// link: {type: 'doc', id: 'send-data/opentelemetry-collector/remote-management/source-templates/index'}, -// items:[ -// { -// type: 'category', -// label: 'Apache', -// collapsible: true, -// collapsed: true, -// link: {type: 'doc', id: 'send-data/opentelemetry-collector/remote-management/source-templates/apache/index'}, -// items:[ -// 'send-data/opentelemetry-collector/remote-management/source-templates/apache/changelog', -// ] -// }, -// { -// type: 'category', -// label: 'Docker', -// collapsible: true, -// collapsed: true, -// link: {type: 'doc', id: 'send-data/opentelemetry-collector/remote-management/source-templates/docker/index'}, -// items:[ -// 'send-data/opentelemetry-collector/remote-management/source-templates/docker/changelog', -// ] -// }, -// { -// type: 'category', -// label: 'Kafka', -// collapsible: true, -// collapsed: true, -// link: {type: 'doc', id: 'send-data/opentelemetry-collector/remote-management/source-templates/kafka/index'}, -// items:[ -// 'send-data/opentelemetry-collector/remote-management/source-templates/kafka/changelog', -// ] -// }, -// { -// type: 'category', -// label: 'Linux', -// collapsible: true, -// collapsed: true, -// link: {type: 'doc', id: 'send-data/opentelemetry-collector/remote-management/source-templates/linux/index'}, -// items:[ -// 'send-data/opentelemetry-collector/remote-management/source-templates/linux/changelog', -// ] -// }, -// { -// type: 'category', -// label: 'Localfile', -// collapsible: true, -// collapsed: true, -// link: {type: 'doc', id: 'send-data/opentelemetry-collector/remote-management/source-templates/localfile/index'}, -// items:[ -// 'send-data/opentelemetry-collector/remote-management/source-templates/localfile/changelog', -// ] -// }, -// { -// type: 'category', -// label: 'Mac', -// collapsible: true, -// collapsed: true, -// link: {type: 'doc', id: 'send-data/opentelemetry-collector/remote-management/source-templates/mac/index'}, -// items:[ -// 'send-data/opentelemetry-collector/remote-management/source-templates/mac/changelog', -// ] -// }, -// { -// type: 'category', -// label: 'Nginx', -// collapsible: true, -// collapsed: true, -// link: {type: 'doc', id: 'send-data/opentelemetry-collector/remote-management/source-templates/nginx/index'}, -// items:[ -// 'send-data/opentelemetry-collector/remote-management/source-templates/nginx/changelog', -// ] -// }, -// { -// type: 'category', -// label: 'RabbitMQ', -// collapsible: true, -// collapsed: true, -// link: {type: 'doc', id: 'send-data/opentelemetry-collector/remote-management/source-templates/rabbitmq/index'}, -// items:[ -// 'send-data/opentelemetry-collector/remote-management/source-templates/rabbitmq/changelog', -// ] -// }, -// { -// type: 'category', -// label: 'Redis', -// collapsible: true, -// collapsed: true, -// link: {type: 'doc', id: 'send-data/opentelemetry-collector/remote-management/source-templates/redis/index'}, -// items:[ -// 'send-data/opentelemetry-collector/remote-management/source-templates/redis/changelog', -// ] -// }, -// { -// type: 'category', -// label: 'Syslog', -// collapsible: true, -// collapsed: true, -// link: {type: 'doc', id: 'send-data/opentelemetry-collector/remote-management/source-templates/syslog/index'}, -// items:[ -// 'send-data/opentelemetry-collector/remote-management/source-templates/syslog/changelog', -// ] -// }, -// { -// type: 'category', -// label: 'Windows', -// collapsible: true, -// collapsed: true, -// link: {type: 'doc', id: 'send-data/opentelemetry-collector/remote-management/source-templates/windows/index'}, -// items:[ -// 'send-data/opentelemetry-collector/remote-management/source-templates/windows/changelog', -// ] -// }, -// ], -// }, -// ], -// }, + { + type: 'category', + label: 'Remote Management', + collapsible: true, + collapsed: true, + link: {type: 'doc', id: 'send-data/opentelemetry-collector/remote-management/index'}, + items:[ + 'send-data/opentelemetry-collector/remote-management/overview', + { + type: 'category', + label: 'Processing Rules', + collapsible: true, + collapsed: true, + link: {type: 'doc', id: 'send-data/opentelemetry-collector/remote-management/processing-rules/index'}, + items:[ + 'send-data/opentelemetry-collector/remote-management/processing-rules/include-and-exclude-rules', + 'send-data/opentelemetry-collector/remote-management/processing-rules/metrics-include-and-exclude-rules', + 'send-data/opentelemetry-collector/remote-management/processing-rules/mask-rules', + ], + }, + { + type: 'category', + label: 'Source Templates', + collapsible: true, + collapsed: true, + link: {type: 'doc', id: 'send-data/opentelemetry-collector/remote-management/source-templates/index'}, + items:[ + { + type: 'category', + label: 'Apache', + collapsible: true, + collapsed: true, + link: {type: 'doc', id: 'send-data/opentelemetry-collector/remote-management/source-templates/apache/index'}, + items:[ + 'send-data/opentelemetry-collector/remote-management/source-templates/apache/changelog', + ] + }, + { + type: 'category', + label: 'Docker', + collapsible: true, + collapsed: true, + link: {type: 'doc', id: 'send-data/opentelemetry-collector/remote-management/source-templates/docker/index'}, + items:[ + 'send-data/opentelemetry-collector/remote-management/source-templates/docker/changelog', + ] + }, + { + type: 'category', + label: 'Kafka', + collapsible: true, + collapsed: true, + link: {type: 'doc', id: 'send-data/opentelemetry-collector/remote-management/source-templates/kafka/index'}, + items:[ + 'send-data/opentelemetry-collector/remote-management/source-templates/kafka/changelog', + ] + }, + { + type: 'category', + label: 'Linux', + collapsible: true, + collapsed: true, + link: {type: 'doc', id: 'send-data/opentelemetry-collector/remote-management/source-templates/linux/index'}, + items:[ + 'send-data/opentelemetry-collector/remote-management/source-templates/linux/changelog', + ] + }, + { + type: 'category', + label: 'Localfile', + collapsible: true, + collapsed: true, + link: {type: 'doc', id: 'send-data/opentelemetry-collector/remote-management/source-templates/localfile/index'}, + items:[ + 'send-data/opentelemetry-collector/remote-management/source-templates/localfile/changelog', + ] + }, + { + type: 'category', + label: 'Mac', + collapsible: true, + collapsed: true, + link: {type: 'doc', id: 'send-data/opentelemetry-collector/remote-management/source-templates/mac/index'}, + items:[ + 'send-data/opentelemetry-collector/remote-management/source-templates/mac/changelog', + ] + }, + { + type: 'category', + label: 'Nginx', + collapsible: true, + collapsed: true, + link: {type: 'doc', id: 'send-data/opentelemetry-collector/remote-management/source-templates/nginx/index'}, + items:[ + 'send-data/opentelemetry-collector/remote-management/source-templates/nginx/changelog', + ] + }, + { + type: 'category', + label: 'RabbitMQ', + collapsible: true, + collapsed: true, + link: {type: 'doc', id: 'send-data/opentelemetry-collector/remote-management/source-templates/rabbitmq/index'}, + items:[ + 'send-data/opentelemetry-collector/remote-management/source-templates/rabbitmq/changelog', + ] + }, + { + type: 'category', + label: 'Redis', + collapsible: true, + collapsed: true, + link: {type: 'doc', id: 'send-data/opentelemetry-collector/remote-management/source-templates/redis/index'}, + items:[ + 'send-data/opentelemetry-collector/remote-management/source-templates/redis/changelog', + ] + }, + { + type: 'category', + label: 'Syslog', + collapsible: true, + collapsed: true, + link: {type: 'doc', id: 'send-data/opentelemetry-collector/remote-management/source-templates/syslog/index'}, + items:[ + 'send-data/opentelemetry-collector/remote-management/source-templates/syslog/changelog', + ] + }, + { + type: 'category', + label: 'Windows', + collapsible: true, + collapsed: true, + link: {type: 'doc', id: 'send-data/opentelemetry-collector/remote-management/source-templates/windows/index'}, + items:[ + 'send-data/opentelemetry-collector/remote-management/source-templates/windows/changelog', + ] + }, + ], + }, + ], + }, 'send-data/opentelemetry-collector/auto-discovery', 'send-data/opentelemetry-collector/performance-benchmarks', 'send-data/opentelemetry-collector/data-transformations', From d8b8694dece76267e3ca7acd1e91d19e4a778d58 Mon Sep 17 00:00:00 2001 From: Kim Pohas Date: Thu, 12 Dec 2024 18:48:05 -0800 Subject: [PATCH 2/3] release note --- .../2025-01-06-otel-remote-management.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) create mode 100644 blog-service/2025-01-06-otel-remote-management.md diff --git a/blog-service/2025-01-06-otel-remote-management.md b/blog-service/2025-01-06-otel-remote-management.md new file mode 100644 index 0000000000..84fa949e31 --- /dev/null +++ b/blog-service/2025-01-06-otel-remote-management.md @@ -0,0 +1,16 @@ +--- +title: OpenTelemetry Collector Remote Management (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'; + +icon + +We're excited to announce the release of.... From 916f9ab4b684db812b51f0e51a6079b5ecb963d4 Mon Sep 17 00:00:00 2001 From: Kim Pohas Date: Sun, 15 Dec 2024 02:30:59 -0800 Subject: [PATCH 3/3] Edits to release note & doc --- .../2025-01-06-otel-remote-management.md | 11 ++++-- .../remote-management/index.md | 2 +- .../remote-management/overview.md | 34 +++++++++++++++---- 3 files changed, 38 insertions(+), 9 deletions(-) diff --git a/blog-service/2025-01-06-otel-remote-management.md b/blog-service/2025-01-06-otel-remote-management.md index 84fa949e31..689569b6e5 100644 --- a/blog-service/2025-01-06-otel-remote-management.md +++ b/blog-service/2025-01-06-otel-remote-management.md @@ -1,5 +1,5 @@ --- -title: OpenTelemetry Collector Remote Management (Collection) +title: Remote Management for OpenTelemetry Collector (Collection) image: https://help.sumologic.com/img/sumo-square.png keywords: - collection @@ -13,4 +13,11 @@ import useBaseUrl from '@docusaurus/useBaseUrl'; icon -We're excited to announce the release of.... +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). diff --git a/docs/send-data/opentelemetry-collector/remote-management/index.md b/docs/send-data/opentelemetry-collector/remote-management/index.md index 9a5a6c60c9..a3675e775c 100644 --- a/docs/send-data/opentelemetry-collector/remote-management/index.md +++ b/docs/send-data/opentelemetry-collector/remote-management/index.md @@ -1,6 +1,6 @@ --- slug: /send-data/opentelemetry-collector/remote-management -title: OpenTelemetry Remote Management +title: Remote Management for OpenTelemetry Collector sidebar_label: Remote Management --- diff --git a/docs/send-data/opentelemetry-collector/remote-management/overview.md b/docs/send-data/opentelemetry-collector/remote-management/overview.md index f9cd1290ce..025e33648c 100644 --- a/docs/send-data/opentelemetry-collector/remote-management/overview.md +++ b/docs/send-data/opentelemetry-collector/remote-management/overview.md @@ -8,6 +8,22 @@ 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 @@ -30,25 +46,31 @@ First, you'll need to install the OpenTelemetry collectors on each of the 50 ser 1. [**Classic UI**](/docs/get-started/sumo-logic-ui-classic). In the main Sumo Logic menu, select **Manage Data > Collection > OpenTelemetry Collection**.
[**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.
linux-install +1. In the **Set up Collector** step, choose **Linux** as the platform.
Screenshot showing the Linux installation options for the collector 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.
linux-terminal-installation +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.
Screenshot showing the terminal command to install the collector 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**). +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"`.
local-file-apache -1. Click **Preview Collector(s)** to see the list of collectors that will be linked to the newly created Source Template.
link-collectors +1. Under **Link Collectors**, add the tag `"application = Apache"`.
Screenshot of the file path configuration for Apache logs +1. Click **Preview Collector(s)** to see the list of collectors that will be linked to the newly created Source Template.
Screenshot showing the linked collectors preview 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. +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).