})
| [Strimzi](https://strimzi.io/) | App: [Strimzi Kafka](/docs/integrations/containers-orchestration/strimzi-kafka/) |
| }){kind=logo}
| [Stripe](https://stripe.com/) | Webhook: [Stripe](/docs/integrations/webhooks/stripe/) |
| }){kind=logo}
| [Sucuri](https://sucuri.net/) | Cloud SIEM integration: [Sucuri](https://github.com/SumoLogic/cloud-siem-content-catalog/blob/master/vendors/cdfd2ba0-77eb-4e11-b071-6f4d01fda607.md) |
-| })
| [Sumo Logic](https://www.sumologic.com/) | Apps: }){kind=logo}
| [Superwise](https://superwise.ai/) | Webhook: [Superwise](/docs/integrations/webhooks/superwise/) |
| }){kind=logo}
| [Symantec](https://sep.securitycloud.symantec.com/v2/landing) | App:}){kind=logo}
| [Sysdig](https://sysdig.com/) | App: [Sysdig Secure](/docs/integrations/saas-cloud/sysdig-secure/)
@@ -79,6 +81,12 @@ Once a request has been submitted, a support ticket is automatically opened. A r
A guide to the Sumo Logic Log Analysis QuickStart app.
+
+ })
+ OpenTelemetry Collector Insights
+A guide to the Sumo Logic OpenTelemetry Collector Insights app.
+}){kind=small}
Security Analytics
diff --git a/docs/integrations/sumo-apps/opentelemetry-collector-insights.md b/docs/integrations/sumo-apps/opentelemetry-collector-insights.md new file mode 100644 index 0000000000..2810239e12 --- /dev/null +++ b/docs/integrations/sumo-apps/opentelemetry-collector-insights.md @@ -0,0 +1,422 @@ +--- +id: opentelemetry-collector-insights +title: OpenTelemetry Collector Insights +sidebar_label: OpenTelemetry Collector Insights +description: Learn about the Sumo Logic OpenTelemetry Collector Insights app. +--- + +import useBaseUrl from '@docusaurus/useBaseUrl'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +
+
+The Sumo Logic OpenTelemetry Collector Insights app provides comprehensive monitoring and observability for your OpenTelemetry Collector instances. Monitor collector performance, telemetry data flow, resource utilization, and troubleshoot data collection issues with preconfigured dashboards and alerts. Track metrics and logs to ensure your telemetry pipeline is running smoothly and efficiently.
+
+This app supports OpenTelemetry Collector version `0.130.1-sumo-0` and later versions.
+
+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.
+
+## Fields creation in Sumo Logic for OpenTelemetry Collector Insights
+
+Following are the [fields](/docs/manage/fields/) which will be created as part of OpenTelemetry Collector Insights app installation, if not already present.
+
+- `sumo.datasource`. Has fixed value of `otel_collector`.
+- `_contentType`. Has fixed value of `OpenTelemetry`.
+- `deployment.environment`. User configured. Enter a name to identify your deployment environment.
+
+## Prerequisites
+
+### For OTLP endpoint configuration
+
+Before configuring the OTEL Collector integration, ensure you have the following prerequisites in place:
+
+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.
+
+ **Documentation**: [Creating a Sumo Logic OTLP Source](https://help.sumologic.com/docs/send-data/hosted-collectors/http-source/otlp/)
+
+### For metrics collection
+
+The OpenTelemetry Collector must be configured to export its own metrics using the built-in telemetry capabilities. This requires:
+- OpenTelemetry Collector version 0.130.1-sumo-0 or later
+- Collector configured with telemetry metrics enabled at `detailed` level
+- Access to OTLP endpoint for metrics export
+- Internal metrics exposed on port 8888 (default)
+
+### For logs collection
+
+The OpenTelemetry Collector must be configured to export its own logs using the built-in telemetry capabilities. This requires:
+- Collector configured with telemetry logs enabled at `debug` level (automatically configured in the provided template)
+- JSON encoding for structured log output (automatically configured in the provided template)
+- Access to OTLP endpoint for logs export
+
+### System Requirements
+
+- OTEL Collector v0.130.1-sumo-0 or later
+- Sufficient system resources (CPU, memory) for data processing
+- Proper permissions for the collector service to access configured resources
+
+
+## Collection configuration and app installation
+
+import ConfigAppInstall from '../../reuse/apps/opentelemetry/config-app-install.md';
+
+
+
+### Step 3: Send logs and metrics to Sumo Logic
+
+import LogsIntro from '../../reuse/apps/opentelemetry/send-logs-intro.md';
+
+
+
+### Logs
+
+The **OpenTelemetry Collector Insights - Logs** dashboard provides detailed insights into collector log output for root-cause analysis of errors, data dropping events, and restarts.
+
+Use this dashboard to:
+- Analyze error patterns and troubleshoot issues.
+- Monitor collector startup and shutdown events.
+- Identify data loss or processing problems.
+- Track log severity trends across your collector fleet.
+
+
+
+### Pipeline: Receiver Health
+
+The **OpenTelemetry Collector Insights - Pipeline: Receiver Health** dashboard focuses exclusively on the data ingestion stage of the pipeline to monitor data sources and receiver performance.
+
+Use this dashboard to:
+- Monitor receiver performance and data ingestion rates.
+- Identify issues with data sources and input connections.
+- Track receiver-specific errors and failures.
+- Analyze accepted vs refused data points.
+
+
+
+### Pipeline: Processor Health
+
+The **OpenTelemetry Collector Insights - Pipeline: Processor Health** dashboard is crucial for understanding if any processors (like batch, memory_limiter, or resourcedetection) are dropping data or causing performance issues.
+
+Use this dashboard to:
+- Monitor processor performance and throughput.
+- Identify data drops or processing bottlenecks.
+- Track processor-specific configurations and health.
+- Analyze batch processing efficiency and triggers.
+
+
+
+### Pipeline: Exporter Health
+
+The **OpenTelemetry Collector Insights - Pipeline: Exporter Health** dashboard is the most critical dashboard for diagnosing backpressure and data loss at the egress stage of the pipeline.
+
+Use this dashboard to:
+- Monitor exporter performance and success rates.
+- Identify backpressure issues and export failures.
+- Track data delivery to downstream systems.
+- Analyze queue utilization and capacity.
+
+
+
+### Resource Utilization
+
+The **OpenTelemetry Collector Insights - Resource Utilization** dashboard provides a deep dive into the collector's own resource consumption to diagnose performance issues and plan for capacity.
+
+Use this dashboard to:
+- Monitor CPU, memory, and disk usage by collectors.
+- Plan capacity and resource allocation.
+- Identify resource constraints and optimization opportunities.
+- Track heap allocation and garbage collection patterns.
+
+
+
+## Troubleshooting
+
+### Common issues
+
+##### Collector connection failure
+
+If your collector fails to connect to Sumo Logic, you may need to configure proxy settings. Check the collector's logs for connection errors:
+
+```bash
+# On systemd systems
+journalctl --unit otelcol-sumo
+
+# Look for errors like "Unable to get a heartbeat"
+```
+
+##### High queue utilization
+
+Monitor the `otelcol_exporter_queue_size` and `otelcol_exporter_queue_capacity` metrics. If the queue is consistently full, you may need to:
+- Reduce data ingestion rate
+- Increase queue capacity
+- Scale horizontally with more collectors
+
+##### Data dropping
+
+Watch for logs containing "Dropping data because sending_queue is full" and monitor failed enqueue metrics:
+- `otelcol_exporter_enqueue_failed_spans`
+- `otelcol_exporter_enqueue_failed_metric_points`
+- `otelcol_exporter_enqueue_failed_log_records`
+
+### Accessing collector metrics directly
+
+By default, the collector's internal metrics are available in Prometheus format at `http://localhost:8888/metrics`. You can access them using:
+
+```bash
+curl http://localhost:8888/metrics
+```
+
+### Log levels and configuration
+
+Configure different log levels for troubleshooting:
+- **DEBUG**. Most verbose, includes detailed trace information
+- **INFO**. Standard operational information (default)
+- **WARN**. Warning messages about potential issues
+- **ERROR**. Error conditions that need attention
+
+## Create monitors for OpenTelemetry Collector Insights app
+
+import CreateMonitors from '../../reuse/apps/create-monitors.md';
+
+