jenkins

Documentation

Index

• type Config
  • func (c *Config) PythonConfig() *python.Config
• type Monitor
  • func (m *Monitor) Configure(conf *Config) error

Types

type Config

type Config struct {
	config.MonitorConfig `yaml:",inline" acceptsEndpoints:"true"`

	Host string `yaml:"host" validate:"required"`
	Port uint16 `yaml:"port" validate:"required"`
	// Key required for collecting metrics.  The access key located at
	// `Manage Jenkins > Configure System > Metrics > ADD.`
	// If empty, click `Generate`.
	MetricsKey string `yaml:"metricsKey" validate:"required"`
	// Whether to enable enhanced metrics
	EnhancedMetrics *bool `yaml:"enhancedMetrics"`
	// Used to enable individual enhanced metrics when `enhancedMetrics` is
	// false
	IncludeMetrics []string `yaml:"includeMetrics"`
	// User with security access to jenkins
	Username string `yaml:"username"`
	// API Token of the user
	APIToken string `yaml:"apiToken" neverLog:"true"`
	// Path to the keyfile
	SSLKeyFile string `yaml:"sslKeyFile"`
	// Path to the certificate
	SSLCertificate string `yaml:"sslCertificate"`
	// Path to the ca file
	SSLCACerts string `yaml:"sslCACerts"`
	// contains filtered or unexported fields
}

Config is the monitor-specific config with the generic config embedded

func (*Config) PythonConfig

func (c *Config) PythonConfig() *python.Config

PythonConfig returns the embedded python.Config struct from the interface

type Monitor

type Monitor struct {
	python.PyMonitor
}

Monitor is the main type that represents the monitor

func (*Monitor) Configure

func (m *Monitor) Configure(conf *Config) error

Configure configures and runs the plugin in collectd