Skip to content

Commit afe751a

Browse files
Implementing more feedbacks
1 parent b5c07a4 commit afe751a

File tree

1 file changed

+6
-31
lines changed

1 file changed

+6
-31
lines changed

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

Lines changed: 6 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,6 @@ This app supports OpenTelemetry Collector version `0.130.1-sumo-0` and later ver
1717

1818
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.
1919

20-
:::info
21-
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).
22-
:::
23-
2420
## Fields creation in Sumo Logic for OpenTelemetry Collector Insights
2521

2622
Following are the [fields](/docs/manage/fields/) which will be created as part of OpenTelemetry Collector Insights app installation, if not already present.
@@ -50,8 +46,8 @@ The OpenTelemetry Collector must be configured to export its own metrics using t
5046
### For logs collection
5147

5248
The OpenTelemetry Collector must be configured to export its own logs using the built-in telemetry capabilities. This requires:
53-
- Collector configured with telemetry logs enabled at `debug` level
54-
- JSON encoding for structured log output
49+
- Collector configured with telemetry logs enabled at `debug` level (automatically configured in the provided template)
50+
- JSON encoding for structured log output (automatically configured in the provided template)
5551
- Access to OTLP endpoint for logs export
5652

5753
### System Requirements
@@ -60,9 +56,6 @@ The OpenTelemetry Collector must be configured to export its own logs using the
6056
- Sufficient system resources (CPU, memory) for data processing
6157
- Proper permissions for the collector service to access configured resources
6258

63-
import LogsCollectionPrereqisites from '../../../reuse/apps/logs-collection-prereqisites.md';
64-
65-
<LogsCollectionPrereqisites/>
6659

6760
## Collection configuration and app installation
6861

@@ -82,16 +75,10 @@ OpenTelemetry works with a [configuration](https://opentelemetry.io/docs/collect
8275

8376
In this step, you will configure the OpenTelemetry Collector's built-in telemetry to monitor itself.
8477

85-
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:
78+
Below are the inputs required:
8679

87-
**Required Inputs:**
8880
- **OTLP Endpoint**: Your Sumo Logic OTLP endpoint URL.
8981

90-
**Configuration Parameters:**
91-
- **Endpoint Format**. The base endpoint automatically creates:
92-
- Logs endpoint: `${OTLP_ENDPOINT}/v1/logs`
93-
- Metrics endpoint: `${OTLP_ENDPOINT}/v1/metrics`
94-
9582

9683
```yaml
9784
service:
@@ -265,21 +252,7 @@ After installation, verify that:
265252

266253
## Key Internal Metrics
267254

268-
The OpenTelemetry Collector emits comprehensive internal metrics categorized by verbosity levels:
269-
270-
### Basic Level Metrics (Essential service telemetry)
271-
- **Process metrics**: `otelcol_process_uptime`, `otelcol_process_cpu_seconds`, `otelcol_process_memory_rss`
272-
- **Receiver metrics**: `otelcol_receiver_accepted_*`, `otelcol_receiver_refused_*`
273-
- **Processor metrics**: `otelcol_processor_incoming_items`, `otelcol_processor_outgoing_items`
274-
- **Exporter metrics**: `otelcol_exporter_sent_*`, `otelcol_exporter_send_failed_*`, `otelcol_exporter_enqueue_failed_*`
275-
- **Queue metrics**: `otelcol_exporter_queue_size`, `otelcol_exporter_queue_capacity`
276-
277-
### Normal Level Metrics (Standard indicators)
278-
- **Batch processor metrics**: `otelcol_processor_batch_batch_send_size`, `otelcol_processor_batch_timeout_trigger_send`
279-
280-
### Detailed Level Metrics (Most verbose)
281-
- **HTTP metrics**: `http.client.request.duration`, `http.server.request.duration`, `http.*.request.body.size`
282-
- **RPC metrics**: `rpc.client.duration`, `rpc.server.duration`, `rpc.*.request.size`, `rpc.*.response.size`
255+
The OpenTelemetry Collector emits comprehensive internal metrics categorized by verbosity levels. For a complete list of internal metrics and their descriptions, see the [OpenTelemetry Collector Internal Telemetry documentation](https://opentelemetry.io/docs/collector/internal-telemetry/#lists-of-internal-metrics).
283256

284257
## Sample queries
285258

@@ -313,6 +286,8 @@ sumo.datasource=otel_collector metric=otelcol_exporter_queue_size deployment.env
313286
All dashboards have a set of filters that you can apply to the entire dashboard. Use these filters to drill down and examine the data to a granular level.
314287
- You can change the time range for a dashboard or panel by selecting a predefined interval from a drop-down list, choosing a recently used time range, or specifying custom dates and times. [Learn more](/docs/dashboards/set-custom-time-ranges/).
315288
- You can use template variables to drill down and examine the data on a granular level. For more information, see [Filtering Dashboards with Template Variables](/docs/dashboards/filter-template-variables/).
289+
- **Log-based dashboards** use the `_sourceHost` filter to identify specific collector instances.
290+
- **Metrics-based dashboards** use the `service.instance.id` filter to identify specific collector instances.
316291

317292
### Overview
318293

0 commit comments

Comments
 (0)