Skip to content

Commit 4d72f2e

Browse files
committed
more edits
1 parent 2e68bd4 commit 4d72f2e

File tree

25 files changed

+123
-111
lines changed

25 files changed

+123
-111
lines changed

docs/reuse/apps/opentelemetry/collector-installation.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ import useBaseUrl from '@docusaurus/useBaseUrl';
22

33
In this step, we will install the collector and add a uniquely identifiable tag to these collectors.
44

5-
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**.
5+
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**.
66
1. On the **OpenTelemetry Collection** page, click **Add Collector**.
77
1. Select the platform of the remote host in the **Set up Collector** section.<br/><img src={useBaseUrl('img/send-data/linux-install.png')} alt="Linux-install" style={{border: '1px solid gray'}} width="800"/>
88
1. Enter your **Installation Token**.
@@ -13,5 +13,5 @@ In this step, we will install the collector and add a uniquely identifiable tag
1313
1. On the next screen, you will see a list of available Source Templates.
1414

1515
:::note
16-
If you close this Source template creation screen, 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**. <br/>[**New UI**](/docs/get-started/sumo-logic-ui). In the Sumo Logic top menu select **Configuration**, and then under **Data Collection** select **Source Template**. You can also click the **Go To...** menu at the top of the screen and select **Source Template**.
16+
If you close this source template creation screen, 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**. <br/>[**New UI**](/docs/get-started/sumo-logic-ui). In the Sumo Logic top menu select **Configuration**, and then under **Data Collection** select **Source Template**. You can also click the **Go To...** menu at the top of the screen and select **Source Template**.
1717
:::
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
import useBaseUrl from '@docusaurus/useBaseUrl';
22

33
In this step, we'll create a data collection configuration and link them to all the collectors that have particular tags.
4-
4+
55
1. Complete the Source Template form by providing the necessary details, then click **Next**.
6-
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"/>
6+
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 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"/>
77
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"/>
88
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.
99
1. Click the **Log Search** or **Metric Search** icon to search for data collected for this Source Template.

docs/send-data/installed-collectors/linux.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ description: Install or uninstall a Collector on a Linux system.
77

88
Follow the steps in this topic to install or uninstall a collector on Linux. See [Installed Collectors](/docs/send-data/installed-collectors/sources) for information on other OSs.
99

10-
## System Requirements 
10+
## System requirements 
1111

1212
* Linux, major distributions 64-bit, or any generic Unix capable of running Java 1.8
1313
* Single core, 512MB RAM

docs/send-data/installed-collectors/macos.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ description: Install or uninstall a Collector on a macOS system.
77

88
Follow the steps in this topic to install or uninstall a Collector on macOS. See [Installed Collectors](/docs/send-data/installed-collectors) for information on other OSs.
99

10-
## System Requirements
10+
## System requirements
1111

1212
* macOS 10.X
1313
* Single core, 512MB RAM

docs/send-data/installed-collectors/windows.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ description: Install or uninstall a Collector on a Windows system.
88

99
Follow the steps in this topic to install or uninstall a collector on Windows. See [Installed Collectors](/docs/send-data/installed-collectors/sources) for information on other OSs.
1010

11-
## System Requirements
11+
## System requirements
1212

1313
* Windows 7, 32 or 64 bit
1414
* Windows 8, 32 or 64 bit

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

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ import TabItem from '@theme/TabItem';
1313

1414
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.
1515

16-
## System Requirements
16+
## System requirements
1717

1818
The Sumo Logic OpenTelemetry Collector is supported on both amd64 and arm64 architectures.
1919

@@ -22,7 +22,7 @@ Minimal resource requirements are the following:
2222
* 200 MB of disk space
2323
* 64 MB of RAM
2424

25-
Supported Versions
25+
Supported versions:
2626

2727
* RHEL (7-9), Debian (9-11), Ubuntu (18-22), SUSE (ES12, ES15), Amazon Linux 2(AL2), Amazon Linux 2023(AL2023), CentOS (7, 8)
2828

