Skip to content

Commit

Permalink
OTEL Install Collector for Ansible, Chef, Puppet (SumoLogic#3035)
Browse files Browse the repository at this point in the history
* OTEL Install Collector new categories

* fixes

* edit

* fixes

* Update docs/send-data/opentelemetry-collector/install-collector/linux.md

* minor edits

---------

Co-authored-by: John Pipkin (Sumo Logic) <jpipkin@sumologic.com>
  • Loading branch information
kimsauce and jpipkin1 authored Oct 4, 2023
1 parent 80b3000 commit b142927
Show file tree
Hide file tree
Showing 22 changed files with 173 additions and 58 deletions.
9 changes: 6 additions & 3 deletions cid-redirects.json
Original file line number Diff line number Diff line change
Expand Up @@ -2456,9 +2456,9 @@
"/cid/9006": "/docs/cse/ingestion/ingestion-sources-for-cloud-siem/aws-network-firewall",
"/cid/9008": "/docs/alerts/webhook-connections/new-relic",
"/cid/9010": "/docs/send-data/opentelemetry-collector",
"/cid/9011": "/docs/send-data/opentelemetry-collector/install-collector-linux",
"/cid/9012": "/docs/send-data/opentelemetry-collector/install-collector-macos",
"/cid/9013": "/docs/send-data/opentelemetry-collector/install-collector-windows",
"/cid/9011": "/docs/send-data/opentelemetry-collector/install-collector/linux",
"/cid/9012": "/docs/send-data/opentelemetry-collector/install-collector/macos",
"/cid/9013": "/docs/send-data/opentelemetry-collector/install-collector/windows",
"/cid/9014": "/docs/send-data/opentelemetry-collector/troubleshooting",
"/cid/9015": "/docs/send-data/opentelemetry-collector/sumo-logic-opentelemetry-vs-opentelemetry-upstream-relationship",
"/cid/9016": "/docs/send-data/opentelemetry-collector/data-source-configurations",
Expand Down Expand Up @@ -3774,6 +3774,9 @@
"/docs/integrations/app-development/opentelemetry/jira": "/docs/integrations/app-development/opentelemetry/jira-opentelemetry",
"/docs/integrations/pci-compliance/setup": "/docs/integrations/pci-compliance",
"/docs/logs": "/docs/search",
"/docs/send-data/opentelemetry-collector/install-collector-linux": "/docs/send-data/opentelemetry-collector/install-collector/linux",
"/docs/send-data/opentelemetry-collector/install-collector-macos": "/docs/send-data/opentelemetry-collector/install-collector/macos",
"/docs/send-data/opentelemetry-collector/install-collector-windows": "/docs/send-data/opentelemetry-collector/install-collector/windows",
"/docs/manage/security/log-search-audit-index": "/docs/manage/security/search-audit-index",
"/cid/-1": "/"
}
6 changes: 3 additions & 3 deletions docs/integrations/containers-orchestration/kafka.md
Original file line number Diff line number Diff line change
Expand Up @@ -353,9 +353,9 @@ We use the Telegraf receiver of Sumo Logic OpenTelemetry Distro [Collector](http
##### Configure Collection of Kafka Metrics and Logs
* Install sumologic-otel-collector by following the instructions for your operating system:
* [Linux](/docs/send-data/opentelemetry-collector/install-collector-linux)
* [macOS](/docs/send-data/opentelemetry-collector/install-collector-macos)
* [Windows](/docs/send-data/opentelemetry-collector/install-collector-windows)
* [Linux](/docs/send-data/opentelemetry-collector/install-collector/linux)
* [macOS](/docs/send-data/opentelemetry-collector/install-collector/macos)
* [Windows](/docs/send-data/opentelemetry-collector/install-collector/windows)
* Configure and start `sumologic-otel-collector`.
As part of collecting metrics data from Kafka, we will use the [jolokia2 input plugin](https://github.com/influxdata/telegraf/tree/master/plugins/inputs/jolokia2) for Telegraf to get data from otel and then send data to Sumo Logic.
Expand Down
6 changes: 3 additions & 3 deletions docs/integrations/databases/cassandra.md
Original file line number Diff line number Diff line change
Expand Up @@ -496,9 +496,9 @@ We use the Telegraf receiver of Sumo Logic OpenTelemetry Distro [Collector](http
#### Configure Metrics and Logs Collection
1. Install sumologic-otel-collector by following the instructions for your operating system:
* [Linux](/docs/send-data/opentelemetry-collector/install-collector-linux)
* [macOS](/docs/send-data/opentelemetry-collector/install-collector-macos)
* [Windows](/docs/send-data/opentelemetry-collector/install-collector-windows)
* [Linux](/docs/send-data/opentelemetry-collector/install-collector/linux)
* [macOS](/docs/send-data/opentelemetry-collector/install-collector/macos)
* [Windows](/docs/send-data/opentelemetry-collector/install-collector/windows)
2. Configure and start sumologic-otel-collector. As part of collecting metrics data from Cassandra, we will use the [jolokia2 input plugin](https://github.com/influxdata/telegraf/tree/master/plugins/inputs/jolokia2) for Telegraf to get data from otel and then send data to Sumo Logic. Create or modify config.yaml. Sample config is [here](https://ot-distro.s3.amazonaws.com/config_cassandra.yaml). Please enter values for the following parameters.
* Enter Sumo Logic collection details in the section; extensions > sumologic by referring to [these](https://github.com/SumoLogic/sumologic-otel-collector/tree/main/pkg/extension/sumologicextension) instructions. Configure details like collector name, category, install token, endpoint etc.
* In the input plugins section, that is `[[inputs.jolokia2_agent]]`:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ An Azure application with specific permissions is required for Sumo Logic to acc
### Create Client Secret

1. Within your Azure application setup on the **App Registration** page, click **Certificates & secrets** from the left navigation pane and then click **New client secret**. <br/> <img src={useBaseUrl('img/send-data/ms-exchange-client-secret-step-1.png')} alt="ms-exchange-client-secret-step-1.png" width="700" />
2. A right pane will slide out asking for a description and expiration for the secret. This secret is used by Sumo Logic to connect via OAuth 2.0 to establish continuous access to your Exchange Trace logs with an auto generated refresh token. <br/> <img src={useBaseUrl('img/send-data/ms-exchange-client-secret-step-2.png')} alt="ms-exchange-client-secret-step-2.png" width="550" />
2. A right pane will slide out asking for a description and expiration for the secret. This secret is used by Sumo Logic to connect via OAuth 2.0 to establish continuous access to your Exchange Trace logs with an auto-generated refresh token. <br/> <img src={useBaseUrl('img/send-data/ms-exchange-client-secret-step-2.png')} alt="ms-exchange-client-secret-step-2.png" width="550" />
3. Take note of the hidden value displayed on this page. After leaving this page, you will no longer be able to see this value from Azure. We recommend storing it in a protected password management vault. <br/> <img src={useBaseUrl('img/send-data/ms-exchange-client-secret-step-3.png')} alt="ms-exchange-client-secret-step-3.png" width="700" />

### Assign Azure Roles to Your Application
Expand Down Expand Up @@ -145,9 +145,9 @@ This API can return a 400 error code which could mean one of the following reaso
2. "Invalid request. Request is malformed or invalid". This response error can occur if other parts of the configuration are incorrect such as an invalid "Client Secret Value" or incorrect set permissions. Ensure all of the setup steps are followed and the source has the correct configuration.

:::note intermittent JSON error
When querying for the Microsoft Exchange trace log messages, Microsoft API may sporadically return a HTML webpage titled "Sign in to Outlook" instead of JSON events.
When querying for the Microsoft Exchange trace log messages, Microsoft API may sporadically return a HTML webpage titled "Sign in to Outlook" instead of JSON events.

This will force the health status of the source into an error state with the error text `invalid character '<' looking for beginning of value` as we try to JSON decode the data. The API will revert back to providing us the expected JSON events and collection will continue as there is no issue with the authentication, but it does cause the health status of the source to flip into an error state.
This will force the health status of the source into an error state with the error text `invalid character '<' looking for beginning of value` as we try to JSON decode the data. The API will revert back to providing us the expected JSON events and collection will continue as there is no issue with the authentication, but it does cause the health status of the source to flip into an error state.

Our source keeps track of a time cursor for events and will only move the time cursor forward once we have successfully received, decoded the JSON, and sent the logs into Sumo Logic before we move the time cursor forward to ensure there is no data loss. If you experience this issue, contact Microsoft support.
:::
12 changes: 6 additions & 6 deletions docs/send-data/opentelemetry-collector/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,9 @@ On Windows, the Collector installation command must be run in PowerShell.

To install the script manually on your OS, refer to one of the following docs:

* [Linux](/docs/send-data/opentelemetry-collector/install-collector-linux#manual-step-by-step-installation)
* [macOS](/docs/send-data/opentelemetry-collector/install-collector-macos#manual-step-by-step-installation)
* [Windows](/docs/send-data/opentelemetry-collector/install-collector-windows#manual-step-by-step-installation)
* [Linux](/docs/send-data/opentelemetry-collector/install-collector/linux#manual-step-by-step-installation)
* [macOS](/docs/send-data/opentelemetry-collector/install-collector/macos#manual-step-by-step-installation)
* [Windows](/docs/send-data/opentelemetry-collector/install-collector/windows#manual-step-by-step-installation)

You will need to manage configuration files on your own.

Expand Down Expand Up @@ -98,9 +98,9 @@ See [Accessing the collector's metrics](#accessing-the-collectors-metrics) secti
#### How do I uninstall the Sumo OpenTelemetry Collector?

Refer to the Uninstall section in the following docs:
* [Linux](/docs/send-data/opentelemetry-collector/install-collector-linux/#uninstall)
* [Windows](/docs/send-data/opentelemetry-collector/install-collector-windows/#uninstall)
* [macOS](/docs/send-data/opentelemetry-collector/install-collector-macos/#uninstall)
* [Linux](/docs/send-data/opentelemetry-collector/install-collector/linux/#uninstall)
* [Windows](/docs/send-data/opentelemetry-collector/install-collector/windows/#uninstall)
* [macOS](/docs/send-data/opentelemetry-collector/install-collector/macos/#uninstall)


## Data ingestion and forwarding
Expand Down
30 changes: 7 additions & 23 deletions docs/send-data/opentelemetry-collector/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,47 +14,31 @@ Once the data is collected, the Sumo Logic platform provides powerful analytics

In this section, we'll introduce the following concepts:

:::tip Quickstart
Get up and running quickly with our [OpenTelemetry Quickstart Guide](/docs/send-data/opentelemetry-collector/quickstart).
:::

<div className="box-wrapper" markdown="1">
<div className="box smallbox1 card">
<div className="container">
<a href="/docs/send-data/opentelemetry-collector/install-collector-linux"><img src={useBaseUrl('img/send-data/otel-color.svg')} alt="Thumbnail icon" width="45"/><h4>Install Collector on Linux</h4></a>
<p>Step-by-step instructions for installing the OpenTelemetry collector on Linux.</p>
<a href="/docs/send-data/opentelemetry-collector/install-collector"><img src={useBaseUrl('img/send-data/otel-color.svg')} alt="Thumbnail icon" width="25"/><h4>Install Collector</h4></a>
<p>Step-by-step instructions for installing the OpenTelemetry collector on Linux, Windows, macOS, and more.</p>
</div>
</div>
<div className="box smallbox2 card">
<div className="container">
<a href="/docs/send-data/opentelemetry-collector/install-collector-macos"><img src={useBaseUrl('img/send-data/otel-color.svg')} alt="Thumbnail icon" width="45"/><h4>Install Collector on macOS</h4></a>
<p>Step-by-step instructions for installing the OpenTelemetry collector on macOS.</p>
</div>
</div>
<div className="box smallbox3 card">
<div className="container">
<a href="/docs/send-data/opentelemetry-collector/install-collector-windows"><img src={useBaseUrl('img/send-data/otel-color.svg')} alt="Thumbnail icon" width="45"/><h4>Install Collector on Windows</h4></a>
<p>Step-by-step instructions for installing the OpenTelemetry collector on Windows.</p>
</div>
</div>
<div className="box smallbox4 card">
<div className="container">
<a href="/docs/send-data/opentelemetry-collector/data-source-configurations">
<img src={useBaseUrl('img/send-data/otel-color.svg')} alt="Thumbnail icon" width="45"/>
<img src={useBaseUrl('img/send-data/otel-color.svg')} alt="Thumbnail icon" width="25"/>
<h4>Data Source and Configurations</h4>
</a>
<p>Learn how to collect logs, metrics, and tracing data, as well as how to add configurations for the OpenTelemetry collector.</p>
</div>
</div>
<div className="box smallbox5 card">
<div className="box smallbox3 card">
<div className="container">
<a href="/docs/send-data/opentelemetry-collector/sumo-logic-opentelemetry-vs-opentelemetry-upstream-relationship"><img src={useBaseUrl('img/send-data/otel-color.svg')} alt="Thumbnail icon" width="45"/><h4>Sumo Logic OTel vs OTel</h4></a>
<a href="/docs/send-data/opentelemetry-collector/sumo-logic-opentelemetry-vs-opentelemetry-upstream-relationship"><img src={useBaseUrl('img/send-data/otel-color.svg')} alt="Thumbnail icon" width="25"/><h4>Sumo Logic OTel</h4></a>
<p>Understand the relationship between the Sumo Logic OpenTelemetry Collector and the OpenTelemetry upstream project.</p>
</div>
</div>
<div className="box smallbox6 card">
<div className="box smallbox4 card">
<div className="container">
<a href="/docs/send-data/opentelemetry-collector/troubleshooting"><img src={useBaseUrl('img/send-data/otel-color.svg')} alt="Thumbnail icon" width="45"/><h4>Troubleshooting and FAQ</h4></a>
<a href="/docs/send-data/opentelemetry-collector/troubleshooting"><img src={useBaseUrl('img/send-data/otel-color.svg')} alt="Thumbnail icon" width="25"/><h4>Troubleshooting and FAQ</h4></a>
<p>Find solutions to common issues and answers to frequently asked questions about the OpenTelemetry collector.</p>
</div>
</div>
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
id: ansible
title: Install OpenTelemetry Collector on Ansible
sidebar_label: Ansible
---

import useBaseUrl from '@docusaurus/useBaseUrl';

<img src={useBaseUrl('img/send-data/ansible-logo.png')} alt="ansible" width="40"/>

This documentation will guide you through the installation process using the software configuration management tool Ansible, enabling you to deploy and manage Sumo Logic collectors at scale.

1. In Sumo Logic, select **Manage Data** > **Collection** > **OpenTelemetry Collection**.
2. On the OpenTelemetry Collection page, click **Add Collector**.
3. On the left panel, select **Ansible**.<br/><img src={useBaseUrl('img/send-data/opentelemetry-collector/ansible.png')} alt="ansible.png" />
4. Select/create installation token and customize your tags.
5. Follow the auto-generated steps to install the collector using Ansible.
:::note
These steps are only supported on Linux Operating System.
:::
6. Once steps are completed, click **Done** to review collector on OpenTelemetry Collection page.
22 changes: 22 additions & 0 deletions docs/send-data/opentelemetry-collector/install-collector/chef.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
id: chef
title: Install OpenTelemetry Collector on Chef
sidebar_label: Chef
description: Learn how to install the Sumo Logic OpenTelemetry Collector on Chef.
---

import useBaseUrl from '@docusaurus/useBaseUrl';

<img src={useBaseUrl('img/send-data/chef-logo.png')} alt="chef" width="40"/>

This documentation will guide you through the installation process using the software configuration management tool Chef, enabling you to deploy and manage Sumo Logic collectors at scale.

1. In Sumo Logic, select **Manage Data** > **Collection** > **OpenTelemetry Collection**.
2. On the OpenTelemetry Collection page, click **Add Collector**.
3. On the left panel, select **Chef**.<br/><img src={useBaseUrl('img/send-data/opentelemetry-collector/chef.png')} alt="chef.png" />
4. Select/create installation token and customize your tags.
5. Follow auto generated steps to install the collector using Chef.
:::note
These steps are only supported on Linux Operating System.
:::
6. Once steps are completed, click **Done** to review collector on OpenTelemetry Collection page.
45 changes: 45 additions & 0 deletions docs/send-data/opentelemetry-collector/install-collector/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
---
slug: /send-data/opentelemetry-collector/install-collector
title: Install Collector
---

import useBaseUrl from '@docusaurus/useBaseUrl';

<div className="box-wrapper" markdown="1">
<div className="box smallbox1 card">
<div className="container">
<a href="/docs/send-data/opentelemetry-collector/install-collector/linux"><img src={useBaseUrl('img/integrations/hosts-operating-systems/linux-transparent.png')} alt="Thumbnail icon" width="45"/><h4>Install Collector on Linux</h4></a>
<p>Step-by-step instructions for installing the OpenTelemetry collector on Linux.</p>
</div>
</div>
<div className="box smallbox2 card">
<div className="container">
<a href="/docs/send-data/opentelemetry-collector/install-collector/macos"><img src={useBaseUrl('img/send-data/mac-logo.png')} alt="macOS" width="45"/><h4>Install Collector on macOS</h4></a>
<p>Step-by-step instructions for installing the OpenTelemetry collector on macOS.</p>
</div>
</div>
<div className="box smallbox3 card">
<div className="container">
<a href="/docs/send-data/opentelemetry-collector/install-collector/windows"><img src={useBaseUrl('img/integrations/microsoft-azure/windows.png')} alt="thumbnail icon" width="45"/><h4>Install Collector on Windows</h4></a>
<p>Step-by-step instructions for installing the OpenTelemetry collector on Windows.</p>
</div>
</div>
<div className="box smallbox4 card">
<div className="container">
<a href="/docs/send-data/opentelemetry-collector/install-collector/ansible"><img src={useBaseUrl('img/send-data/ansible-logo.png')} alt="ansible" width="40"/> <h4>Install Collector on Ansible</h4></a>
<p>Step-by-step instructions for installing the OpenTelemetry collector on Ansible.</p>
</div>
</div>
<div className="box smallbox5 card">
<div className="container">
<a href="/docs/send-data/opentelemetry-collector/install-collector/chef"><img src={useBaseUrl('img/send-data/chef-logo.png')} alt="chef" width="40"/><h4>Install Collector on Chef</h4></a>
<p>Step-by-step instructions for installing the OpenTelemetry collector on Chef.</p>
</div>
</div>
<div className="box smallbox6 card">
<div className="container">
<a href="/docs/send-data/opentelemetry-collector/install-collector/puppet"><img src={useBaseUrl('img/integrations/app-development/puppet.png')} alt="puppet icon" width="40"/><h4>Install Collector on Puppet</h4></a>
<p>Step-by-step instructions for installing the OpenTelemetry collector on Puppet.</p>
</div>
</div>
</div>
Original file line number Diff line number Diff line change
@@ -1,14 +1,16 @@
---
id: install-collector-linux
title: Installing Collector on Linux
sidebar_label: Install Collector on Linux
description: Learn how to install the Sumo Logic OpenTelemetry Collector.
id: linux
title: Install OpenTelemetry Collector on Linux
sidebar_label: Linux
description: Learn how to install the Sumo Logic OpenTelemetry Collector on Linux.
---

import useBaseUrl from '@docusaurus/useBaseUrl';
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

<img src={useBaseUrl('img/integrations/hosts-operating-systems/linux-transparent.png')} alt="Thumbnail icon" width="35"/>

Follow the steps in this topic to install or uninstall an OpenTelemetry Collector on Linux. See [OpenTelemetry Collector](/docs/send-data/opentelemetry-collector) for information on other operating systems.

## System Requirements​
Expand Down
Original file line number Diff line number Diff line change
@@ -1,14 +1,16 @@
---
id: install-collector-macos
title: Installing Collector on macOS
sidebar_label: Install Collector on macOS
id: macos
title: Install OpenTelemetry Collector on macOS
sidebar_label: macOS
description: Learn how to install the Sumo Logic OpenTelemetry Collector on macOS.
---

import useBaseUrl from '@docusaurus/useBaseUrl';
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

<img src={useBaseUrl('img/send-data/mac-logo.png')} alt="macOS" width="30"/>

Follow the steps in this topic to install or uninstall an OpenTelemetry Collector on macOS. See [OpenTelemetry Collector](/docs/send-data/opentelemetry-collector) for information on other operating systems.

## System Requirements​
Expand Down
Loading

0 comments on commit b142927

Please sign in to comment.