-
Notifications
You must be signed in to change notification settings - Fork 224
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
Changes from 30 commits
Commits
Show all changes
50 commits
Select commit
Hold shift + click to select a range
250fc07
OTEL Remote Management GA
kimsauce d8b8694
release note
kimsauce 916f9ab
Edits to release note & doc
kimsauce 217f338
Processing rule edits
kimsauce 1e10216
Update docs/send-data/opentelemetry-collector/remote-management/proce…
kimsauce 461bfdb
edits
kimsauce 8d20963
Update docs/send-data/opentelemetry-collector/remote-management/proce…
kimsauce dc38a22
Merge branch 'main' into DOCS-146
kimsauce 8446b69
Update docs/send-data/opentelemetry-collector/remote-management/overv…
kimsauce 149b288
Update docs/send-data/opentelemetry-collector/remote-management/overv…
kimsauce 11cbc2e
Merge branch 'main' into DOCS-146
kimsauce 2e68bd4
More edits
kimsauce 2972ab2
Update docs/send-data/opentelemetry-collector/remote-management/index.md
kimsauce 78fcfa9
Update docs/send-data/opentelemetry-collector/remote-management/proce…
kimsauce 4d72f2e
more edits
kimsauce 60f5725
Merge branch 'DOCS-146' of github.com:SumoLogic/sumologic-documentati…
kimsauce 2442b5c
Update docs/send-data/opentelemetry-collector/remote-management/remot…
kimsauce 21d9174
Update docs/send-data/opentelemetry-collector/remote-management/remot…
kimsauce 7428120
edits for consistency
kimsauce 472cb48
Merge branch 'DOCS-146' of github.com:SumoLogic/sumologic-documentati…
kimsauce ad9d382
Update macos.md
kimsauce 7a412dd
Update linux.md
kimsauce eab6871
Update windows.md
kimsauce 880cc91
Update linux.md
kimsauce 0346beb
Update macos.md
kimsauce 43bd518
Update puppet.md
kimsauce c7ec414
Update windows.md
kimsauce 527295c
last edits
kimsauce af9e447
link fix
kimsauce 054318c
link fix
kimsauce 45dee38
Update blog-service/2025-01-06-otel-remote-management.md
kimsauce 667c2c5
Add/Edit/Delete collector tag info added (#4841)
JV0812 19aac0c
Merge branch 'main' into DOCS-146
kimsauce fdd5d81
Merge branch 'main' into DOCS-146
kimsauce 4685e14
Updates
kimsauce c56917d
Merge branch 'DOCS-146' of github.com:SumoLogic/sumologic-documentati…
kimsauce 8c17b81
broken anchor
kimsauce 7717ec9
links
kimsauce 9b2ffa3
Update docs/send-data/opentelemetry-collector/remote-management/sourc…
kimsauce dfaac11
Merge branch 'main' into DOCS-146
kimsauce 142d1d1
Merge branch 'main' into DOCS-146
kimsauce 463f794
swap screenshots
kimsauce f15c8af
Merge branch 'main' into DOCS-146
kimsauce d8a5df2
Consolidating docs
kimsauce 26f7ee7
last edits
kimsauce 571e051
link fix
kimsauce 4a4452b
links
kimsauce 1c076f6
Merge branch 'main' into DOCS-146
kimsauce 56776c9
last fixes
kimsauce dab3877
Merge branch 'DOCS-146' of github.com:SumoLogic/sumologic-documentati…
kimsauce File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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). |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,9 +1,9 @@ | ||
import useBaseUrl from '@docusaurus/useBaseUrl'; | ||
|
||
In this step, we'll create a data collection configuration and link them to all the collectors that have particular tags. | ||
1. Complete the Source Template form by providing the necessary details, then click **Next**. | ||
1. On the **Link Collectors** step, you will have the option to link the collectors using the Collector name or by adding tags to find the group of collectors. For our scenario, we will add the tag `application = Apache`.<br/><img src={useBaseUrl('img/send-data/local-file-apache.png')} alt="local-file-apache" style={{border: '1px solid gray'}} width="300"/> | ||
|
||
1. Complete the source template form by providing the necessary details, then click **Next**. | ||
1. On the **Link Collectors** step, you will have the option to link the collectors using the Collector name or by adding tags to find the group of collectors. In this Apache example, we will add the tag `application = Apache`.<br/><img src={useBaseUrl('img/send-data/local-file-apache.png')} alt="local-file-apache" style={{border: '1px solid gray'}} 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 grey'}} width="800"/> | ||
kimsauce marked this conversation as resolved.
Show resolved
Hide resolved
|
||
1. Click **Next** to complete the Source Template creation. In the background, the system will apply the configuration to all the linked collectors and will start collecting the respective telemetry data from the remote host. | ||
1. Click the **Log Search** or **Metric Search** icon to search for data collected for this Source Template. | ||
1. Click **Next** to complete the source template creation. In the background, the system will apply the configuration to all the linked collectors and will start collecting the respective telemetry data from the remote host. | ||
1. Click the **Log Search** or **Metric Search** icon to search for data collected for this source template. |
70 changes: 17 additions & 53 deletions
70
docs/send-data/opentelemetry-collector/remote-management/index.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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: OpenTelemetry Collector Remote Management | ||
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/source-templates"><img src={useBaseUrl('img/send-data/otel-color.svg')} alt="OTel thumbnail icon" width="25"/><h4>Source Templates</h4></a> | ||
<p>Simplify OpenTelemetry Collector remote management data ingestion using source templates.</p> | ||
</div> | ||
</div> | ||
<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 processing rules for an OpenTelemetry agent with Sumo Logic OpenTelemetry remote management source templates.</p> | ||
</div> | ||
</div> | ||
</div> |
71 changes: 71 additions & 0 deletions
71
docs/send-data/opentelemetry-collector/remote-management/overview.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,71 @@ | ||
--- | ||
id: overview | ||
title: OpenTelemetry Collector 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 (for example, 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" style={{border: '1px solid gray'}} 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. |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.