cloudwatch

README

CloudWatch

This sink sends metrics to AWS CloudWatch.

Configuration

metric_sinks:
  - kind: cloudwatch
    name: cloudwatch
    config:
      aws_region: us-east-1
      cloudwatch_namespace: veneur

Additional options

• aws_disable_retries (default: false): Configure the AWS SDK to not retry
• cloudwatch_endpoint: Specify a custom endpoint to use in place of the standard monitoring endpoint
• cloudwatch_standard_unit_tag_name (default: cloudwatch_standard_unit): Specify a standard unit on a per-metric-datum basis, e.g. "Seconds", "Bytes"
• remote_timeout (default: 30s): Specify an HTTP client timeout, after which the sink will fail if it has not received a PutMetricData response
• strip_tags (default: []): Specify tags that should be stripped from samples before flushing to CloudWatch

Status

This sink is experimental. It is functional, but use caution for production workloads.

Documentation

Index

• Constants
• func Create(server *veneur.Server, name string, logger *logrus.Entry, config veneur.Config, ...) (sinks.MetricSink, error)
• func NewCloudwatchMetricSink(endpoint, namespace, region string, standardUnitTagName types.StandardUnit, ...) *cloudwatchMetricSink
• func ParseConfig(name string, config interface{}) (veneur.MetricSinkConfig, error)
• type CloudwatchMetricSinkConfig

Constants

const (
	DefaultCloudwatchStandardUnitTagName = "cloudwatch_standard_unit"
	DefaultRemoteTimeout                 = time.Duration(30 * time.Second)
)

Functions

func Create

func Create(
	server *veneur.Server, name string, logger *logrus.Entry,
	config veneur.Config, sinkConfig veneur.MetricSinkConfig,
) (sinks.MetricSink, error)

func NewCloudwatchMetricSink

func NewCloudwatchMetricSink(
	endpoint, namespace, region string, standardUnitTagName types.StandardUnit,
	remoteTimeout time.Duration, disableRetries bool, stripTags []string, logger *logrus.Entry,
) *cloudwatchMetricSink

func ParseConfig

func ParseConfig(name string, config interface{}) (veneur.MetricSinkConfig, error)

Types

type CloudwatchMetricSinkConfig

type CloudwatchMetricSinkConfig struct {
	AWSRegion                     string             `yaml:"aws_region"`
	AWSDisableRetries             bool               `yaml:"aws_disable_retries"`
	CloudwatchEndpoint            string             `yaml:"cloudwatch_endpoint"`
	CloudwatchNamespace           string             `yaml:"cloudwatch_namespace"`
	CloudwatchStandardUnitTagName types.StandardUnit `yaml:"cloudwatch_standard_unit_tag_name"`
	RemoteTimeout                 time.Duration      `yaml:"remote_timeout"`
	StripTags                     []string           `yaml:"strip_tags"`
}