@@ -34,27 +34,27 @@ You can install our OpenTelemetry Collector using one of the following methods:
3434
* [Install script](#install-script)
3535
* [Manual step-by-step installation](#manual-step-by-step-installation)
3636

37-
### UI Installation
37+
### UI installation
3838

39-
1. [**Classic UI**](/docs/get-started/sumo-logic-ui-classic). In the main Sumo Logic menu, select **Manage Data > Collection > OpenTelemetry Collection**. <br/>[**New UI**](/docs/get-started/sumo-logic-ui). In the Sumo Logic top menu select **Configuration**, and then under **Data Collection** select **OpenTelemetry Collection**. You can also click the **Go To...** menu at the top of the screen and select **OpenTelemetry Collection**.
39+
1. [**Classic UI**](/docs/get-started/sumo-logic-ui-classic). In the main Sumo Logic menu, select **Manage Data > Collection > OpenTelemetry Collection**. <br/>[**New UI**](/docs/get-started/sumo-logic-ui). In the Sumo Logic top menu select **Configuration**, and then under **Data Collection** select **OpenTelemetry Collection**. You can also click the **Go To...** menu at the top of the screen and select **OpenTelemetry Collection**.
4040
1. On the OpenTelemetry Collection page, click **Add Collector**.
4141
1. On the left panel, select **Linux** as the platform.<br/> <img src={useBaseUrl('img/send-data/opentelemetry-collector/linux-terminal.png')} alt="linux-terminal" style={{border: '1px solid gray'}} width="900"/>
4242
1. Select/create installation token and customize your tags.
4343
1. (Optional) Select the **Auto Configure Host and Process metrics data collection** checkbox to collect host and process metrics.
4444
1. Copy the command and execute it in your system terminal where the collector needs to be installed.<br/> <img src={useBaseUrl('img/send-data/opentelemetry-collector/linux-terminal-installation.png')} alt="execute command in terminal" width="900"/>
4545
1. Wait for the installation process to complete, then click **Next** to proceed.
4646

47-
### Install Script
47+
### Install script
4848

49-
#### 1. Get the Installation token
49+
#### Step 1: Get the installation token
5050

5151
Get your [installation token](/docs/manage/security/installation-tokens) if you do not have it already and assign it to an environment variable:
5252

5353
```bash
5454
export SUMOLOGIC_INSTALLATION_TOKEN=<TOKEN>
5555
```
5656

57-
#### 2. Run the Installation script
57+
#### Step 2: Run the installation script
5858

5959
You can run the script in two ways:
6060

@@ -80,7 +80,7 @@ This will perform the following operations:
8080
* Enable `otelcol-sumo` service
8181
* Start `otelcol-sumo` service
8282

83-
#### 3. Script Options
83+
#### Step 3: Add script options
8484

8585
The following arguments can be passed to the script:
8686

@@ -99,15 +99,15 @@ The following arguments can be passed to the script:
9999
| `--purge` | `p` | It has to be used with `--uninstall`. It removes all Sumo Logic Distribution for OpenTelemetry Collector related configuration and data. | No |
100100
| `--help` | `h` | Prints help and usage. |
101101

102-
The following env variables can be used along with script:
102+
The following env variables can be used along with your script:
103103

104104
| name | description |
105105
|:-------------------|:-----------------|
106106
| `SUMOLOGIC_INSTALLATION_TOKEN` | Installation token |
107107

108-
### Manual step-by-step Installation
108+
### Manual step-by-step installation
109109

110-
#### Step 1. Download the Binary
110+
#### Step 1: Download the binary
111111

112112
Examples for OpenTelemetry Collector version `0.94.0-sumo-2`.
113113

@@ -137,7 +137,7 @@ curl -sLo otelcol-sumo \
137137
</TabItem>
138138
</Tabs>
139139

140-
#### Step 2. Move the binary to your `PATH` environment
140+
#### Step 2: Move the binary to your `PATH` environment
141141

142142
Move the downloaded binary into a directory from your `PATH` environment, so that it can be used by simply invoking `otelcol-sumo`.
143143

@@ -146,15 +146,15 @@ chmod +x otelcol-sumo
146146
sudo mv otelcol-sumo /usr/local/bin/otelcol-sumo
147147
```
148148

149-
#### Step 3. Verify the Installation
149+
#### Step 3: Verify the installation
150150

151151
To verify installation, run the OpenTelemetry Collector.
152152

153153
```bash
154154
otelcol-sumo --version
155155
```
156156

157-
#### Step 4. Run OpenTelemetry Collector as Systemd Service
157+
#### Step 4; Run OpenTelemetry Collector as systemd service
158158

159159
We recommend using the [installation script](#install-script) as it supports the Systemd scenario. This section describes how to install it manually.
160160

@@ -231,7 +231,7 @@ To run OpenTelemetry Collector as Systemd Service, follow the steps below:
231231
sudo journalctl -u otelcol-sumo # checks logs
232232
```
233233

234-
#### Using Environmental variable to store Installation token
234+
#### Using Environmental variable to store installation token
235235

236236
We recommend keeping the install token in environmental variable for `Systemd` installation:
237237

@@ -265,19 +265,19 @@ We recommend keeping the install token in environmental variable for `Systemd` i
265265
sudo systemctl restart otelcol-sumo
266266
```
267267

268-
#### Running Binary Manually
268+
#### Running binary manually
269269

270270
If your system does not support `Systemd`, or you do not want to create a service, you can run Collector manually.
271271

272272
```bash
273273
sudo otelcol-sumo --config=/etc/otelcol-sumo/sumologic.yaml --config "glob:/etc/otelcol-sumo/conf.d/*.yaml"
274274
```
275275

276-
### Additional Settings
276+
### Additional settings
277277

278278
This section describes common OpenTelemetry customizations.
279279

280-
#### Using Proxy
280+
#### Using proxy
281281

282282
Exporters leverage the HTTP communication and respect the following proxy environment variables:
283283

@@ -326,7 +326,7 @@ Refer to [BoringCrypto and FIPS compliance](https://github.com/SumoLogic/sumolog
326326

327327
The recommended way to uninstall the OpenTelemetry Collector depends on how you installed it.
328328

329-
### Install Script
329+
### Install script
330330

331331
If you installed the Collector with the install script, you can this command to uninstall the Collector:
332332

@@ -354,7 +354,7 @@ sudo rm /usr/local/bin/otelcol-sumo
354354

355355
First, you have to upgrade the Collector's version. The way you should do it, depends on how you installed it.
356356

357-
#### Install Script
357+
#### Install script
358358

359359
Running install script will simply upgrade collector to the latest version:
360360

@@ -366,14 +366,14 @@ curl -Ls https://github.com/SumoLogic/sumologic-otel-collector-packaging/release
366366
You need to restart collector process manually in order to apply changes.
367367
:::
368368

369-
#### Manual step-by-step Installation
369+
#### Manual step-by-step installation
370370

371371
If you installed the Collector manually, the simplest way to upgrade is to follow these steps:
372372

373373
* [Uninstall the Collector manually](#manual-step-by-step-installation-1)
374374
* [Install the Collector again with a new version](#manual-step-by-step-installation)
375375

376-
### Update your Config
376+
### Update your config
377377

378378
After an upgrade, you should make sure that your config for OpenTelemetry Collector is up to date.
379379

docs/send-data/opentelemetry-collector/install-collector/macos.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ import TabItem from '@theme/TabItem';
1313

1414
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.
1515

16-
## System Requirements
16+
## System requirements
1717

1818
The Sumo Logic OpenTelemetry Collector is supported on both amd64 and arm64 architectures.
1919

@@ -34,7 +34,7 @@ You can install our OpenTelemetry Collector using one of the following methods:
3434
* [Install script](#install-script)
3535
* [Manual step-by-step installation](#manual-step-by-step-installation)
3636

37-
### UI Installation
37+
### UI installation
3838

3939
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**.
4040
1. On the OpenTelemetry Collection page, click **Add Collector**.
@@ -44,7 +44,7 @@ You can install our OpenTelemetry Collector using one of the following methods:
4444
1. Copy the command and execute it in your system terminal where the collector needs to be installed.<br/><img src={useBaseUrl('img/send-data/opentelemetry-collector/macos-terminal.png')} alt="execute command in terminal" />
4545
1. Wait for the installation process to complete, then click **Next** to proceed.
4646

47-
### Install Script
47+
### Install script
4848

4949
#### Get the Installation token
5050

@@ -97,7 +97,7 @@ The following arguments can be passed to the script:
9797
| `--purge` | `p` | It has to be used with `--uninstall`. It removes all Sumo Logic Distribution for OpenTelemetry Collector related configuration and data. | No |
9898
| `--help` | `h` | Prints help and usage. | No |
9999

100-
The following env variables can be used along with script:
100+
The following env variables can be used along with your script:
101101

102102
| name | description |
103103
|:-------------------------------|:-------------------|

docs/send-data/opentelemetry-collector/install-collector/puppet.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,12 @@ import useBaseUrl from '@docusaurus/useBaseUrl';
1111

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

14-
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**.
14+
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**.
1515
2. On the OpenTelemetry Collection page, click **Add Collector**.
1616
3. On the left panel, select **Puppet**.<br/><img src={useBaseUrl('img/send-data/opentelemetry-collector/puppet.png')} alt="puppet.png" />
1717
4. Select/create installation token and customize your tags.
1818
5. Follow the auto-generated steps to install the collector using Puppet.
1919
:::note
20-
These steps are only supported on Linux Operating System.
20+
These steps are only supported on the Linux Operating System.
2121
:::
2222
6. Once steps are completed, click **Done** to review collector on OpenTelemetry Collection page.

0 commit comments

Comments
 (0)