Skip to content

Commit

Permalink
update doc for role_arn
Browse files Browse the repository at this point in the history
  • Loading branch information
bonclay7 committed Mar 12, 2021
1 parent 5059b56 commit 62ca64e
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions exporter/awsprometheusremotewriteexporter/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,15 @@ of the AWS SDK for Go.
Note: this exporter imports and uses the [Prometheus remote write exporter](https://github.com/open-telemetry/opentelemetry-collector/tree/main/exporter/prometheusremotewriteexporter)
from upstream, and simply wraps it in Sigv4 authentication logic

Same as the Prometheus remote write exporter, this exporter checks the temporality and the type of each incoming metric
Same as the Prometheus remote write exporter, this exporter checks the temporality and the type of each incoming metric
and only exports the following combination:

- Int64 or Double type with any temporality
- MonotonicInt64, MonotonicDouble, Histogram, or Summary with only Cumulative temporality.

## Configuration
The following settings are required:
- `endpoint`: protocol:host:port to which the exporter is going to send traces or metrics, using the HTTP/HTTPS protocol.
- `endpoint`: protocol:host:port to which the exporter is going to send traces or metrics, using the HTTP/HTTPS protocol.

The following settings can be optionally configured:
- `namespace`: prefix attached to each exported metric name.
Expand All @@ -31,8 +31,9 @@ The following settings can be optionally configured:
- `aws_auth`: specify if each request should be signed with AWS Sig v4. The following settings must be configured:
- `region`: region of the AWS service being exported to.
- `service`: AWS service being exported to.


- `role_arn`: Amazon Resource Name of the role to assume.


#### Examples:

Simplest configuration:
Expand Down

0 comments on commit 62ca64e

Please sign in to comment.