datadog

Documentation

Overview

Package datadog implements a kafkametrics Handler.

Index

• func NewHandler(c *Config) (kafkametrics.Handler, error)
• type Config

Functions

func NewHandler

func NewHandler(c *Config) (kafkametrics.Handler, error)

NewHandler takes a *Config and returns a Handler, along with any credential validation errors. Further backends can be supported with a type switch and some other changes.

Types

type Config

type Config struct {
	// Datadog API key.
	APIKey string
	// Datadog app key.
	AppKey string
	// NetworkTXQuery is a query string that should return the outbound
	// network metrics by host for the reference Kafka brokers.
	// Example (Datadog): "avg:system.net.bytes_sent{service:kafka} by {host}"
	NetworkTXQuery string
	// NetworkRXQuery is a query string that should return the inbound
	// network metrics by host for the reference Kafka brokers.
	// Example (Datadog): "avg:system.net.bytes_rcvd{service:kafka} by {host}"
	NetworkRXQuery string
	// BrokerIDTag is the host tag name for Kafka broker IDs.
	BrokerIDTag string
	// InstanceTypeTag is the tag name for the kafka broker's instance type.
	InstanceTypeTag string
	// MetricsWindow specifies the window size of timeseries data to evaluate
	// in seconds. All values for the window are averaged.
	MetricsWindow int
}

Config holds Handler configuration parameters.