args

Documentation

Overview

Package args contains a structs for a passed in argument list. Also, the KafkaArguments struct which is a specially parsed version of the args to be used within the integration.

Index

• type ArgumentList
• type ConsumerGroups
• type JMXHost
• type KafkaArguments
  • func ParseArgs(a ArgumentList) (*KafkaArguments, error)
• type ZookeeperHost

Types

type ArgumentList

type ArgumentList struct {
	sdkArgs.DefaultArgumentList
	ClusterName         string `default:"" help:"A user-defined name to uniquely identify the cluster"`
	ZookeeperHosts      string `default:"[]" help:"JSON array of ZooKeeper hosts with the following fields: host, port. Port defaults to 2181"`
	ZookeeperAuthScheme string `default:"" help:"ACL scheme for authenticating ZooKeeper connection."`
	ZookeeperAuthSecret string `default:"" help:"Authentication string for ZooKeeper."`
	ZookeeperPath       string `default:"" help:"The Zookeeper path which contains the Kafka configuration. A leading slash is required."`
	DefaultJMXPort      int    `default:"9999" help:"Default port for JMX collection."`
	DefaultJMXHost      string `default:"localhost" help:"Default host for JMX collection."`
	DefaultJMXUser      string `default:"admin" help:"Default JMX username. Useful if all JMX hosts use the same JMX username and password."`
	DefaultJMXPassword  string `default:"admin" help:"Default JMX password. Useful if all JMX hosts use the same JMX username and password."`

	CollectBrokerTopicData bool   `` /* 199-byte string literal not displayed */
	TopicMode              string `` /* 147-byte string literal not displayed */
	TopicList              string `default:"[]" help:"JSON array of strings with the names of topics to monitor. Only used if collect_topics is set to 'List'"`
	TopicRegex             string `default:"" help:"A regex pattern that matches the list of topics to collect. Only used if collect_topics is set to 'Regex'"`
	CollectTopicSize       bool   `` /* 160-byte string literal not displayed */
	Producers              string `` /* 220-byte string literal not displayed */
	Consumers              string `` /* 220-byte string literal not displayed */
	Timeout                int    `default:"10000" help:"Timeout in milliseconds per single JMX query."`

	// SSL options
	KeyStore           string `default:"" help:"The location for the keystore containing JMX Client's SSL certificate"`
	KeyStorePassword   string `default:"" help:"Password for the SSL Key Store"`
	TrustStore         string `default:"" help:"The location for the keystore containing JMX Server's SSL certificate"`
	TrustStorePassword string `default:"" help:"Password for the SSL Trust Store"`

	// Consumer offset arguments
	ConsumerOffset bool   `default:"false" help:"Populate consumer offset data"`
	ConsumerGroups string `` /* 150-byte string literal not displayed */
}

ArgumentList is the raw arguments passed into the integration via yaml or CLI args

type ConsumerGroups

type ConsumerGroups map[string]map[string][]int32

ConsumerGroups is the structure to represent the whitelist for consumer_groups argument

type JMXHost

type JMXHost struct {
	Name     string `json:"name"`
	Host     string `json:"host"`
	Port     int    `json:"port"`
	User     string `json:"user"`
	Password string `json:"password"`
}

JMXHost is a storage struct for producer and consumer connection information

type KafkaArguments

type KafkaArguments struct {
	sdkArgs.DefaultArgumentList
	ClusterName            string
	ZookeeperHosts         []*ZookeeperHost
	ZookeeperAuthScheme    string
	ZookeeperAuthSecret    string
	ZookeeperPath          string
	DefaultJMXUser         string
	DefaultJMXPassword     string
	CollectBrokerTopicData bool
	Producers              []*JMXHost
	Consumers              []*JMXHost
	TopicMode              string
	TopicList              []string
	TopicRegex             string
	Timeout                int
	CollectTopicSize       bool

	// SSL options
	KeyStore           string
	KeyStorePassword   string
	TrustStore         string
	TrustStorePassword string

	// Consumer offset arguments
	ConsumerOffset bool
	ConsumerGroups ConsumerGroups
}

KafkaArguments is an special version of the config arguments that has advanced parsing to allow arguments to be consumed easier.

var GlobalArgs *KafkaArguments

GlobalArgs represents the global arguments that were passed in

func ParseArgs

func ParseArgs(a ArgumentList) (*KafkaArguments, error)

ParseArgs validates the arguments in argumentList and parses them into more easily used structs

type ZookeeperHost

type ZookeeperHost struct {
	Host string `json:"host"`
	Port int    `json:"port"`
}

ZookeeperHost is a storage struct for ZooKeeper connection information