Skip to content

Commit 6147568

Browse files
adding form screenshot, made few updates
1 parent 7677a81 commit 6147568

File tree

1 file changed

+9
-15
lines changed

1 file changed

+9
-15
lines changed

docs/integrations/hosts-operating-systems/opentelemetry/opentelemetry-collector-insights.md

Lines changed: 9 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,7 @@ The Sumo Logic OpenTelemetry Collector Insights app provides comprehensive monit
1515

1616
This app supports OpenTelemetry Collector version **0.130.1-sumo-0** and later versions.
1717

18-
We use the OpenTelemetry collector's built-in internal telemetry capabilities to collect metrics and logs about the collector itself. By default, the Collector exposes its own telemetry through internal metrics (via Prometheus interface on port 8888) and logs (emitted to stderr).
19-
20-
The diagram below illustrates the components of the OpenTelemetry Collector self-monitoring setup. The collector is configured to export its own telemetry data (metrics and logs) to Sumo Logic through OTLP/HTTP endpoints.
18+
We use the OpenTelemetry collector's built-in internal telemetry capabilities to collect metrics and logs about the collector itself. By default, the Collector exposes its own telemetry through internal metrics (via Prometheus interface on port 8888) and logs (emitted to stderr). The collector can also be configured to export its own telemetry data (metrics and logs) to Sumo Logic through OTLP/HTTP endpoints.
2119

2220
:::info
2321
This app includes [built-in monitors](#opentelemetry-collector-insights-alerts). For details on creating custom monitors, refer to [Create monitors for OpenTelemetry Collector Insights app](#create-monitors-for-opentelemetry-collector-insights-app).
@@ -37,14 +35,9 @@ Following are the [fields](/docs/manage/fields/) which will be created as part o
3735

3836
Before configuring the OTEL Collector integration, ensure you have the following prerequisites in place:
3937

40-
1. **OTLP Endpoint**: You need a valid base OTLP endpoint URL. The system will automatically append `/v1/logs` for logs collection and `/v1/metrics` for metrics collection. The endpoint should be accessible from your OTEL Collector instance.
41-
42-
2. **Network Access**: Ensure that your OTEL Collector has network access to the configured OTLP endpoint. This includes:
43-
- Outbound HTTPS connectivity on port 443
44-
- Proper firewall configurations to allow traffic to the endpoint
45-
- DNS resolution for the endpoint hostname
38+
1. **Sumo Logic OTLP Source**: You need to create an OTLP source in your Sumo Logic hosted collector. The OTLP source will provide the endpoint URL that the OTEL Collector will use to send telemetry data.
4639

47-
3. **Authentication**: If your OTLP endpoint requires authentication, ensure you have the proper credentials or tokens configured.
40+
**Documentation**: [Creating a Sumo Logic OTLP Source](https://help.sumologic.com/docs/send-data/hosted-collectors/http-source/otlp/)
4841

4942
### For metrics collection
5043

@@ -85,21 +78,20 @@ import SetupColl from '../../../reuse/apps/opentelemetry/set-up-collector.md';
8578

8679
### Step 2: Configure integration
8780

81+
OpenTelemetry works with a [configuration](https://opentelemetry.io/docs/collector/configuration/) YAML file with all the details concerning the data that needs to be collected.
82+
8883
In this step, you will configure the OpenTelemetry Collector's built-in telemetry to monitor itself.
8984

9085
The collector's service configuration needs to be updated to enable telemetry export. Below is the required configuration that should be added to your collector's service section:
9186

9287
**Required Inputs:**
93-
- **OTLP Endpoint**: Your Sumo Logic OTLP endpoint base URL
94-
- **Deployment Environment**: Enter a name to identify your deployment environment
88+
- **OTLP Endpoint**: Your Sumo Logic OTLP endpoint URL
9589

9690
**Configuration Parameters:**
9791
- **Endpoint Format**: The base endpoint automatically creates:
9892
- Logs endpoint: `${OTLP_ENDPOINT}/v1/logs`
9993
- Metrics endpoint: `${OTLP_ENDPOINT}/v1/metrics`
100-
- **Protocol**: HTTP/protobuf for OTLP communication
101-
- **Metrics level**: Set to **detailed** for comprehensive monitoring
102-
- **Logs level**: Set to **debug** for detailed troubleshooting information
94+
10395

10496
```yaml
10597
service:
@@ -134,6 +126,8 @@ import EnvVar from '../../../reuse/apps/opentelemetry/env-var-required.md';
134126
135127
<EnvVar/>
136128
129+
<img src='https://sumologic-app-data-v2.s3.us-east-1.amazonaws.com/dashboards/OpenTelemetry-Collector-Insights/opentelemetry-collector-insights-configure-form.png' style={{border:'1px solid gray'}} alt="YAML" />
130+
137131
### Step 3: Send logs and metrics to Sumo Logic
138132
139133
import LogsIntro from '../../../reuse/apps/opentelemetry/send-logs-intro.md';

0 commit comments

Comments
 (0)