Skip to content

Commit b2edcaa

Browse files
authored
Remove references to the awsprometheusremotewrite exporter (#376)
* removed references to the awsprw exporter * fix wording in amp config gsg * spelling error fix
1 parent 0f9b8b6 commit b2edcaa

File tree

10 files changed

+105
-68
lines changed

10 files changed

+105
-68
lines changed

src/docs/getting-started/adot-eks-add-on/config-advanced.mdx

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,11 @@ spec:
4444
prometheus.io/scrape: 'true'
4545
prometheus.io/port: '8888'
4646
config: |
47+
extensions:
48+
sigv4auth:
49+
region: <YOUR_AWS_REGION>
50+
service: "aps"
51+
4752
receivers:
4853
prometheus:
4954
config:
@@ -307,18 +312,18 @@ spec:
307312
timeout: 60s
308313
309314
exporters:
310-
awsprometheusremotewrite:
315+
prometheusremotewrite:
311316
endpoint: <YOUR_REMOTE_WRITE_ENDPOINT>
312-
aws_auth:
313-
region: <YOUR_AWS_REGION>
314-
service: "aps"
317+
auth:
318+
authenticator: sigv4auth
315319
316320
service:
321+
extensions: [sigv4auth]
317322
pipelines:
318323
metrics:
319324
receivers: [prometheus]
320325
processors: [batch/metrics]
321-
exporters: [awsprometheusremotewrite]
326+
exporters: [prometheusremotewrite]
322327
```
323328
324329
</details>

src/docs/getting-started/adot-eks-add-on/config-amp.mdx

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,11 @@ path: '/docs/getting-started/adot-eks-add-on/config-amp'
1212

1313
## Collector Configuration
1414

15-
The Collector configuration below is set up to receive Prometheus metrics and export to Amazon Managed Prometheus. Note that the Prometheus receiver is meant to be a drop-in replacement for a Prometheus server and is capable of scraping metrics from microservices instrumented with the [Prometheus client library](https://prometheus.io/docs/instrumenting/clientlibs/). It also supports the full set of [Prometheus configuration](https://github.com/prometheus/prometheus/blob/v2.28.1/docs/configuration/configuration.md#scrape_config). The AWS Prometheus Remote Write Exporter employs the [remote write](https://prometheus.io/docs/prometheus/latest/configuration/configuration/#remote_write) feature and sends metrics data to an existing Amazon Managed Prometheus workspace for long term storage. Note that the file below is also hosted [here](https://github.com/aws-observability/aws-otel-community/blob/master/sample-configs/operator/collector-config-amp.yaml). Save this into a file called `collector-config-amp.yaml` and execute the command
15+
The Collector configuration below is set up to receive Prometheus metrics and export to Amazon Managed Prometheus. Note that the Prometheus receiver is meant to be a drop-in replacement for a Prometheus server and is capable of scraping metrics from microservices instrumented with the [Prometheus client library](https://prometheus.io/docs/instrumenting/clientlibs/). It also supports the full set of [Prometheus configuration](https://github.com/prometheus/prometheus/blob/v2.28.1/docs/configuration/configuration.md#scrape_config). The Prometheus Remote Write Exporter employs the [remote write](https://prometheus.io/docs/prometheus/latest/configuration/configuration/#remote_write) feature and sends metrics data to an existing Amazon Managed Prometheus workspace for long term storage. Note that the file below is also hosted [here](https://github.com/aws-observability/aws-otel-community/blob/master/sample-configs/operator/collector-config-amp.yaml). Save this into a file called `collector-config-amp.yaml` and execute the command
1616
```console
1717
kubectl apply -f collector-config-amp.yaml
1818
```
19-
to deploy your Collector. Make sure to replace `<YOUR_REMOTE_WRITE_ENDPOINT>` and `<YOUR_AWS_REGION>` in the `awsprometheusremoterwite` exporter config, as per your own target environment. Note that a `ClusterRole` and `ClusterRoleBinding` will also be created, which provide necessary permissions for the `prometheus` receiver during service discovery.
19+
to deploy your Collector. Make sure to replace `<YOUR_REMOTE_WRITE_ENDPOINT>` in the `prometheusremoterwite` exporter config, and `<YOUR_AWS_REGION>` in the `sigv4auth` extension config, as per your own target environment. Note that a `ClusterRole` and `ClusterRoleBinding` will also be created, which provide necessary permissions for the `prometheus` receiver during service discovery.
2020

2121
<details>
2222
<summary>
@@ -26,7 +26,7 @@ to deploy your Collector. Make sure to replace `<YOUR_REMOTE_WRITE_ENDPOINT>` an
2626
```yaml
2727
#
2828
# OpenTelemetry Collector configuration
29-
# Metrics pipeline with Prometheus Receiver and AWS Remote Write Exporter sending metrics to Amazon Managed Prometheus
29+
# Metrics pipeline with Prometheus Receiver and Prometheus Remote Write Exporter sending metrics to Amazon Managed Prometheus
3030
#
3131
---
3232
apiVersion: opentelemetry.io/v1alpha1
@@ -40,6 +40,11 @@ spec:
4040
prometheus.io/scrape: 'true'
4141
prometheus.io/port: '8888'
4242
config: |
43+
extensions:
44+
sigv4auth:
45+
region: <YOUR_AWS_REGION>
46+
service: "aps"
47+
4348
receivers:
4449
#
4550
# Scrape configuration for the Prometheus Receiver
@@ -325,18 +330,18 @@ spec:
325330
timeout: 60s
326331
327332
exporters:
328-
awsprometheusremotewrite:
333+
prometheusremotewrite:
329334
endpoint: <YOUR_REMOTE_WRITE_ENDPOINT>
330-
aws_auth:
331-
region: <YOUR_AWS_REGION>
332-
service: "aps"
335+
auth:
336+
authenticator: sigv4auth
333337
334338
service:
339+
extensions: [sigv4auth]
335340
pipelines:
336341
metrics:
337342
receivers: [prometheus]
338343
processors: [batch/metrics]
339-
exporters: [awsprometheusremotewrite]
344+
exporters: [prometheusremotewrite]
340345
341346
---
342347
apiVersion: rbac.authorization.k8s.io/v1

src/docs/getting-started/adot-eks-add-on/config-intro.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ For more information about Collector configuration, as well as OTLP and Promethe
2222
* [Collector CRD configuration](https://github.com/open-telemetry/opentelemetry-operator/blob/main/docs/api.md)
2323
* [OTLP Receiver configuration](https://github.com/open-telemetry/opentelemetry-collector/tree/main/receiver/otlpreceiver)
2424
* [Prometheus Receiver configuration](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/prometheusreceiver)
25-
* [AWS Prometheus Remote Write Exporter configuration](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/exporter/awsprometheusremotewriteexporter#readme)
25+
* [Prometheus Remote Write Exporter configuration](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/exporter/prometheusremotewriteexporter#readme)
2626
* [AWS CloudWatch EMF Exporter configuration](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/exporter/awsemfexporter#readme)
2727
* [AWS X-Ray Exporter configuration](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/exporter/awsxrayexporter#readme)
2828

src/docs/getting-started/advanced-prometheus-remote-write-configurations.mdx

Lines changed: 17 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -486,31 +486,37 @@ roleRef:
486486

487487
<SectionSeparator />
488488

489-
## AWS Prometheus Remote Write Exporter Configurations
489+
## Prometheus Remote Write Exporter Configurations
490490

491-
For the AWS Prometheus Remote Write Exporter to sign your HTTP requests with AWS SigV4 (AWS’ authentication protocol for secure authentication),
492-
you will need to provide the aws_auth configurations. If aws_auth is not provided, HTTPs requests will not be signed.
491+
For the Prometheus Remote Write Exporter to sign your HTTP requests with AWS SigV4 (AWS’ authentication protocol for secure authentication),
492+
you will need to provide the `auth` configuration with the `sigv4auth` authenticator. If `auth` is not provided, HTTPs requests will not be signed.
493493

494494
```yaml lineNumbers=true
495+
extensions:
496+
sigv4auth:
497+
service: "aps"
498+
region: "user-region"
495499
exporters:
496-
awsprometheusremotewrite:
500+
prometheusremotewrite:
497501
endpoint: "https://aws-managed-prometheus-endpoint/v1/api/remote_write"
498-
aws_auth:
499-
service: "aps"
500-
region: "user-region"
502+
auth:
503+
authenticator: sigv4auth
501504
```
502505

503-
Aside from the auth configurations, the AWS Prometheus Remote Write Exporter is also configurable with retry, sending queue, and timeout
506+
Aside from the auth configurations, the Prometheus Remote Write Exporter is also configurable with retry, sending queue, and timeout
504507
settings. An example of these configurations is provided below.
505508

506509
```yaml lineNumbers=true
510+
extensions:
511+
sigv4auth:
512+
service: "aps"
513+
region: "us-east-1"
507514
exporters:
508-
awsprometheusremotewrite:
515+
prometheusremotewrite:
509516
endpoint: "https://aps-workspaces-gamma.us-east-1.amazonaws.com/workspaces/ws-7cd45747-2381-4a2a-847f-fa61a3694a74/api/v1/remote_write"
510517
namespace: test
511518
auth:
512-
region: "us-east-1"
513-
service: "aps"
519+
authenticator: sigv4auth
514520
retry_on_failure:
515521
enabled: true
516522
initial_interval: 5s

src/docs/getting-started/ecs-configurations/ecs-config-section.mdx

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,7 @@ Below is an example of a configuration which utilizes ECS and AMP to output metr
5151
```yaml lineNumbers=true
5252
extensions:
5353
health_check:
54+
sigv4auth:
5455

5556
receivers:
5657
otlp:
@@ -86,8 +87,10 @@ processors:
8687
- container.duration
8788

8889
exporters:
89-
awsprometheusremotewrite:
90+
prometheusremotewrite:
9091
endpoint: $AWS_PROMETHEUS_ENDPOINT
92+
auth:
93+
authenticator: sigv4auth
9194
resource_to_telemetry_conversion:
9295
enabled: true
9396

@@ -96,13 +99,13 @@ service:
9699
metrics/application:
97100
receivers: [otlp]
98101
processors: [resourcedetection, batch/metrics]
99-
exporters: [awsprometheusremotewrite]
102+
exporters: [prometheusremotewrite]
100103
metrics:
101104
receivers: [awsecscontainermetrics]
102105
processors: [filter]
103-
exporters: [awsprometheusremotewrite]
106+
exporters: [prometheusremotewrite]
104107

105-
extensions: [health_check]
108+
extensions: [health_check, sigv4auth]
106109
```
107110
108111
## Amazon CloudWatch Configuration for Application metrics
@@ -379,6 +382,7 @@ By utilizing this configuration you will be able to see datapoints from both met
379382
```yaml lineNumbers=true
380383
extensions:
381384
health_check:
385+
sigv4auth:
382386

383387
receivers:
384388
otlp:
@@ -418,8 +422,10 @@ processors:
418422

419423
exporters:
420424
awsxray:
421-
awsprometheusremotewrite:
425+
prometheusremotewrite:
422426
endpoint: $AWS_PROMETHEUS_ENDPOINT
427+
auth:
428+
authenticator: sigv4auth
423429
resource_to_telemetry_conversion:
424430
enabled: true
425431

@@ -432,11 +438,11 @@ service:
432438
metrics/application:
433439
receivers: [otlp]
434440
processors: [resourcedetection, batch/metrics]
435-
exporters: [awsprometheusremotewrite]
441+
exporters: [prometheusremotewrite]
436442
metrics:
437443
receivers: [awsecscontainermetrics]
438444
processors: [filter]
439-
exporters: [awsprometheusremotewrite]
445+
exporters: [prometheusremotewrite]
440446

441-
extensions: [health_check]
442-
```
447+
extensions: [health_check, sigv4auth]
448+
```

src/docs/getting-started/lambda/lambda-java-auto-instr.mdx

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -121,9 +121,13 @@ By default, the ADOT Lambda layer uses the [config.yaml](https://github.com/aws-
121121

122122
The layer is not configured by default to export Prometheus metrics to Amazon Managed Service for Prometheus (AMP) (https://docs.aws.amazon.com/prometheus/latest/userguide/what-is-Amazon-Managed-Service-Prometheus.html). To enable it:
123123

124-
1. Upload a custom collector configuration file `collector.yaml` with your Lambda application, like the example shown below, with the awsprometheusremoteexporter enabled. Set up the `endpoint` and `region` of your own AMP workspace. Note that since AMP is in preview, only these [AMP supported regions](https://docs.aws.amazon.com/prometheus/latest/userguide/AMP_quotas.html) can be used.
124+
1. Upload a custom collector configuration file `collector.yaml` with your Lambda application, like the example shown below, with the `prometheusremotewriteexporter` and the `sigv4authextension` enabled. Set up the `endpoint` of your own AMP workspace, and `region` of the `sigv4authextension`.
125125
```
126126
# collector.yaml
127+
extensions:
128+
sigv4auth:
129+
service: "aps"
130+
region: <workspace_region>
127131
128132
receivers:
129133
otlp:
@@ -133,20 +137,20 @@ receivers:
133137
exporters:
134138
logging:
135139
awsxray:
136-
awsprometheusremotewrite:
140+
prometheusremotewrite:
137141
endpoint: <workspace_remote_write_url>
138-
aws_auth:
139-
service: "aps"
140-
region: <workspace_region>
142+
auth:
143+
authenticator: sigv4auth
141144
142145
service:
146+
extensions: [sigv4auth]
143147
pipelines:
144148
traces:
145149
receivers: [otlp]
146150
exporters: [awsxray]
147151
metrics:
148152
receivers: [otlp]
149-
exporters: [logging, awsprometheusremotewrite]
153+
exporters: [logging, prometheusremotewrite]
150154
```
151155
2. Upload this collector config as the OPENTELEMETRY_CONFIG_FILE environment variable to configure the Lambda Layer to export metrics to your workspace, following these [instructions](/docs/getting-started/lambda#custom-configuration-for-the-adot-collector-on-lambda).
152156

src/docs/getting-started/operator.mdx

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -262,6 +262,11 @@ spec:
262262
image: public.ecr.aws/aws-observability/aws-otel-collector:latest
263263
mode: deployment
264264
config: |
265+
extensions:
266+
sigv4auth:
267+
service: "aps"
268+
region: <YOUR-AMP-REGION>
269+
265270
receivers:
266271
prometheus:
267272
config:
@@ -288,11 +293,10 @@ spec:
288293
send_batch_size: 10000
289294
290295
exporters:
291-
awsprometheusremotewrite:
296+
prometheusremotewrite:
292297
endpoint: <YOUR-AMP-REMOTE-WRITE-ENDPOINT>
293-
aws_auth:
294-
service: "aps"
295-
region: <YOUR-AMP-REGION>
298+
auth:
299+
authenticator: sigv4auth
296300
awsemf:
297301
region: <YOUR-CLOUDWATCH-REGION>
298302
log_group_name: "/metrics/my-adot-collector"
@@ -301,11 +305,12 @@ spec:
301305
loglevel: debug
302306
303307
service:
308+
extensions: [sigv4auth]
304309
pipelines:
305310
metrics:
306311
receivers: [prometheus]
307312
processors: []
308-
exporters: [awsprometheusremotewrite,awsemf,logging]
313+
exporters: [prometheusremotewrite,awsemf,logging]
309314
---
310315
apiVersion: rbac.authorization.k8s.io/v1
311316
kind: ClusterRoleBinding

src/docs/getting-started/prometheus-remote-write-exporter.mdx

Lines changed: 15 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ to AWS Managed Service for Prometheus (AMP).
2525

2626
<img src={prometheusPipelineEKSImg} alt="Diagram" style="margin: 30px 0;" />
2727

28-
The ADOT-AMP pipeline includes two OpenTelemetry Collector components specific to Prometheus — the Prometheus Receiver and the AWS Prometheus
28+
The ADOT-AMP pipeline includes two OpenTelemetry Collector components specific to Prometheus — the Prometheus Receiver and the Prometheus
2929
Remote Write Exporter.
3030

3131
<SectionSeparator />
@@ -99,26 +99,30 @@ relabel_configs:
9999
100100
<SubSectionSeparator />
101101
102-
### AWS Prometheus Remote Write Exporter
102+
### Prometheus Remote Write Exporter
103103
104-
The configuration for the AWS Prometheus Remote Write Exporter is a lot simpler than the Prometheus receiver. At this stage in the pipeline, metrics
104+
The configuration for the Prometheus Remote Write Exporter is a lot simpler than the Prometheus receiver. At this stage in the pipeline, metrics
105105
have already been ingested, and we’re ready to export this data to AMP. The minimum requirement for a successful configuration to communicate with AMP is as follows:
106106
107107
```yaml lineNumbers=true
108+
extensions:
109+
sigv4auth:
110+
service: "aps"
111+
region: "user-region"
112+
108113
exporters:
109-
awsprometheusremotewrite:
114+
prometheusremotewrite:
110115
endpoint: "https://aws-managed-prometheus-endpoint/v1/api/remote_write"
111-
aws_auth:
112-
service: "aps"
113-
region: "user-region"
116+
auth:
117+
authenticator: sigv4auth
114118
```
115119

116-
This configuration sends an HTTPS request that is signed by AWS SigV4 using the credentials that are set up from the prerequisites section. It is
117-
mandatory that customers specify the service to be “aps”
120+
This configuration sends an HTTPS request that is signed by AWS SigV4 using the credentials that are set up from the prerequisites section.
121+
This is enabled by using the `sigv4auth` extension. It is mandatory that customers specify the service to be “aps”.
118122

119123
Regardless of the method of deployment, the ADOT Collector must have access to one of the listed options in the
120-
[default AWS credentials chain](https://docs.aws.amazon.com/sdk-for-go/v1/developer-guide/configuring-sdk.html). The AWS Prometheus Remote Write
121-
Exporter depends on the AWS Go SDK and uses it to fetch credentials and authenticate. You must ensure that these credentials have remote writing
124+
[default AWS credentials chain](https://docs.aws.amazon.com/sdk-for-go/v1/developer-guide/configuring-sdk.html). The `sigv4auth`
125+
extension depends on the AWS Go SDK and uses it to fetch credentials and authenticate. You must ensure that these credentials have remote writing
122126
permissions to AMP (`aps:RemoteWrite`).
123127

124128
<SectionSeparator />
@@ -132,4 +136,3 @@ For more advanced configurations with the ADOT Collector-AMP, please take a look
132136

133137
We would love to hear more common configuration scenarios or improvements to this documentation from you! Please submit an issue
134138
on the [aws-otel community](https://github.com/aws-observability/aws-otel-community) to let us know.
135-

0 commit comments

Comments
 (0)