kafka

Documentation

Index

• Variables
• type Arguments
  • func (a *Arguments) Convert() *kafka_exporter.Config
  • func (a *Arguments) SetToDefault()
  • func (a *Arguments) Validate() error

Variables

var DefaultArguments = Arguments{
	UseSASLHandshake:        true,
	KafkaVersion:            sarama.V2_0_0_0.String(),
	MetadataRefreshInterval: "1m",
	AllowConcurrent:         true,
	MaxOffsets:              1000,
	PruneIntervalSeconds:    30,
	OffsetShowAll:           true,
	TopicWorkers:            100,
	TopicsFilter:            ".*",
	TopicsExclude:           "^$",
	GroupFilter:             ".*",
	GroupExclude:            "^$",
}

Types

type Arguments

type Arguments struct {
	Instance                string            `alloy:"instance,attr,optional"`
	KafkaURIs               []string          `alloy:"kafka_uris,attr,optional"`
	UseSASL                 bool              `alloy:"use_sasl,attr,optional"`
	UseSASLHandshake        bool              `alloy:"use_sasl_handshake,attr,optional"`
	SASLUsername            string            `alloy:"sasl_username,attr,optional"`
	SASLPassword            alloytypes.Secret `alloy:"sasl_password,attr,optional"`
	SASLMechanism           string            `alloy:"sasl_mechanism,attr,optional"`
	SASLDisablePAFXFast     bool              `alloy:"sasl_disable_pafx_fast,attr,optional"`
	UseTLS                  bool              `alloy:"use_tls,attr,optional"`
	TlsServerName           string            `alloy:"tls_server_name,attr,optional"`
	CAFile                  string            `alloy:"ca_file,attr,optional"`
	CertFile                string            `alloy:"cert_file,attr,optional"`
	KeyFile                 string            `alloy:"key_file,attr,optional"`
	InsecureSkipVerify      bool              `alloy:"insecure_skip_verify,attr,optional"`
	KafkaVersion            string            `alloy:"kafka_version,attr,optional"`
	UseZooKeeperLag         bool              `alloy:"use_zookeeper_lag,attr,optional"`
	ZookeeperURIs           []string          `alloy:"zookeeper_uris,attr,optional"`
	ClusterName             string            `alloy:"kafka_cluster_name,attr,optional"`
	MetadataRefreshInterval string            `alloy:"metadata_refresh_interval,attr,optional"`
	ServiceName             string            `alloy:"gssapi_service_name,attr,optional"`
	KerberosConfigPath      string            `alloy:"gssapi_kerberos_config_path,attr,optional"`
	Realm                   string            `alloy:"gssapi_realm,attr,optional"`
	KeyTabPath              string            `alloy:"gssapi_key_tab_path,attr,optional"`
	KerberosAuthType        string            `alloy:"gssapi_kerberos_auth_type,attr,optional"`
	OffsetShowAll           bool              `alloy:"offset_show_all,attr,optional"`
	TopicWorkers            int               `alloy:"topic_workers,attr,optional"`
	AllowConcurrent         bool              `alloy:"allow_concurrency,attr,optional"`
	AllowAutoTopicCreation  bool              `alloy:"allow_auto_topic_creation,attr,optional"`
	MaxOffsets              int               `alloy:"max_offsets,attr,optional"`
	PruneIntervalSeconds    int               `alloy:"prune_interval_seconds,attr,optional"` // deprecated - no-op
	TopicsFilter            string            `alloy:"topics_filter_regex,attr,optional"`
	TopicsExclude           string            `alloy:"topics_exclude_regex,attr,optional"`
	GroupFilter             string            `alloy:"groups_filter_regex,attr,optional"`
	GroupExclude            string            `alloy:"groups_exclude_regex,attr,optional"`
}

func (*Arguments) Convert

func (a *Arguments) Convert() *kafka_exporter.Config

func (*Arguments) SetToDefault

func (a *Arguments) SetToDefault()

SetToDefault implements syntax.Defaulter.

func (*Arguments) Validate

func (a *Arguments) Validate() error

Validate implements syntax.Validator.