docs: Edit ECS tutorial to add new steps for the otelcol.receiver.awsecscontainermetrics component #5347
Conversation
|
💻 Deploy preview deleted (docs: Edit ECS tutorial to add new steps for the |
There was a problem hiding this comment.
Pull request overview
This PR updates the ECS/Fargate OpenTelemetry collection tutorial to add an option using the experimental otelcol.receiver.awsecscontainermetrics component, and cleans up existing instructions and examples.
Changes:
- Adds a new “native receiver” path using
otelcol.receiver.awsecscontainermetricswith example Alloy configuration and required--stability.level=experimentalflag. - Refactors the existing Prometheus ECS exporter path, clarifying it as the “stable” option and updating the Alloy configuration to current patterns (e.g.,
env(...), remote_write). - Normalizes bullets, shell paths (e.g.,
/bin/bash), container image versions, and removes unused link references.
Fix potential shell injection vulnerability Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
|
|
||
| #### Prometheus exporter | ||
|
|
||
| If you prefer a stable approach, use the Prometheus ECS exporter as a sidecar container. |
There was a problem hiding this comment.
IMO this segue implies that the receiver isn't a great choice, I would lean more towards something like "Running the ECS exporter in a sidecar container does not require running Alloy with experimental stability"
|
|
||
| For the Prometheus exporter, use `"printenv ALLOY_CONFIG_CONTENT > /tmp/config_file && exec /bin/alloy run --server.http.listen-addr=0.0.0.0:12345 /tmp/config_file"`. | ||
|
|
||
| Make sure you don't omit the double quotes around the command. |
There was a problem hiding this comment.
Double negative? "Make sure you include..."
|
|
||
| * Only add the {{< param "PRODUCT_NAME" >}} container, not the Prometheus exporter, and run the task as a daemon so it automatically runs one instance per node in your cluster. | ||
| * Update your {{< param "PRODUCT_NAME" >}} configuration to collect metrics from the instance. | ||
| - If you're using the Prometheus exporter, you don't need to add the ecs-exporter sidecar for EC2 instance metrics. |
There was a problem hiding this comment.
| - If you're using the Prometheus exporter, you don't need to add the ecs-exporter sidecar for EC2 instance metrics. | |
| - If you're using the awsecscontainermetrics receiver, you don't need to add the ecs-exporter sidecar for EC2 instance metrics. |
…secscontainermetrics` component (#5347) Edit ECS tutorial to add new steps for the `otelcol.receiver.awsecscontainermetrics` component . Split tutorial into two paths... the original "stable" option and the new experimental `otelcol.receiver.awsecscontainermetrics` option. Clean up content: * fix bullets for consistency * fix the paths eg `/bin/bash` instead of just `bash` * removed some unused link definitions Fixes #4566 ### Note to reviewers I used AI to generate the configs. I do not have ECS to do any testing so I relied on AI to check the configuration examples. The configuration code snippets should be checked for validity and accuracy Preview for review is here: https://deploy-preview-alloy-5347-zb444pucvq-vp.a.run.app/docs/alloy/latest/collect/ecs-opentelemetry-data/ --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> (cherry picked from commit d37d130)
…secscontainermetrics` component [backport] (#5585) ## Backport of #5347 This PR backports #5347 to release/v1.13. ### Original PR Author @clayton-cornell ### Description Edit ECS tutorial to add new steps for the `otelcol.receiver.awsecscontainermetrics` component . Split tutorial into two paths... the original "stable" option and the new experimental `otelcol.receiver.awsecscontainermetrics` option. Clean up content: * fix bullets for consistency * fix the paths eg `/bin/bash` instead of just `bash` * removed some unused link definitions Fixes #4566 ### Note to reviewers I used AI to generate the configs. I do not have ECS to do any testing so I relied on AI to check the configuration examples. The configuration code snippets should be checked for validity and accuracy Preview for review is here: https://deploy-preview-alloy-5347-zb444pucvq-vp.a.run.app/docs/alloy/latest/collect/ecs-opentelemetry-data/ --- *This backport was created automatically.* Co-authored-by: Clayton Cornell <131809008+clayton-cornell@users.noreply.github.com> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
…secscontainermetrics` component (#5347) Edit ECS tutorial to add new steps for the `otelcol.receiver.awsecscontainermetrics` component . Split tutorial into two paths... the original "stable" option and the new experimental `otelcol.receiver.awsecscontainermetrics` option. Clean up content: * fix bullets for consistency * fix the paths eg `/bin/bash` instead of just `bash` * removed some unused link definitions Fixes #4566 ### Note to reviewers I used AI to generate the configs. I do not have ECS to do any testing so I relied on AI to check the configuration examples. The configuration code snippets should be checked for validity and accuracy Preview for review is here: https://deploy-preview-alloy-5347-zb444pucvq-vp.a.run.app/docs/alloy/latest/collect/ecs-opentelemetry-data/ --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Edit ECS tutorial to add new steps for the
otelcol.receiver.awsecscontainermetricscomponent .Split tutorial into two paths... the original "stable" option and the new experimental
otelcol.receiver.awsecscontainermetricsoption.Clean up content:
/bin/bashinstead of justbashFixes #4566
Note to reviewers
I used AI to generate the configs. I do not have ECS to do any testing so I relied on AI to check the configuration examples. The configuration code snippets should be checked for validity and accuracy
Preview for review is here: https://deploy-preview-alloy-5347-zb444pucvq-vp.a.run.app/docs/alloy/latest/collect/ecs-opentelemetry-data/