ecs

Documentation

Overview

Package ecs provides metadata collection when the Agent runs on the ECS platform

Index

• func IsFargateInstance() bool
• func IsInstance() bool
• type CPUStats
• type CPUUsage
• type Container
• type ContainerStats
• type DetailedMem
• type IOStats
• type MemStats
• type NetStats
• type Network
• type OPStat
• type TaskMetadata
  • func GetTaskMetadata() (TaskMetadata, error)

Functions

func IsFargateInstance

func IsFargateInstance() bool

IsFargateInstance returns whether the agent is in an ECS fargate task. It detects it by getting and unmarshalling the metadata API response.

func IsInstance

func IsInstance() bool

IsInstance returns whether this host is part of an ECS cluster

Types

type CPUStats

type CPUStats struct {
	Usage  CPUUsage `json:"cpu_usage"`
	System uint64   `json:"system_cpu_usage"`
}

CPUStats represents an ECS container CPU usage

type CPUUsage

type CPUUsage struct {
	Total      uint64 `json:"total_usage"`
	Usermode   uint64 `json:"usage_in_usermode"`
	Kernelmode uint64 `json:"usage_in_kernelmode"`
}

CPUUsage represents the details of ECS container CPU usage

type Container

type Container struct {
	Name          string            `json:"Name"`
	Limits        map[string]uint64 `json:"Limits"`
	ImageID       string            `json:"ImageID,omitempty"`
	StartedAt     string            `json:"StartedAt"` // 2017-11-17T17:14:07.781711848Z
	DockerName    string            `json:"DockerName"`
	Type          string            `json:"Type"`
	Image         string            `json:"Image"`
	Labels        map[string]string `json:"Labels"`
	KnownStatus   string            `json:"KnownStatus"`
	DesiredStatus string            `json:"DesiredStatus"`
	DockerID      string            `json:"DockerID"`
	CreatedAt     string            `json:"CreatedAt"`
	Networks      []Network         `json:"Networks"`
	Ports         string            `json:"Ports"`
}

Container is the representation of a container as exposed by the ECS metadata API

type ContainerStats

type ContainerStats struct {
	CPU     CPUStats `json:"cpu_stats"`
	Memory  MemStats `json:"memory_stats"`
	IO      IOStats  `json:"blkio_stats"`
	Network NetStats `json:"network"`
}

ContainerStats represents the stats payload for a container reported by the ecs stats api.

type DetailedMem

type DetailedMem struct {
	RSS      uint64 `json:"rss"`
	Cache    uint64 `json:"cache"`
	Usage    uint64 `json:"usage"`
	MaxUsage uint64 `json:"max_usage"`
	Limit    uint64 `json:"hierarchical_memory_limit"`
	PgFault  uint64 `json:"pgfault"`
}

DetailedMem stores detailed stats about memory usage

type IOStats

type IOStats struct {
	BytesPerDeviceAndKind []OPStat `json:"io_service_bytes_recursive"`
	OPPerDeviceAndKind    []OPStat `json:"io_serviced_recursive"`
	ReadBytes             uint64   // calculated by aggregating OPStats
	WriteBytes            uint64   // calculated by aggregating OPStats
}

IOStats represents an ECS container IO throughput

type MemStats

type MemStats struct {
	Details DetailedMem `json:"stats"`
}

MemStats represents an ECS container memory usage

type NetStats

type NetStats struct {
	RxBytes   uint64 `json:"rx_bytes"`
	RxPackets uint64 `json:"rx_packets"`
	TxBytes   uint64 `json:"tx_bytes"`
	TxPackets uint64 `json:"tx_packets"`
}

NetStats represents an ECS container network usage

type Network

type Network struct {
	NetworkMode   string   `json:"NetworkMode"`   // as of today the only supported mode is awsvpc
	IPv4Addresses []string `json:"IPv4Addresses"` // one-element list
}

Network represents the network of a container

type OPStat

type OPStat struct {
	Major int64  `json:"major"`
	Minor int64  `json:"minor"`
	Kind  string `json:"op"`
	Value uint64 `json:"value"`
}

OPStat stores a value (amount of op or bytes) for a kind of operation and a specific block device.

type TaskMetadata

type TaskMetadata struct {
	ClusterName   string         `json:"Cluster"`
	Containers    []Container    `json:"Containers"`
	KnownStatus   string         `json:"KnownStatus"`
	TaskARN       string         `json:"TaskARN"`
	Family        string         `json:"Family"`
	Version       string         `json:"Version"`
	Limits        map[string]int `json:"Limits"`
	DesiredStatus string         `json:"DesiredStatus"`
}

TaskMetadata is the info returned by the ECS task metadata API

func GetTaskMetadata

func GetTaskMetadata() (TaskMetadata, error)

GetTaskMetadata extracts the metadata payload for the task the agent is in.