forked from open-telemetry/opentelemetry-collector-contrib
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
34 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
# AWS CloudWatch EMF Exporter for OpenTelemetry Collector | ||
|
||
This exporter converts OpenTelemetry metrics to | ||
[AWS CloudWatch Embedded Metric Format(EMF)](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Embedded_Metric_Format_Specification.html) | ||
and then sends them directly to CloudWatch Logs using the | ||
[PutLogEvents](https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutLogEvents.html) API. | ||
|
||
## Data Conversion | ||
Convert OpenTelemetry ```Counter``` metrics datapoints into CloudWatch ```EMF``` structured log formats and send it to CloudWatch. Logs and Metrics will be displayed in CloudWatch console. | ||
|
||
## Exporter Configuration | ||
|
||
The following exporter configuration parameters are supported. They mirror and have the same affect as the | ||
comparable AWS X-Ray Daemon configuration values. | ||
|
||
| Name | Description | Default | | ||
| :---------------- | :--------------------------------------------------------------------- | ------- | | ||
| `log_group_name` | Customized log group name | | | ||
| `log_stream_name` | Customized log stream name | | | ||
| `endpoint` | Optionally override the default CloudWatch service endpoint. | | | ||
| `no_verify_ssl` | Enable or disable TLS certificate verification. | false | | ||
| `proxy_address` | Upload Structured Logs to AWS CloudWatch through a proxy. | | | ||
| `region` | Send Structured Logs to AWS CloudWatch in a specific region. | | | ||
| `local_mode` | Local mode to skip EC2 instance metadata check. | false | | ||
| `resource_arn` | Amazon Resource Name (ARN) of the AWS resource running the collector. | | | ||
| `role_arn` | IAM role to upload segments to a different account. | | | ||
|
||
## AWS Credential Configuration | ||
|
||
This exporter follows default credential resolution for the | ||
[aws-sdk-go](https://docs.aws.amazon.com/sdk-for-go/api/index.html). | ||
|
||
Follow the [guidelines](https://docs.aws.amazon.com/sdk-for-go/v1/developer-guide/configuring-sdk.html) for the | ||
credential configuration. |