Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[otel-ecs-fargate] Document the fleet management feature in ECS Fargate #494

Merged
merged 3 commits into from
Dec 30, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion otel-ecs-fargate/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

The OpenTelemetry collector offers a vendor-agnostic implementation of how to receive, process and export telemetry data.

In this document, we'll explain how to add the OTEL collector as a sidecar agent to your ECS Task Definitions. We use the standard Opentelemetry Collector Contrib distribution but leverage the envprovider to generate the configuration from an AWS SSM Parameter Store. There is an example cloudformation template for review [here](https://github.com/coralogix/cloudformation-coralogix-aws/tree/master/aws-integrations/ecs-fargate)
In this document, we'll explain how to add the OTEL collector as a sidecar agent to your ECS Task Definitions. We use the standard Opentelemetry Collector Contrib distribution but leverage the envprovider to generate the configuration from an AWS SSM Parameter Store. There is an example cloudformation template for review [here](https://github.com/coralogix/cloudformation-coralogix-aws/tree/master/aws-integrations/ecs-fargate)

The envprovider is used for loading of the OpenTelemetry configuration via Systems Manager Parameter Stores. This makes adjusting your configuration more convenient and more dynamic than baking a static configuration into your container image.

Expand Down
19 changes: 17 additions & 2 deletions otel-ecs-fargate/parameter_store_cf.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -27,20 +27,34 @@ Resources:
Description: Configuration parameter for Coralogix OTEL Collector
Type: String
Value: |
extensions:
# The OpAMP extension below enables the Coralogix fleet management server connection.
# Uncomment them to enable the feature and add the "opamp" extension to the list under `service.extensions`.
# opamp:
# server:
# http:
# endpoint: "https://ingress.${env:CORALOGIX_DOMAIN}/opamp/v1"
# polling_interval: 2m
# headers:
# Authorization: "Bearer ${env:PRIVATE_KEY}"
# agent_description:
# non_identifying_attributes:
# cx.agent.type: "agent"
# cx.integrationID: "ecs-fargate"
exporters:
coralogix:
application_name: 'otel'
application_name_attributes:
- aws.ecs.task.family
- service.namespace
domain: ${CORALOGIX_DOMAIN}
domain: ${env:CORALOGIX_DOMAIN}
logs:
headers:
X-Coralogix-Distribution: ecs-fargate-integration/0.0.1
metrics:
headers:
X-Coralogix-Distribution: ecs-fargate-integration/0.0.1
private_key: ${PRIVATE_KEY}
private_key: ${env:PRIVATE_KEY}
subsystem_name: 'integration'
subsystem_name_attributes:
- service.name
Expand Down Expand Up @@ -118,6 +132,7 @@ Resources:
- targets:
- 127.0.0.1:8888
service:
extensions: []
pipelines:
logs:
exporters:
Expand Down
Loading