ECS Service Discovery

Yet another tool to perform ECS API based service discovery. Primarily aimed at gapping the lack of integrations for ECS Anywhere.

Features

• Creates Prometheus scraping configuration, from scanning ECS clusters & services, based on docker labels

Installation

Docker

Head to Public ECR to obtain the image

docker run --rm -it -v ~/.aws:/root/.aws public.ecr.aws/compose-x/ecs-service-discovery

Python

For your user only

pip install pip --user ecs-service-discovery

Via virtual environment

pip install ecs-service-discovery

Usage

usage: ecs-sd [-h] [-d OUTPUT_DIR] [--profile PROFILE] [-p PROMETHEUS_PORT] [--intervals INTERVALS] [--prometheus-output-format PROMETHEUS_OUTPUT_FORMAT] [_ ...]

positional arguments:
  _

options:
  -h, --help            show this help message and exit
  -d OUTPUT_DIR, --output_dir OUTPUT_DIR
  --profile PROFILE     aws profile to use. Defaults to SDK default behaviour
  -p PROMETHEUS_PORT, --prometheus-port PROMETHEUS_PORT
  --intervals INTERVALS
                        Time between ECS discovery intervals
  --prometheus-output-format PROMETHEUS_OUTPUT_FORMAT
                        Change the format of generated files. JSON or YAML.

Examples

ECS Compose-X

Install ecs-compose-x & deploy to AWS

Hint

you will need to use the x-vpc extension to deploy the service in the right VPC to get prometheus scraping. you can use the x-cluster extension to specify the ECS Cluster you want to deploy the service to.

Docker Compose

After cloning the repository, run docker compose up. It will spin the service discovery, along with prometheus & grafana to run the demo with. You can access prometheus via localhost:9090 and grafana via localhost:3000 (admin:admin by default).

In prometheus, you can look at the configuration and service discovery. You should see the discovered targets that prometheus is going to try to scrape.

AWS Policy requirements

PolicyName: ECSServiceDiscoverySimple
PolicyDocument:
  Version: "2012-10-17"
  Statement:
    - Effect: Allow
      Action:
        - ecs:ListClusters
        - ecs:ListContainerInstances
        - ecs:ListTasks
        - ecs:DescribeContainerInstances
        - ssm:DescribeInstanceInformation
        - ecs:DescribeTasks
        - ecs:DescribeTaskDefinition
      Resource: '*'