config

Documentation

Index

• Constants
• func AddParm(loc interface{}, defaultValue interface{}, parmType int, cliName string, ...)
• func AsBool(s string, def bool) bool
• func CopyDeprecatedParmIfNotSetBool(section string, name string, val bool) bool
• func CopyDeprecatedParmIfNotSetStr(section string, name string, val string) string
• func CopyDeprecatedParmIfNotSetStrArray(section string, name string, val []string) string
• func CopyParmIfNotSetBool(section string, name string, val bool) bool
• func CopyParmIfNotSetInt(section string, name string, val int) int
• func CopyParmIfNotSetStr(section string, name string, val string) string
• func CopyParmIfNotSetStrArray(section string, name string, val []string) string
• func CopyYamlConfig(cm *Config, cyg ConfigYGlobal, cyc ConfigYConnection, cyo ConfigYObjects, ...)
• func GetPasswordFromFile(file string, removeFile bool) (string, error)
• func GetPasswordFromStdin(prompt string) string
• func InitConfig(cm *Config)
• func InitLog(cm Config)
• func MqGolangVersion() string
• func ParseParms() error
• func PrintInfo(title string, stamp string, commit string, buildPlatform string)
• func ReadConfigFile(f string, cmy interface{}) error
• func VerifyConfig(cm *Config, fullCf interface{}) error
• type Config
• type ConfigMoved
• type ConfigParm
• type ConfigYConnection
• type ConfigYFilters
• type ConfigYGlobal
• type ConfigYObjects

Constants

const (
	CP_STR  = 0
	CP_INT  = 1
	CP_BOOL = 2
)

Functions

func AddParm

func AddParm(loc interface{}, defaultValue interface{}, parmType int, cliName string, envSection string, envName string, usage string)

func AsBool

func AsBool(s string, def bool) bool

The Go YAML parsing is not what you might expect for booleans - you are apparently unable to set a default of "true" for missing fields. So we read it as a string and parse that. The caller also sends in the default value if the string cannot be decoded.

func CopyDeprecatedParmIfNotSetBool

func CopyDeprecatedParmIfNotSetBool(section string, name string, val bool) bool

func CopyDeprecatedParmIfNotSetStr

func CopyDeprecatedParmIfNotSetStr(section string, name string, val string) string

func CopyDeprecatedParmIfNotSetStrArray

func CopyDeprecatedParmIfNotSetStrArray(section string, name string, val []string) string

func CopyParmIfNotSetBool

func CopyParmIfNotSetBool(section string, name string, val bool) bool

If the parameter has already been set by env var or cli, then the value in the main config structure is returned. Otherwise the value passed as the "val" parameter - from the YAML version of the configuration elements - is returned

func CopyParmIfNotSetInt

func CopyParmIfNotSetInt(section string, name string, val int) int

func CopyParmIfNotSetStr

func CopyParmIfNotSetStr(section string, name string, val string) string

func CopyParmIfNotSetStrArray

func CopyParmIfNotSetStrArray(section string, name string, val []string) string

func CopyYamlConfig

func CopyYamlConfig(cm *Config, cyg ConfigYGlobal, cyc ConfigYConnection, cyo ConfigYObjects, cyf ConfigYFilters)

This handles the configuration parameters that are common to all the collectors. The individual collectors call similar code for their own specific attributes

func GetPasswordFromFile

func GetPasswordFromFile(file string, removeFile bool) (string, error)

func GetPasswordFromStdin

func GetPasswordFromStdin(prompt string) string

func InitConfig

func InitConfig(cm *Config)

func InitLog

func InitLog(cm Config)

func MqGolangVersion

func MqGolangVersion() string

func ParseParms

func ParseParms() error

func PrintInfo

func PrintInfo(title string, stamp string, commit string, buildPlatform string)

func ReadConfigFile

func ReadConfigFile(f string, cmy interface{}) error

func VerifyConfig

func VerifyConfig(cm *Config, fullCf interface{}) error

Types

type Config

type Config struct {
	ConfigFile string

	QMgrName string
	ReplyQ   string
	ReplyQ2  string

	MetaPrefix string

	TZOffsetString string
	Locale         string

	MonitoredQueues            string
	MonitoredQueuesFile        string
	MonitoredChannels          string
	MonitoredChannelsFile      string
	MonitoredAMQPChannels      string
	MonitoredAMQPChannelsFile  string
	MonitoredTopics            string
	MonitoredTopicsFile        string
	MonitoredSubscriptions     string
	MonitoredSubscriptionsFile string
	QueueSubscriptionSelector  string

	MetadataTagsArray   []string
	MetadataValuesArray []string

	LogLevel string

	PollIntervalDuration time.Duration

	RediscoverDuration time.Duration

	CC mqmetric.ConnectionConfig
	// contains filtered or unexported fields
}

Configuration attributes shared by all the monitor sample programs

type ConfigMoved

type ConfigMoved struct {
	QueueSubscriptionSelector string
	ShowInactiveChannels      string
}

type ConfigParm

type ConfigParm struct {
	// contains filtered or unexported fields
}

type ConfigYConnection

type ConfigYConnection struct {
	QueueManager     string `yaml:"queueManager"`
	User             string
	Client           string `yaml:"clientConnection" default:"false"`
	Password         string
	ReplyQueue       string   `yaml:"replyQueue" `
	ReplyQueue2      string   `yaml:"replyQueue2"`
	DurableSubPrefix string   `yaml:"durableSubPrefix"`
	CcdtUrl          string   `yaml:"ccdtUrl"`
	ConnName         string   `yaml:"connName"`
	Channel          string   `yaml:"channel"`
	WaitInterval     string   `yaml:"waitInterval"`
	MetadataTags     []string `yaml:"metadataTags"`
	MetadataValues   []string `yaml:"metadataValues"`
}

type ConfigYFilters

type ConfigYFilters struct {
	HideSvrConnJobname        string   `yaml:"hideSvrConnJobname" default:"false"`
	HideAMQPClientId          string   `yaml:"hideAMQPClientId" default:"false"`
	ShowInactiveChannels      string   `yaml:"showInactiveChannels" default:"false"`
	QueueSubscriptionSelector []string `yaml:"queueSubscriptionSelector"`
}

type ConfigYGlobal

type ConfigYGlobal struct {
	UseObjectStatus    string `yaml:"useObjectStatus" default:"true"`
	UseResetQStats     string `yaml:"useResetQStats" default:"false"`
	UsePublications    string `yaml:"usePublications" default:"true"`
	LogLevel           string `yaml:"logLevel"`
	MetaPrefix         string
	PollInterval       string `yaml:"pollInterval"`
	RediscoverInterval string `yaml:"rediscoverInterval"`
	TZOffset           string `yaml:"tzOffset"`
	Locale             string
}

type ConfigYObjects

type ConfigYObjects struct {
	Queues        []string
	Channels      []string
	AMQPChannels  []string `yaml:"amqpChannels"`
	Topics        []string
	Subscriptions []string
	// These are left here for now so they can be recognised but will cause an error because the
	// real values have moved
	QueueSubscriptionSelector []string `yaml:"queueSubscriptionSelector"`
	ShowInactiveChannels      string   `yaml:"showInactiveChannels" default:"false"`
}