Skip to content

docs: Edit ECS tutorial to add new steps for the otelcol.receiver.awsecscontainermetrics component #5347

Merged
clayton-cornell merged 15 commits intomainfrom
docs/update-ecs-tutorial-ecs-connector
Feb 19, 2026
Merged

docs: Edit ECS tutorial to add new steps for the otelcol.receiver.awsecscontainermetrics component #5347
clayton-cornell merged 15 commits intomainfrom
docs/update-ecs-tutorial-ecs-connector

Conversation

@clayton-cornell
Copy link
Contributor

@clayton-cornell clayton-cornell commented Jan 26, 2026

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/

@github-actions
Copy link
Contributor

github-actions bot commented Jan 26, 2026

💻 Deploy preview deleted (docs: Edit ECS tutorial to add new steps for the otelcol.receiver.awsecscontainermetrics component ).

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.awsecscontainermetrics with example Alloy configuration and required --stability.level=experimental flag.
  • 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.

clayton-cornell and others added 3 commits January 26, 2026 12:16
Fix potential shell injection vulnerability

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated 4 comments.

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated 2 comments.

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated 2 comments.

@clayton-cornell clayton-cornell added the type/docs Docs Squad label across all Grafana Labs repos label Jan 26, 2026
@clayton-cornell clayton-cornell marked this pull request as ready for review January 26, 2026 11:13
@clayton-cornell clayton-cornell requested a review from a team January 26, 2026 11:19

#### Prometheus exporter

If you prefer a stable approach, use the Prometheus ECS exporter as a sidecar container.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- 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.

@clayton-cornell clayton-cornell added the backport/v1.13 Backport to release/v1.13 label Feb 19, 2026
@clayton-cornell clayton-cornell enabled auto-merge (squash) February 19, 2026 04:57
@clayton-cornell clayton-cornell merged commit d37d130 into main Feb 19, 2026
62 of 64 checks passed
@clayton-cornell clayton-cornell deleted the docs/update-ecs-tutorial-ecs-connector branch February 19, 2026 05:12
grafana-alloybot bot pushed a commit that referenced this pull request Feb 19, 2026
…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)
clayton-cornell added a commit that referenced this pull request Feb 19, 2026
…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>
jharvey10 pushed a commit that referenced this pull request Feb 26, 2026
…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>
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Mar 6, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

backport/v1.13 Backport to release/v1.13 frozen-due-to-age type/docs Docs Squad label across all Grafana Labs repos

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Update "Collect Amazon Elastic Container Service or AWS Fargate OpenTelemetry data" topic to mention you can do this natively in alloy?

3 participants