args

Documentation

Index

• func SetGlobalArgs(args ArgumentList) error
• type ArgumentList
• type RabbitMQArguments
  • func (args *RabbitMQArguments) IncludeEntity(entityName string, entityType string, vhostName string) bool
  • func (args *RabbitMQArguments) Validate() error

Functions

func SetGlobalArgs

func SetGlobalArgs(args ArgumentList) error

SetGlobalArgs validates the arguments in ArgumentList and sets GlobalArgs to the result

Types

type ArgumentList

type ArgumentList struct {
	sdkArgs.DefaultArgumentList
	Hostname             string `default:"localhost" help:"Hostname or IP where RabbitMQ Management Plugin is running."`
	Port                 int    `default:"15672" help:"Port on which RabbitMQ Management Plugin is listening."`
	Username             string `default:"" help:"Username for accessing RabbitMQ Management Plugin"`
	Password             string `default:"" help:"Password for the given user."`
	ManagementPathPrefix string `default:"" help:"RabbitMQ Management Prefix."`
	CABundleFile         string `default:"" help:"Alternative Certificate Authority bundle file"`
	CABundleDir          string `default:"" help:"Alternative Certificate Authority bundle directory"`
	NodeNameOverride     string `default:"" help:"Overrides the local node name instead of retrieving it from RabbitMQ."`
	ConfigPath           string `default:"" help:"RabbitMQ configuration file path."`
	UseSSL               bool   `default:"false" help:"configure whether to use an SSL connection or not."`
	Queues               string `default:"" help:"JSON array of queue names from which to collect metrics."`
	QueuesRegexes        string `default:"" help:"JSON array of queue name regexes from which to collect metrics."`
	Exchanges            string `default:"" help:"JSON array of exchange names from which to collect metrics."`
	ExchangesRegexes     string `default:"" help:"JSON array of exchange name regexes from which to collect metrics."`
	Vhosts               string `default:"" help:"JSON array of vhost names from which to collect metrics."`
	VhostsRegexes        string `default:"" help:"JSON array of vhost name regexes from which to collect metrics."`
	ShowVersion          bool   `default:"false" help:"Print build information and exit"`
}

ArgumentList is the raw arguments passed into the integration via YAML, CLI args, or ENV variables

type RabbitMQArguments

type RabbitMQArguments struct {
	sdkArgs.DefaultArgumentList
	Hostname             string
	Port                 int
	Username             string
	Password             string
	ManagementPathPrefix string
	CABundleFile         string
	CABundleDir          string
	NodeNameOverride     string
	ConfigPath           string
	UseSSL               bool
	Queues               []string
	QueuesRegexes        []*regexp.Regexp
	Exchanges            []string
	ExchangesRegexes     []*regexp.Regexp
	Vhosts               []string
	VhostsRegexes        []*regexp.Regexp
}

RabbitMQArguments is the fully parsed arguments, converting the JSON string into actual types

var GlobalArgs RabbitMQArguments

GlobalArgs are the global set of arguments

func (*RabbitMQArguments) IncludeEntity

func (args *RabbitMQArguments) IncludeEntity(entityName string, entityType string, vhostName string) bool

IncludeEntity returns true if the entity should be included; false otherwise

func (*RabbitMQArguments) Validate

func (args *RabbitMQArguments) Validate() error

Validate checks that valid collection arguments were specified