AWS ECS Fargate Metrics

Metrics

Install Integration

Telegraf ECS/Fargate plugin

The Telegraf Amazon ECS plugin is Fargate compatible. It uses the ECS metadata and the stats API endpoints to gether stats on the containers in the Task it is configured in.

The telegraf container must be run in the same Task as the workload you with to collect stats for.

Prepare the Configuration file

You will need to prepare the telegraf-ecs.conf file with the contents of the next step.

As a ECS user you likely already have a solution for loading a configuration file into a container.

For demonstration purposes we will be using a remote configuration file, this would not be the recommended solution for a production environment.

Configure the Telegraf input plugin

You can download a copy of the configuration file that you will need telegraf-ecs.conf (opens in a new tab).

Or a copy of the configuration file is below.

[[inputs.ecs]]
  ## ECS metadata url.
  ## Metadata v2 API is used if set explicitly. Otherwise,
  ## v3 metadata endpoint API is used if available.
  # endpoint_url = ""
 
  ## Containers to include and exclude. Globs accepted.
  ## Note that an empty array for both will include all containers
  # container_name_include = []
  # container_name_exclude = []
 
  ## Container states to include and exclude. Globs accepted.
  ## When empty only containers in the "RUNNING" state will be captured.
  ## Possible values are "NONE", "PULLED", "CREATED", "RUNNING",
  ## "RESOURCES_PROVISIONED", "STOPPED".
  # container_status_include = []
  # container_status_exclude = []
 
  ## ecs labels to include and exclude as tags.  Globs accepted.
  ## Note that an empty array for both will include all labels as tags
  ecs_label_include = [ "com.amazonaws.ecs.*" ]
  ecs_label_exclude = []
 
  ## Timeout for queries.
  # timeout = "5s"
 
[[outputs.http]]
  url = "${LOGIT_METRICS_URL}"
  data_format = "prometheusremotewrite"
 
  [outputs.http.headers]
    Content-Type = "application/x-protobuf"
    Content-Encoding = "snappy"

Configure an additional container on your Task Template

You will need to do this for each task you wish to monitor

Add an additional container to your existing task or as part of your container images

Demonstration configuration only

Name: Telegraf
Image URI: telegraf:latest
Environment variables:
  LOGIT_METRICS_URL = "https://@metricsUsername:@metricsPassword@@metrics_id-vm.logit.io:@vmAgentPort/api/v1/write"
Docker configuration - Command:
  "--config", "https://cdn.logit.io/telegraf-ecs.conf"

View your metrics

Data should now have been sent to your Stack.

If you don't see take a look at How to diagnose no data in Stack below for how to diagnose common issues.

How to diagnose no data in Stack

If you don't see data appearing in your stack after following this integration, take a look at the troubleshooting guide for steps to diagnose and resolve the problem or contact our support team and we'll be happy to assist.