Categorygithub.com/coveo/ecs-exporter
repository
1.1.1
Repository: https://github.com/coveo/ecs-exporter.git
Documentation: pkg.go.dev

# Packages

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# README

ECS exporter Build Status

Export AWS ECS cluster metrics to Prometheus

make
./bin/ecs-exporter --aws.region="${AWS_REGION}"

Notes:

  • This exporter will listen by default on the port 9222
  • Requires AWS credentials or permission from an EC2 instance

Exported Metrics

MetricMeaningLabels
ecs_upWas the last query of ecs successfulregion
ecs_clustersThe total number of clustersregion
ecs_servicesThe total number of servicesregion, cluster
ecs_service_desired_tasksThe desired number of instantiations of the task definition to keep running regarding a serviceregion, cluster, service
ecs_service_pending_tasksThe number of tasks in the cluster that are in the PENDING state regarding a serviceregion, cluster, service
ecs_service_running_tasksThe number of tasks in the cluster that are in the RUNNING state regarding a serviceregion, cluster, service
ecs_container_instancesThe total number of container instancesregion, cluster
ecs_container_instance_agent_connectedThe connected state of the container instance agentregion, cluster, instance
ecs_container_instance_activeThe status of the container instance in ACTIVE state, indicates that the container instance can accept tasks.region, cluster, instance
ecs_container_instance_pending_tasksThe number of tasks on the container instance that are in the PENDING status.region, cluster, instance

Flags

  • aws.region: The AWS region to get metrics from
  • aws.cluster-filter: Regex used to filter the cluster names, if doesn't match the cluster is ignored (default ".*")
  • debug: Run exporter in debug mode
  • web.listen-address: Address to listen on (default ":9222")
  • web.telemetry-path: The path where metrics will be exposed (default "/metrics")
  • metrics.disable-cinstances: Disable clusters container instances metrics gathering

Docker

You can deploy this exporter using the slok/ecs-exporter Docker image.

Note: Requires AWS credentials or permission from an EC2 instance, for example you can pass the env vars using -e AWS_ACCESS_KEY_ID=${AWS_ACCESS_KEY_ID} -e AWS_SECRET_ACCESS_KEY=${AWS_SECRET_ACCESS_KEY} options

For example:

docker pull slok/ecs-exporter
docker run -d -p 9222:9222 slok/ecs-exporter -aws.region="eu-west-1"