cloudwatch

README

Amazon CloudWatch Output for Telegraf

This plugin will send metrics to Amazon CloudWatch.

Amazon Authentication

This plugin uses a credential chain for Authentication with the CloudWatch API endpoint. In the following order the plugin will attempt to authenticate.

1. Assumed credentials via STS if role_arn attribute is specified (source credentials are evaluated from subsequent rules)
2. Explicit credentials from access_key, secret_key, and token attributes
3. Shared profile from profile attribute
4. Environment Variables
5. Shared Credentials
6. EC2 Instance Profile

The IAM user needs only the cloudwatch:PutMetricData permission.

Config

For this output plugin to function correctly the following variables must be configured.

• region
• namespace

region

The region is the Amazon region that you wish to connect to. Examples include but are not limited to:

• us-west-1
• us-west-2
• us-east-1
• ap-southeast-1
• ap-southeast-2

namespace

The namespace used for AWS CloudWatch metrics.

write_statistics

If you have a large amount of metrics, you should consider to send statistic values instead of raw metrics which could not only improve performance but also save AWS API cost. If enable this flag, this plugin would parse the required CloudWatch statistic fields (count, min, max, and sum) and send them to CloudWatch. You could use basicstats aggregator to calculate those fields. If not all statistic fields are available, all fields would still be sent as raw metrics.

high_resolution_metrics

Enable high resolution metrics (1 second precision) instead of standard ones (60 seconds precision)

Documentation

Index

• func BuildDimensions(mTags map[string]string) []*cloudwatch.Dimension
• func BuildMetricDatum(buildStatistic bool, highResolutionMetrics bool, point telegraf.Metric) []*cloudwatch.MetricDatum
• func PartitionDatums(size int, datums []*cloudwatch.MetricDatum) [][]*cloudwatch.MetricDatum
• type CloudWatch
  • func (c *CloudWatch) Close() error
  • func (c *CloudWatch) Connect() error
  • func (c *CloudWatch) Description() string
  • func (c *CloudWatch) SampleConfig() string
  • func (c *CloudWatch) Write(metrics []telegraf.Metric) error
  • func (c *CloudWatch) WriteToCloudWatch(datums []*cloudwatch.MetricDatum) error

Functions

func BuildDimensions

func BuildDimensions(mTags map[string]string) []*cloudwatch.Dimension

Make a list of Dimensions by using a Point's tags. CloudWatch supports up to 10 dimensions per metric so we only keep up to the first 10 alphabetically. This always includes the "host" tag if it exists.

func BuildMetricDatum

func BuildMetricDatum(buildStatistic bool, highResolutionMetrics bool, point telegraf.Metric) []*cloudwatch.MetricDatum

Make a MetricDatum from telegraf.Metric. It would check if all required fields of cloudwatch.StatisticSet are available. If so, it would build MetricDatum from statistic values. Otherwise, fields would still been built independently.

func PartitionDatums

func PartitionDatums(size int, datums []*cloudwatch.MetricDatum) [][]*cloudwatch.MetricDatum

Partition the MetricDatums into smaller slices of a max size so that are under the limit for the AWS API calls.

Types

type CloudWatch

type CloudWatch struct {
	Region      string `toml:"region"`
	AccessKey   string `toml:"access_key"`
	SecretKey   string `toml:"secret_key"`
	RoleARN     string `toml:"role_arn"`
	Profile     string `toml:"profile"`
	Filename    string `toml:"shared_credential_file"`
	Token       string `toml:"token"`
	EndpointURL string `toml:"endpoint_url"`

	Namespace             string `toml:"namespace"` // CloudWatch Metrics Namespace
	HighResolutionMetrics bool   `toml:"high_resolution_metrics"`

	WriteStatistics bool `toml:"write_statistics"`
	// contains filtered or unexported fields
}

func (*CloudWatch) Close

func (c *CloudWatch) Close() error

func (*CloudWatch) Connect

func (c *CloudWatch) Connect() error

func (*CloudWatch) Description

func (c *CloudWatch) Description() string

func (*CloudWatch) SampleConfig

func (c *CloudWatch) SampleConfig() string

func (*CloudWatch) Write

func (c *CloudWatch) Write(metrics []telegraf.Metric) error

func (*CloudWatch) WriteToCloudWatch

func (c *CloudWatch) WriteToCloudWatch(datums []*cloudwatch.MetricDatum) error