Use upstream ecs-agent types for deserializing API responses

.circleci/config.yml

@@ -6,7 +6,7 @@ executors:
   # Whenever the Go version is updated here, .promu.yml should also be updated.
   golang:
     docker:
-      - image: cimg/go:1.20
+      - image: cimg/go:1.23
 jobs:
   test:
     executor: golang

.promu.yml

@@ -1,7 +1,7 @@
 go:
     # Whenever the Go version is updated here, .travis.yml and
     # .circle/config.yml should also be updated.
-    version: 1.20
+    version: 1.23
 repository:
     path: github.com/prometheus-community/ecs_exporter
 build:

ecscollector/collector.go

@@ -19,8 +19,9 @@
 	"context"
 	"fmt"
 	"log"
+	"time"
 
 	"github.com/prometheus-community/ecs_exporter/ecsmetadata"
 	"github.com/prometheus/client_golang/prometheus"
 )
 
@@ -179,35 +180,42 @@
 		metadata.Revision,
 		metadata.DesiredStatus,
 		metadata.KnownStatus,
-		metadata.PullStartedAt,
-		metadata.PullStoppedAt,
+		metadata.PullStartedAt.Format(time.RFC3339Nano),
+		metadata.PullStoppedAt.Format(time.RFC3339Nano),
 		metadata.AvailabilityZone,
 		metadata.LaunchType,
 	)
 
