kinesis

Documentation

Index

• func Description() string
• func SampleConfig() string
• type KinesisOutput
  • func NewKinesisOutput(configFilePath string) (*KinesisOutput, error)
  • func (k *KinesisOutput) Close() error
  • func (k *KinesisOutput) Connect() error
  • func (k *KinesisOutput) Write(metrics []telegraf.Metric) error
• type Partition

Functions

func Description

func Description() string

Description returns a short description of the plugin

func SampleConfig

func SampleConfig() string

SampleConfig will return a sample configuration that can be used.

Types

type KinesisOutput

type KinesisOutput 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"`

	StreamName         string                  `toml:"streamname"`
	Partition          *Partition              `toml:"partition"`
	Debug              bool                    `toml:"debug"`
	AggregateMetrics   bool                    `toml:"aggregate_metrics"`
	OverrideShardCount int                     `toml:"override_shard_count"`
	ContentEncoding    string                  `toml:"content_encoding"`
	Formatting         *serializerclone.Config `toml:"formatting"`
	// contains filtered or unexported fields
}

KinesisOutput describes a telegraf kinesis output plugin

func NewKinesisOutput

func NewKinesisOutput(configFilePath string) (*KinesisOutput, error)

NewKinesisOutput returns a Kinesis Output that is ready to connect and be used to send data. An error is also returned if something goes wrong.

func (*KinesisOutput) Close

func (k *KinesisOutput) Close() error

Close does nothing but is required by the telegraf plugin interface

func (*KinesisOutput) Connect

func (k *KinesisOutput) Connect() error

Connect will establish a connection to AWS Kinesis and make sure there are shards ready to collect data.

func (*KinesisOutput) Write

func (k *KinesisOutput) Write(metrics []telegraf.Metric) error

type Partition

type Partition struct {
	Method  string `toml:"method"`
	Key     string `toml:"key"`
	Default string `toml:"default"`
}

Partition is used to detect what type of partition key you would like to use.