collector

Documentation

Index

• type CWClient
  • func NewCWClient(awsRegion string, roleArn string) (*CWClient, error)
  • func (cw *CWClient) GetClusterContainerInstancesMetrics(instance *types.ECSContainerInstance) (*types.InstanceMetrics, error)
  • func (cw *CWClient) GetClusterMetrics(cluster *types.ECSCluster, metricName string) (float64, error)
• type CWGatherer
• type ECSClient
  • func NewECSClient(awsRegion string, roleArn string) (*ECSClient, error)
  • func (e *ECSClient) GetClusterContainerInstances(cluster *types.ECSCluster) ([]*types.ECSContainerInstance, error)
  • func (e *ECSClient) GetClusterScalableTargets(cluster *types.ECSCluster) ([]*types.ECSScalableTarget, error)
  • func (e *ECSClient) GetClusterServices(cluster *types.ECSCluster) ([]*types.ECSService, error)
  • func (e *ECSClient) GetClusters() ([]*types.ECSCluster, error)
• type ECSGatherer
• type Exporter
  • func New(awsRegion string, roleArn string, clusterFilterRegexp string, ...) (*Exporter, error)
  • func (e *Exporter) Collect(ch chan<- prometheus.Metric)
  • func (e *Exporter) Describe(ch chan<- *prometheus.Desc)

Types

type CWClient

type CWClient struct {
	// contains filtered or unexported fields
}

CWClient is a wrapper for AWS ecs client that implements helpers to get ECS clusters metrics

func NewCWClient

func NewCWClient(awsRegion string, roleArn string) (*CWClient, error)

NewCWClient create a Cloudwatch API client

func (*CWClient) GetClusterContainerInstancesMetrics

func (cw *CWClient) GetClusterContainerInstancesMetrics(instance *types.ECSContainerInstance) (*types.InstanceMetrics, error)

GetClusterContainerInstancesMetrics return metric for an instance

func (*CWClient) GetClusterMetrics

func (cw *CWClient) GetClusterMetrics(cluster *types.ECSCluster, metricName string) (float64, error)

GetClusterMetrics return metric for an cluster

type CWGatherer

type CWGatherer interface {
	GetClusterContainerInstancesMetrics(instance *types.ECSContainerInstance) (*types.InstanceMetrics, error)
	GetClusterMetrics(cluster *types.ECSCluster, metricName string) (float64, error)
}

CWGatherer is the interface that implements the methods required to gather cloudwath data

type ECSClient

type ECSClient struct {
	// contains filtered or unexported fields
}

ECSClient is a wrapper for AWS ecs client that implements helpers to get ECS clusters metrics

func NewECSClient

func NewECSClient(awsRegion string, roleArn string) (*ECSClient, error)

NewECSClient will return an initialized ECSClient

func (*ECSClient) GetClusterContainerInstances

func (e *ECSClient) GetClusterContainerInstances(cluster *types.ECSCluster) ([]*types.ECSContainerInstance, error)

GetClusterContainerInstances will return all the container instances from a cluster

func (*ECSClient) GetClusterScalableTargets

func (e *ECSClient) GetClusterScalableTargets(cluster *types.ECSCluster) ([]*types.ECSScalableTarget, error)

GetClusterScalableTargets will return all the scalable targets for the cluster

func (*ECSClient) GetClusterServices

func (e *ECSClient) GetClusterServices(cluster *types.ECSCluster) ([]*types.ECSService, error)

GetClusterServices will return all the services from a cluster

func (*ECSClient) GetClusters

func (e *ECSClient) GetClusters() ([]*types.ECSCluster, error)

GetClusters will get the clusters from the ECS API

type ECSGatherer

type ECSGatherer interface {
	GetClusters() ([]*types.ECSCluster, error)
	GetClusterServices(cluster *types.ECSCluster) ([]*types.ECSService, error)
	GetClusterScalableTargets(cluster *types.ECSCluster) ([]*types.ECSScalableTarget, error)
	GetClusterContainerInstances(cluster *types.ECSCluster) ([]*types.ECSContainerInstance, error)
}

ECSGatherer is the interface that implements the methods required to gather ECS data

type Exporter

type Exporter struct {
	sync.Mutex             // Our exporter object will be locakble to protect from concurrent scrapes
	ECSClient  ECSGatherer // Custom ECS client to get information from the clusters
	CWClient   CWGatherer  // Custom CW client to get information from the cloudwatch
	// contains filtered or unexported fields
}

Exporter collects ECS clusters metrics

func New

func New(awsRegion string, roleArn string, clusterFilterRegexp string, disableCIMetrics bool) (*Exporter, error)

New returns an initialized exporter

func (*Exporter) Collect

func (e *Exporter) Collect(ch chan<- prometheus.Metric)

Collect fetches the stats from configured ECS and delivers them as Prometheus metrics. It implements prometheus.Collector

func (*Exporter) Describe

func (e *Exporter) Describe(ch chan<- *prometheus.Desc)

Describe describes all the metrics ever exported by the ECS exporter. It implements prometheus.Collector.