-	ch <- prometheus.MustNewConstMetric(
-		svcCpuLimitDesc,
-		prometheus.GaugeValue,
-		float64(metadata.Limits.CPU),
-		svcLabels...,
-	)
-
-	ch <- prometheus.MustNewConstMetric(
-		svcMemLimitDesc,
-		prometheus.GaugeValue,
-		float64(metadata.Limits.Memory),
-		svcLabels...,
-	)
+	// Task CPU/memory limits are optional when running on EC2 - the relevant
+	// limits may only exist at the container level.
+	if metadata.Limits != nil {
+		if metadata.Limits.CPU != nil {
+			ch <- prometheus.MustNewConstMetric(
+				svcCpuLimitDesc,
+				prometheus.GaugeValue,
+				*metadata.Limits.CPU,
+				metadata.TaskARN,
+			)
+		}
+		if metadata.Limits.Memory != nil {
+			ch <- prometheus.MustNewConstMetric(
+				svcMemLimitDesc,
+				prometheus.GaugeValue,
+				float64(*metadata.Limits.Memory),
+				metadata.TaskARN,
+			)
+		}
+	}
 
 	stats, err := c.client.RetrieveTaskStats(ctx)
 	if err != nil {
 		log.Printf("Failed to retrieve container stats: %v", err)
 		return
 	}
 	for _, container := range metadata.Containers {
-		s := stats[container.DockerID]
+		s := stats[container.ID]
 		if s == nil {
-			log.Printf("Couldn't find container with ID %q in stats", container.DockerID)
+			log.Printf("Couldn't find container with ID %q in stats", container.ID)
 			continue
 		}
 
@@ -248,14 +256,14 @@
 			networkLabelVals := append(labelVals, iface)
 
 			for desc, value := range map[*prometheus.Desc]float64{
-				networkRxBytesDesc:   netStats.RxBytes,
-				networkRxPacketsDesc: netStats.RxPackets,
-				networkRxDroppedDesc: netStats.RxDropped,
-				networkRxErrorsDesc:  netStats.RxErrors,
-				networkTxBytesDesc:   netStats.TxBytes,
-				networkTxPacketsDesc: netStats.TxPackets,
-				networkTxDroppedDesc: netStats.TxDropped,
-				networkTxErrorsDesc:  netStats.TxErrors,
+				networkRxBytesDesc:   float64(netStats.RxBytes),
+				networkRxPacketsDesc: float64(netStats.RxPackets),
+				networkRxDroppedDesc: float64(netStats.RxDropped),
+				networkRxErrorsDesc:  float64(netStats.RxErrors),
+				networkTxBytesDesc:   float64(netStats.TxBytes),
+				networkTxPacketsDesc: float64(netStats.TxPackets),
+				networkTxDroppedDesc: float64(netStats.TxDropped),
+				networkTxErrorsDesc:  float64(netStats.TxErrors),
 			} {
 				ch <- prometheus.MustNewConstMetric(
 					desc,

ecsmetadata/client.go

@@ -1,4 +1,4 @@
 // Copyright 2021 The Prometheus Authors
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
 // You may obtain a copy of the License at
@@ -24,7 +24,7 @@
 	"net/url"
 	"os"
 
-	dockertypes "github.com/docker/docker/api/types"
+	tmdsv4 "github.com/aws/amazon-ecs-agent/ecs-agent/tmds/handlers/v4/state"
 )
 
 type Client struct {
@@ -58,14 +58,26 @@
 	return NewClient(endpoint), nil
 }
 
-func (c *Client) RetrieveTaskStats(ctx context.Context) (map[string]*ContainerStats, error) {
-	out := make(map[string]*ContainerStats)
+func (c *Client) RetrieveTaskStats(ctx context.Context) (map[string]*tmdsv4.StatsResponse, error) {
+	// https://github.com/aws/amazon-ecs-agent/blob/cf8c7a6b65043c550533f330b10aef6d0a342214/agent/handlers/v4/tmdsstate.go#L202
+	out := make(map[string]*tmdsv4.StatsResponse)
 	err := c.request(ctx, c.endpoint+"/task/stats", &out)
 	return out, err
 }
 
-func (c *Client) RetrieveTaskMetadata(ctx context.Context) (*TaskMetadata, error) {
-	var out TaskMetadata
+func (c *Client) RetrieveTaskMetadata(ctx context.Context) (*tmdsv4.TaskResponse, error) {
+	// https://github.com/aws/amazon-ecs-agent/blob/cf8c7a6b65043c550533f330b10aef6d0a342214/agent/handlers/v4/tmdsstate.go#L174
+	//
+	// Note that EC2 and Fargate return slightly different task metadata
+	// responses. At time of writing, as per the documentation, only EC2 has `ServiceName`,
+	// while only Fargate has `EphemeralStorageMetrics`, `ClockDrift`, and
+	// `Containers[].Snapshotter`. Ref:
+	// https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-metadata-endpoint-v4-fargate-response.html
+	// https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-metadata-endpoint-v4-response.html
+	//
+	// But `TaskResponse` is the _union_ of these two responses. It has all the
+	// fields.
+	var out tmdsv4.TaskResponse
 	err := c.request(ctx, c.endpoint+"/task", &out)
 	return &out, err
 }
@@ -88,84 +100,3 @@
 	}
 	return json.Unmarshal(body, out)
 }
-
-type ContainerStats struct {
-	Name     string  `json:"name"`
-	ID       string  `json:"id"`
-	NumProcs float64 `json:"num_procs"`
-	Read     string  `json:"read"`
-	PreRead  string  `json:"preread"`
-
-	CPUStats    dockertypes.CPUStats    `json:"cpu_stats"`
-	PreCPUStats dockertypes.CPUStats    `json:"precpu_stats"`
-	MemoryStats dockertypes.MemoryStats `json:"memory_stats"`
-	BlkioStats  dockertypes.BlkioStats  `json:"blkio_stats"`
-
-	Networks map[string]struct {
-		RxBytes   float64 `json:"rx_bytes"`
-		RxPackets float64 `json:"rx_packets"`
-		RxErrors  float64 `json:"rx_errors"`
-		RxDropped float64 `json:"rx_dropped"`
-		TxBytes   float64 `json:"tx_bytes"`
-		TxPackets float64 `json:"tx_packets"`
-		TxErrors  float64 `json:"tx_errors"`
-		TxDropped float64 `json:"tx_dropped"`
-	} `json:"networks"`
-
-	NetworkRateStats struct {
-		RxBytesPerSec float64 `json:"rx_bytes_per_sec"`
-		TxBytesPerSec float64 `json:"tx_bytes_per_sec"`
-	} `json:"network_rate_stats"`
-}
-
-type TaskMetadataLimits struct {
-	CPU    float64 `json:"CPU"`
-	Memory float64 `json:"Memory"`
-}
-
-type TaskMetadata struct {
-	Cluster          string             `json:"Cluster"`
-	TaskARN          string             `json:"TaskARN"`
-	Family           string             `json:"Family"`
-	Revision         string             `json:"Revision"`
-	DesiredStatus    string             `json:"DesiredStatus"`
-	KnownStatus      string             `json:"KnownStatus"`
-	Limits           TaskMetadataLimits `json:"Limits"`
-	PullStartedAt    string             `json:"PullStartedAt"`
-	PullStoppedAt    string             `json:"PullStoppedAt"`
-	AvailabilityZone string             `json:"AvailabilityZone"`
-	LaunchType       string             `json:"LaunchType"`
-	Containers       []struct {
-		DockerID      string            `json:"DockerId"`
-		Name          string            `json:"Name"`
-		DockerName    string            `json:"DockerName"`
-		Image         string            `json:"Image"`
-		ImageID       string            `json:"ImageID"`
-		Labels        map[string]string `json:"Labels"`
-		DesiredStatus string            `json:"DesiredStatus"`
-		KnownStatus   string            `json:"KnownStatus"`
-		CreatedAt     string            `json:"CreatedAt"`
-		StartedAt     string            `json:"StartedAt"`
-		Type          string            `json:"Type"`
-		Networks      []struct {
-			NetworkMode              string   `json:"NetworkMode"`
-			IPv4Addresses            []string `json:"IPv4Addresses"`
-			IPv6Addresses            []string `json:"IPv6Addresses"`
-			AttachmentIndex          float64  `json:"AttachmentIndex"`
-			MACAddress               string   `json:"MACAddress"`
-			IPv4SubnetCIDRBlock      string   `json:"IPv4SubnetCIDRBlock"`
-			IPv6SubnetCIDRBlock      string   `json:"IPv6SubnetCIDRBlock"`
-			DomainNameServers        []string `json:"DomainNameServers"`
-			DomainNameSearchList     []string `json:"DomainNameSearchList"`
-			PrivateDNSName           string   `json:"PrivateDNSName"`
-			SubnetGatewayIpv4Address string   `json:"SubnetGatewayIpv4Address"`
-		} `json:"Networks"`
-		ClockDrift []struct {
-			ClockErrorBound            float64 `json:"ClockErrorBound"`
-			ReferenceTimestamp         string  `json:"ReferenceTimestamp"`
-			ClockSynchronizationStatus string  `json:"ClockSynchronizationStatus"`
-		} `json:"ClockDrift"`
-		ContainerARN string `json:"ContainerARN"`
-		LogDriver    string `json:"LogDriver"`
-	} `json:"Containers"`
-}

go.mod

@@ -1,28 +1,32 @@
 module github.com/prometheus-community/ecs_exporter
 
-go 1.20
+go 1.22
 
 require (
-	github.com/docker/docker v24.0.2+incompatible
+	github.com/aws/amazon-ecs-agent/ecs-agent v0.0.0-20240920192628-cf8c7a6b6504
 	github.com/prometheus/client_golang v1.15.1
 )
 
 require (
+	github.com/aws/aws-sdk-go v1.51.3 // indirect
 	github.com/beorn7/perks v1.0.1 // indirect
 	github.com/cespare/xxhash/v2 v2.2.0 // indirect
+	github.com/cihub/seelog v0.0.0-20170130134532-f561c5e57575 // indirect
+	github.com/docker/docker v24.0.9+incompatible // indirect
 	github.com/docker/go-connections v0.4.0 // indirect
-	github.com/docker/go-units v0.4.0 // indirect
-	github.com/gogo/protobuf v1.1.1 // indirect
-	github.com/golang/protobuf v1.5.3 // indirect
+	github.com/docker/go-units v0.5.0 // indirect
+	github.com/gogo/protobuf v1.3.2 // indirect
+	github.com/golang/protobuf v1.5.4 // indirect
+	github.com/gorilla/mux v1.8.0 // indirect
+	github.com/jmespath/go-jmespath v0.4.0 // indirect
 	github.com/matttproud/golang_protobuf_extensions v1.0.4 // indirect
 	github.com/opencontainers/go-digest v1.0.0 // indirect
-	github.com/opencontainers/image-spec v1.0.2 // indirect
+	github.com/opencontainers/image-spec v1.1.0-rc3 // indirect
 	github.com/pkg/errors v0.9.1 // indirect
-	github.com/pmezard/go-difflib v1.0.0 // indirect
 	github.com/prometheus/client_model v0.3.0 // indirect
 	github.com/prometheus/common v0.42.0 // indirect
 	github.com/prometheus/procfs v0.9.0 // indirect
-	golang.org/x/sys v0.6.0 // indirect
-	google.golang.org/protobuf v1.30.0 // indirect
-	gotest.tools/v3 v3.3.0 // indirect
+	golang.org/x/exp v0.0.0-20231006140011-7918f672742d // indirect
+	golang.org/x/sys v0.25.0 // indirect
+	google.golang.org/protobuf v1.33.0 // indirect
 )