Fix environment variable substitution syntax in configuration examples (

#2866) * make link to logging exporter permalink to last used release tag (#2862) Signed-off-by: Anthony J Mirabella <[email protected]> * ECS configs changes: from BASH-style environment variables to ${} * ensure all example configs use ${env:...} replacement syntax Signed-off-by: Anthony J Mirabella <[email protected]> --------- Signed-off-by: Anthony J Mirabella <[email protected]> Co-authored-by: 이희성 <[email protected]>
aws-observability · Oct 8, 2024 · 17b1965 · 17b1965
1 parent a08ea87
commit 17b1965
Show file tree

Hide file tree

Showing 6 changed files with 12 additions and 12 deletions.
diff --git a/README.md b/README.md
@@ -31,7 +31,7 @@ This table represents the supported components of the ADOT Collector. The highli
 | [prometheusreceiver](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/prometheusreceiver#prometheus-receiver)       | [attributesprocessor](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/processor/attributesprocessor#attributes-processor)                                 | [`awsxrayexporter`](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/exporter/awsxrayexporter)                                                            | [healthcheckextension](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/extension/healthcheckextension#health-check) |
 | [otlpreceiver](https://github.com/open-telemetry/opentelemetry-collector/tree/main/receiver/otlpreceiver#otlp-receiver)                                 | [resourceprocessor](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/processor/resourceprocessor#resource-processor)                                       | [`awsemfexporter`](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/exporter/awsemfexporter)                                                              | [pprofextension](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/extension/pprofextension#performance-profiler)     |
 | [`awsecscontainermetricsreceiver`](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/awsecscontainermetricsreceiver) | [batchprocessor](https://github.com/open-telemetry/opentelemetry-collector/tree/main/processor/batchprocessor#batch-processor)                                                        | [prometheusremotewriteexporter](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/exporter/prometheusremotewriteexporter#prometheus-remote-write-exporter) | [zpagesextension](https://github.com/open-telemetry/opentelemetry-collector/tree/main/extension/zpagesextension#zpages)                         |
-| [`awsxrayreceiver`](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/awsxrayreceiver)                               | [memorylimiterprocessor](https://github.com/open-telemetry/opentelemetry-collector/tree/main/processor/memorylimiterprocessor#memory-limiter-processor)                               | [loggingexporter](https://github.com/open-telemetry/opentelemetry-collector/tree/main/exporter/loggingexporter#logging-exporter)                                                     | [`ecsobserver`](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/extension/observer/ecsobserver)                     |
+| [`awsxrayreceiver`](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/awsxrayreceiver)                               | [memorylimiterprocessor](https://github.com/open-telemetry/opentelemetry-collector/tree/main/processor/memorylimiterprocessor#memory-limiter-processor)                               | [loggingexporter](https://github.com/open-telemetry/opentelemetry-collector/tree/v0.109.0/exporter/loggingexporter#logging-exporter)                                                     | [`ecsobserver`](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/extension/observer/ecsobserver)                     |
 | [statsdreceiver](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/statsdreceiver#statsd-receiver)                   | [probabilisticsamplerprocessor](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/processor/probabilisticsamplerprocessor#probabilistic-sampling-processor) | [otlpexporter](https://github.com/open-telemetry/opentelemetry-collector/tree/main/exporter/otlpexporter)                                                                            | [`awsproxy`](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/extension/awsproxy)                                    |
 | [zipkinreceiver](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/zipkinreceiver#zipkin-receiver)                   | [metricstransformprocessor](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/processor/metricstransformprocessor#metrics-transform-processor)              | [fileexporter](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/exporter/fileexporter#file-exporter)                                                      | [ballastextension](https://github.com/open-telemetry/opentelemetry-collector/tree/v0.108.1/extension/ballastextension#memory-ballast)               |
 | [jaegerreceiver](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/jaegerreceiver#jaeger-receiver)                   | [spanprocessor](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/processor/spanprocessor#span-processor)                                                   | [otlphttpexporter](https://github.com/open-telemetry/opentelemetry-collector/tree/main/exporter/otlphttpexporter#otlphttp-exporter)                                                  | [`sigv4authextension`](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/extension/sigv4authextension)                |

diff --git a/config/ecs/ecs-amp-prometheus.yaml b/config/ecs/ecs-amp-prometheus.yaml
@@ -1,7 +1,7 @@
 extensions:
   health_check:
   sigv4auth:
-    region: $AWS_REGION
+    region: ${env:AWS_REGION}
 
 receivers:
   awsecscontainermetrics:
@@ -13,7 +13,7 @@ receivers:
       scrape_configs:
         - job_name: "otel-collector"
           static_configs:
-            - targets: [$AWS_PROMETHEUS_SCRAPING_ENDPOINT]
+            - targets: [${env:AWS_PROMETHEUS_SCRAPING_ENDPOINT}]
 
 processors:
   batch/metrics:
@@ -41,7 +41,7 @@ processors:
 
 exporters:
   prometheusremotewrite:
-    endpoint: $AWS_PROMETHEUS_ENDPOINT
+    endpoint: ${env:AWS_PROMETHEUS_ENDPOINT}
     auth:
       authenticator: sigv4auth
     resource_to_telemetry_conversion:

diff --git a/config/ecs/ecs-amp-xray-prometheus.yaml b/config/ecs/ecs-amp-xray-prometheus.yaml
@@ -1,7 +1,7 @@
 extensions:
   health_check:
   sigv4auth:
-    region: $AWS_REGION
+    region: ${env:AWS_REGION}
 
 receivers:
   otlp:
@@ -19,7 +19,7 @@ receivers:
       scrape_configs:
         - job_name: "otel-collector"
           static_configs:
-            - targets: [$AWS_PROMETHEUS_SCRAPING_ENDPOINT]
+            - targets: [${env:AWS_PROMETHEUS_SCRAPING_ENDPOINT}]
 
 processors:
   batch/traces:
@@ -51,7 +51,7 @@ processors:
 exporters:
   awsxray:
   prometheusremotewrite:
-    endpoint: $AWS_PROMETHEUS_ENDPOINT
+    endpoint: ${env:AWS_PROMETHEUS_ENDPOINT}
     auth:
       authenticator: sigv4auth
     resource_to_telemetry_conversion:

diff --git a/config/ecs/ecs-amp-xray.yaml b/config/ecs/ecs-amp-xray.yaml
@@ -1,7 +1,7 @@
 extensions:
   health_check:
   sigv4auth:
-    region: $AWS_REGION
+    region: ${env:AWS_REGION}
 
 receivers:
   otlp:
@@ -42,7 +42,7 @@ processors:
 exporters:
   awsxray:
   prometheusremotewrite:
-    endpoint: $AWS_PROMETHEUS_ENDPOINT
+    endpoint: ${env:AWS_PROMETHEUS_ENDPOINT}
     auth:
       authenticator: sigv4auth
     resource_to_telemetry_conversion:

diff --git a/config/ecs/ecs-amp.yaml b/config/ecs/ecs-amp.yaml
@@ -1,7 +1,7 @@
 extensions:
   health_check:
   sigv4auth:
-    region: $AWS_REGION
+    region: ${env:AWS_REGION}
 
 receivers:
   otlp:
@@ -38,7 +38,7 @@ processors:
 
 exporters:
   prometheusremotewrite:
-    endpoint: $AWS_PROMETHEUS_ENDPOINT
+    endpoint: ${env:AWS_PROMETHEUS_ENDPOINT}
     auth:
       authenticator: sigv4auth
     resource_to_telemetry_conversion:

diff --git a/examples/ecs/aws-prometheus/ecs-ec2-adot-config.yaml b/examples/ecs/aws-prometheus/ecs-ec2-adot-config.yaml
@@ -7,7 +7,7 @@ receivers:
       scrape_configs:
       - job_name: "test-prometheus-sample-app"
         static_configs:
-        - targets: [ $PROMETHEUS_SAMPLE_APP ]
+        - targets: [ ${env:PROMETHEUS_SAMPLE_APP} ]
   awsecscontainermetrics:
     collection_interval: 20s