event_hubs

README

Azure Event Hubs Output Plugin

This plugin writes metrics to the Azure Event Hubs service in any of the supported data formats. Metrics are sent as batches with each message payload containing one metric object, preferably as JSON as this eases integration with downstream components.

Each patch is sent to a single Event Hub within a namespace. In case no partition key is specified the batches will be automatically load-balanced (round-robin) across all the Event Hub partitions.

⭐ Telegraf v1.21.0 🏷️ cloud,datastore 💻 all

Global configuration options

Plugins support additional global and plugin configuration settings for tasks such as modifying metrics, tags, and fields, creating aliases, and configuring plugin ordering. See CONFIGURATION.md for more details.

Configuration

# Configuration for Event Hubs output plugin
[[outputs.event_hubs]]
  ## Full connection string to the Event Hub instance. The shared access key
  ## must have "Send" permissions on the target Event Hub.
  connection_string = "Endpoint=sb://namespace.servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=superSecret1234=;EntityPath=hubName"

  ## Partition key to use for the event
  ## Metric tag or field name to use for the event partition key. The value of
  ## this tag or field is set as the key for events if it exists. If both, tag
  ## and field, exist the tag is preferred.
  # partition_key = ""

  ## Set the maximum batch message size in bytes
  ## The allowable size depends on the Event Hub tier, see
  ##   https://learn.microsoft.com/azure/event-hubs/event-hubs-quotas#basic-vs-standard-vs-premium-vs-dedicated-tiers
  ## for details. If unset the default size defined by Azure Event Hubs is
  ## used (currently 1,000,000 bytes)
  # max_message_size = "1MB"

  ## Timeout for sending the data
  # timeout = "30s"

  ## Data format to output.
  ## Each data format has its own unique set of configuration options, read
  ## more about them here:
  ## https://github.com/netxops/unicontroller/blob/master/docs/DATA_FORMATS_OUTPUT.md
  data_format = "json"

Documentation

Index

• type EventHubs
  • func (e *EventHubs) Close() error
  • func (e *EventHubs) Connect() error
  • func (e *EventHubs) Init() error
  • func (*EventHubs) SampleConfig() string
  • func (e *EventHubs) SetSerializer(serializer telegraf.Serializer)
  • func (e *EventHubs) Write(metrics []telegraf.Metric) error

Types

type EventHubs

type EventHubs struct {
	ConnectionString string          `toml:"connection_string"`
	PartitionKey     string          `toml:"partition_key"`
	MaxMessageSize   config.Size     `toml:"max_message_size"`
	Timeout          config.Duration `toml:"timeout"`
	Log              telegraf.Logger `toml:"-"`
	// contains filtered or unexported fields
}

func (*EventHubs) Close

func (e *EventHubs) Close() error

func (*EventHubs) Connect

func (e *EventHubs) Connect() error

func (*EventHubs) Init

func (e *EventHubs) Init() error

func (*EventHubs) SampleConfig

func (*EventHubs) SampleConfig() string

func (*EventHubs) SetSerializer

func (e *EventHubs) SetSerializer(serializer telegraf.Serializer)

func (*EventHubs) Write

func (e *EventHubs) Write(metrics []telegraf.Metric) error