Skip to content

Commit b5c07a4

Browse files
Merge remote-tracking branch 'refs/remotes/origin/otel-collector-doc' into otel-collector-doc
2 parents 6147568 + d3bdbc3 commit b5c07a4

File tree

19 files changed

+296
-79
lines changed

19 files changed

+296
-79
lines changed

.clabot

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -188,7 +188,8 @@
188188
"ntanwar-sumo",
189189
"aj-sumo",
190190
"samiura",
191-
"naveenrama"
191+
"naveenrama",
192+
"fguimond"
192193
],
193194
"message": "Thank you for your contribution! As this is an open source project, we require contributors to sign our Contributor License Agreement and do not have yours on file. To proceed with your PR, please [sign your name here](https://forms.gle/YgLddrckeJaCdZYA6) and we will add you to our approved list of contributors.",
194195
"label": "cla-signed",

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

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

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

16-
This app supports OpenTelemetry Collector version **0.130.1-sumo-0** and later versions.
16+
This app supports OpenTelemetry Collector version `0.130.1-sumo-0` and later versions.
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

@@ -25,13 +25,13 @@ This app includes [built-in monitors](#opentelemetry-collector-insights-alerts).
2525

2626
Following are the [fields](/docs/manage/fields/) which will be created as part of OpenTelemetry Collector Insights app installation, if not already present.
2727

28-
- **sumo.datasource**. Has fixed value of **otel_collector**.
29-
- **_contentType**. Has fixed value of **OpenTelemetry**.
30-
- **deployment.environment**. User configured. Enter a name to identify your deployment environment.
28+
- `sumo.datasource`. Has fixed value of `otel_collector`.
29+
- `_contentType`. Has fixed value of `OpenTelemetry`.
30+
- `deployment.environment`. User configured. Enter a name to identify your deployment environment.
3131

3232
## Prerequisites
3333

34-
### For OTLP Endpoint Configuration
34+
### For OTLP endpoint configuration
3535

3636
Before configuring the OTEL Collector integration, ensure you have the following prerequisites in place:
3737

@@ -85,10 +85,10 @@ In this step, you will configure the OpenTelemetry Collector's built-in telemetr
8585
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:
8686

8787
**Required Inputs:**
88-
- **OTLP Endpoint**: Your Sumo Logic OTLP endpoint URL
88+
- **OTLP Endpoint**: Your Sumo Logic OTLP endpoint URL.
8989

9090
**Configuration Parameters:**
91-
- **Endpoint Format**: The base endpoint automatically creates:
91+
- **Endpoint Format**. The base endpoint automatically creates:
9292
- Logs endpoint: `${OTLP_ENDPOINT}/v1/logs`
9393
- Metrics endpoint: `${OTLP_ENDPOINT}/v1/metrics`
9494

@@ -209,11 +209,11 @@ import LogsOutro from '../../../reuse/apps/opentelemetry/send-logs-outro.md';
209209
### Validation
210210

211211
After installation, verify that:
212-
1. The OTEL Collector service is running
213-
2. The configured base endpoint is reachable
214-
3. Data is being successfully sent to both the logs (`/v1/logs`) and metrics (`/v1/metrics`) endpoints
215-
4. Resource attributes are properly applied to the telemetry data
216-
5. Internal metrics are accessible at `http://localhost:8888/metrics`
212+
1. The OTEL Collector service is running.
213+
2. The configured base endpoint is reachable.
214+
3. Data is being successfully sent to both the logs (`/v1/logs`) and metrics (`/v1/metrics`) endpoints.
215+
4. Resource attributes are properly applied to the telemetry data.
216+
5. Internal metrics are accessible at `http://localhost:8888/metrics`.
217217

218218
## Sample log messages
219219

@@ -319,10 +319,10 @@ All dashboards have a set of filters that you can apply to the entire dashboard.
319319
The **OpenTelemetry Collector Insights - Overview** dashboard provides a high-level view of your OpenTelemetry Collector fleet's health and performance. This is your starting point for monitoring collector instances.
320320

321321
Use this dashboard to:
322-
- Monitor the overall health of your collector fleet
323-
- Identify performance bottlenecks and resource constraints
324-
- Track data flow and processing rates across collectors
325-
- Quickly spot collectors experiencing issues
322+
- Monitor the overall health of your collector fleet.
323+
- Identify performance bottlenecks and resource constraints.
324+
- Track data flow and processing rates across collectors.
325+
- Quickly spot collectors experiencing issues.
326326

327327
<img src='https://sumologic-app-data-v2.s3.amazonaws.com/dashboards/OpenTelemetry-Collector-Insights/OpenTelemetry-Collector-Overview.png' alt="Overview" />
328328

@@ -331,10 +331,10 @@ Use this dashboard to:
331331
The **OpenTelemetry Collector Insights - Logs** dashboard provides detailed insights into collector log output for root-cause analysis of errors, data dropping events, and restarts.
332332

333333
Use this dashboard to:
334-
- Analyze error patterns and troubleshoot issues
335-
- Monitor collector startup and shutdown events
336-
- Identify data loss or processing problems
337-
- Track log severity trends across your collector fleet
334+
- Analyze error patterns and troubleshoot issues.
335+
- Monitor collector startup and shutdown events.
336+
- Identify data loss or processing problems.
337+
- Track log severity trends across your collector fleet.
338338

339339
<img src='https://sumologic-app-data-v2.s3.amazonaws.com/dashboards/OpenTelemetry-Collector-Insights/OpenTelemetry-Collector-Logs.png' alt="Logs" />
340340

@@ -343,10 +343,10 @@ Use this dashboard to:
343343
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.
344344

345345
Use this dashboard to:
346-
- Monitor receiver performance and data ingestion rates
347-
- Identify issues with data sources and input connections
348-
- Track receiver-specific errors and failures
349-
- Analyze accepted vs refused data points
346+
- Monitor receiver performance and data ingestion rates.
347+
- Identify issues with data sources and input connections.
348+
- Track receiver-specific errors and failures.
349+
- Analyze accepted vs refused data points.
350350

351351
<img src='https://sumologic-app-data-v2.s3.amazonaws.com/dashboards/OpenTelemetry-Collector-Insights/OpenTelemetry-Collector-Pipeline-Receiver-Health.png' alt="Pipeline Receiver Health" />
352352

@@ -355,10 +355,10 @@ Use this dashboard to:
355355
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.
356356

357357
Use this dashboard to:
358-
- Monitor processor performance and throughput
359-
- Identify data drops or processing bottlenecks
360-
- Track processor-specific configurations and health
361-
- Analyze batch processing efficiency and triggers
358+
- Monitor processor performance and throughput.
359+
- Identify data drops or processing bottlenecks.
360+
- Track processor-specific configurations and health.
361+
- Analyze batch processing efficiency and triggers.
362362

363363
<img src='https://sumologic-app-data-v2.s3.amazonaws.com/dashboards/OpenTelemetry-Collector-Insights/OpenTelemetry-Collector-Pipeline-Processor-Health.png' alt="Pipeline Processor Health" />
364364

@@ -367,10 +367,10 @@ Use this dashboard to:
367367
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.
368368

369369
Use this dashboard to:
370-
- Monitor exporter performance and success rates
371-
- Identify backpressure issues and export failures
372-
- Track data delivery to downstream systems
373-
- Analyze queue utilization and capacity
370+
- Monitor exporter performance and success rates.
371+
- Identify backpressure issues and export failures.
372+
- Track data delivery to downstream systems.
373+
- Analyze queue utilization and capacity.
374374

375375
<img src='https://sumologic-app-data-v2.s3.amazonaws.com/dashboards/OpenTelemetry-Collector-Insights/OpenTelemetry-Collector-Pipeline-Exporter-Health.png' alt="Pipeline Exporter Health" />
376376

@@ -379,18 +379,20 @@ Use this dashboard to:
379379
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.
380380

381381
Use this dashboard to:
382-
- Monitor CPU, memory, and disk usage by collectors
383-
- Plan capacity and resource allocation
384-
- Identify resource constraints and optimization opportunities
385-
- Track heap allocation and garbage collection patterns
382+
- Monitor CPU, memory, and disk usage by collectors.
383+
- Plan capacity and resource allocation.
384+
- Identify resource constraints and optimization opportunities.
385+
- Track heap allocation and garbage collection patterns.
386386

387387
<img src='https://sumologic-app-data-v2.s3.amazonaws.com/dashboards/OpenTelemetry-Collector-Insights/OpenTelemetry-Collector-Resource-Utilization.png' alt="Resource Utilization" />
388388

389389
## Troubleshooting
390390

391-
### Common Issues
391+
### Common issues
392392

393-
**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:
393+
##### Collector connection failure
394+
395+
If your collector fails to connect to Sumo Logic, you may need to configure proxy settings. Check the collector's logs for connection errors:
394396

395397
```bash
396398
# On systemd systems
@@ -399,31 +401,35 @@ journalctl --unit otelcol-sumo
399401
# Look for errors like "Unable to get a heartbeat"
400402
```
401403

402-
**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:
404+
##### High queue utilization
405+
406+
Monitor the `otelcol_exporter_queue_size` and `otelcol_exporter_queue_capacity` metrics. If the queue is consistently full, you may need to:
403407
- Reduce data ingestion rate
404408
- Increase queue capacity
405409
- Scale horizontally with more collectors
406410

407-
**Data dropping**: Watch for logs containing "Dropping data because sending_queue is full" and monitor failed enqueue metrics:
411+
##### Data dropping
412+
413+
Watch for logs containing "Dropping data because sending_queue is full" and monitor failed enqueue metrics:
408414
- `otelcol_exporter_enqueue_failed_spans`
409415
- `otelcol_exporter_enqueue_failed_metric_points`
410416
- `otelcol_exporter_enqueue_failed_log_records`
411417

412-
### Accessing Collector Metrics Directly
418+
### Accessing collector metrics directly
413419

414420
By default, the collector's internal metrics are available in Prometheus format at `http://localhost:8888/metrics`. You can access them using:
415421

416422
```bash
417423
curl http://localhost:8888/metrics
418424
```
419425

420-
### Log Levels and Configuration
426+
### Log levels and configuration
421427

422428
Configure different log levels for troubleshooting:
423-
- **DEBUG**: Most verbose, includes detailed trace information
424-
- **INFO**: Standard operational information (default)
425-
- **WARN**: Warning messages about potential issues
426-
- **ERROR**: Error conditions that need attention
429+
- **DEBUG**. Most verbose, includes detailed trace information
430+
- **INFO**. Standard operational information (default)
431+
- **WARN**. Warning messages about potential issues
432+
- **ERROR**. Error conditions that need attention
427433

428434
## Create monitors for OpenTelemetry Collector Insights app
429435

docs/platform-services/automation-service/app-central/integrations/aws-athena.md

Lines changed: 31 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@ import useBaseUrl from '@docusaurus/useBaseUrl';
66

77
<img src={useBaseUrl('/img/platform-services/automation-service/app-central/logos/aws.png')} alt="automox" width="50"/>
88

9-
***Version: 1.1
10-
Updated: Jun 15, 2023***
9+
***Version: 1.2
10+
Updated: July 29, 2025***
1111

1212
Amazon Athena is a cloud-based service that enables you to run SQL queries on data stored in Amazon S3 without the need to set up any infrastructure. It is a serverless, pay-per-query service that makes it easy to analyze large amounts of data.
1313

@@ -34,9 +34,11 @@ To [get access key and secret access key](https://docs.aws.amazon.com/athena/lat
3434

3535
import IntegrationsAuth from '../../../../reuse/integrations-authentication.md';
3636
import IntegrationsAuthAWS from '../../../../reuse/integrations-authentication-aws.md';
37+
import IAMConfiguration from '../../../../reuse/automation-service/aws/iam-configuration.md';
3738
import AWSRegions from '../../../../reuse/automation-service/aws/region.md';
3839
import AWSAccesskey from '../../../../reuse/automation-service/aws/access-key.md';
3940
import AWSSecret from '../../../../reuse/automation-service/aws/secret.md';
41+
import AWSIAMRole from '../../../../reuse/automation-service/aws/iam-role.md';
4042
import IntegrationCertificate from '../../../../reuse/automation-service/integration-certificate.md';
4143
import IntegrationEngine from '../../../../reuse/automation-service/integration-engine.md';
4244
import IntegrationLabel from '../../../../reuse/automation-service/integration-label.md';
@@ -49,16 +51,41 @@ import IntegrationTimeout from '../../../../reuse/automation-service/integration
4951
* <AWSRegions/>
5052
* <AWSAccesskey/>
5153
* <AWSSecret/>
54+
* <AWSIAMRole/>
5255
* <IntegrationTimeout/>
5356
* <IntegrationCertificate/>
5457
* <IntegrationEngine/>
5558
* <IntegrationProxy/>
5659

5760
<img src={useBaseUrl('/img/platform-services/automation-service/app-central/integrations/misc/aws-athena-configuration.png')} style={{border:'1px solid gray'}} alt="AWS Athena configuration" width="400"/>
5861

62+
For information about Amazon Athena, see [Athena documentation](https://docs.aws.amazon.com/athena/).
63+
5964
<IntegrationsAuthAWS/>
6065

61-
For information about Amazon Athena, see [Athena documentation](https://docs.aws.amazon.com/athena/).
66+
### AWS IAM role-based access
67+
68+
<IAMConfiguration/>
69+
70+
## Required Permissions
71+
```
72+
athena:StartQueryExecution
73+
athena:GetQueryExecution
74+
athena:GetQueryResults
75+
athena:StopQueryExecution
76+
athena:ListDatabases
77+
athena:ListWorkGroups
78+
athena:ListTableMetadata
79+
glue:GetDatabase
80+
glue:GetDatabases
81+
glue:GetTable
82+
glue:GetTables
83+
glue:GetTableVersion
84+
glue:GetTableVersions
85+
s3:GetObject
86+
s3:PutObject
87+
s3:ListBucket
88+
```
6289

6390
## External Libraries
6491

@@ -68,3 +95,4 @@ For information about Amazon Athena, see [Athena documentation](https://docs.aws
6895

6996
* February 22, 2023 (v1.0) - First upload
7097
* June 15, 2023 (v1.1) - Updated the integration with Environmental Variables
98+
* July 29, 2025 (v1.2) - Added support for IAM role authentication - Users can now authenticate using an AWS IAM Role in addition to access key–based authentication.

docs/platform-services/automation-service/app-central/integrations/aws-cloudfront.md

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@ import useBaseUrl from '@docusaurus/useBaseUrl';
66

77
<img src={useBaseUrl('/img/platform-services/automation-service/app-central/logos/aws.png')} alt="aws" width="50"/>
88

9-
***Version: 1.3
10-
Updated: Jun 15, 2023***
9+
***Version: 1.4
10+
Updated: July 29, 2025***
1111

1212
Amazon CloudFront integrates with AWS Identity and Access Management (IAM), a service that lets your organization do the following:
1313

@@ -25,9 +25,11 @@ Amazon CloudFront integrates with AWS Identity and Access Management (IAM), a se
2525

2626
import IntegrationsAuth from '../../../../reuse/integrations-authentication.md';
2727
import IntegrationsAuthAWS from '../../../../reuse/integrations-authentication-aws.md';
28+
import IAMConfiguration from '../../../../reuse/automation-service/aws/iam-configuration.md';
2829
import AWSRegions from '../../../../reuse/automation-service/aws/region.md';
2930
import AWSAccesskey from '../../../../reuse/automation-service/aws/access-key.md';
3031
import AWSSecret from '../../../../reuse/automation-service/aws/secret.md';
32+
import AWSIAMRole from '../../../../reuse/automation-service/aws/iam-role.md';
3133
import IntegrationCertificate from '../../../../reuse/automation-service/integration-certificate.md';
3234
import IntegrationEngine from '../../../../reuse/automation-service/integration-engine.md';
3335
import IntegrationLabel from '../../../../reuse/automation-service/integration-label.md';
@@ -41,20 +43,32 @@ import IntegrationTimeout from '../../../../reuse/automation-service/integration
4143
* **Service Name**. Enter `AWS CloudFront`.
4244
* <AWSAccesskey/>
4345
* <AWSSecret/>
46+
* <AWSIAMRole/>
4447
* <IntegrationTimeout/>
4548
* <IntegrationCertificate/>
4649
* <IntegrationEngine/>
4750
* <IntegrationProxy/>
4851

4952
<img src={useBaseUrl('/img/platform-services/automation-service/app-central/integrations/aws/aws-cloudfront-configuration.png')} style={{border:'1px solid gray'}} alt="AWS CloudFront configuration" width="400"/>
5053

54+
For information about AWS CloudFront, see [CloudFront documentation](https://docs.aws.amazon.com/cloudfront/).
55+
5156
<IntegrationsAuthAWS/>
5257

53-
For information about AWS CloudFront, see [CloudFront documentation](https://docs.aws.amazon.com/cloudfront/).
58+
### AWS IAM role-based access
59+
60+
<IAMConfiguration/>
61+
62+
## Required Permissions
63+
```
64+
cloudfront:ListCloudFrontOriginAccessIdentities
65+
cloudfront:GetCloudFrontOriginAccessIdentity
66+
```
5467

5568
## Change Log
5669

5770
* November 10, 2022 - First upload
5871
* April 14, 2023 (v1.1)
5972
+ Updated integration: (Updated the integration Fields with Environmental Variables)
6073
* June 15, 2023 (v1.3) - Updated the integration with Environmental Variables
74+
* July 29, 2025 (v1.4) - Added support for IAM role authentication - Users can now authenticate using an AWS IAM Role in addition to access key–based authentication.

0 commit comments

Comments
 (0)