redis_exporter

Documentation

Overview

package redis_exporter embeds https://github.com/oliver006/redis_exporter

Index

• Variables
• func New(log log.Logger, c *Config) (integrations.Integration, error)
• type Config
  • func (c *Config) CommonConfig() config.Common
  • func (c Config) GetExporterOptions() re.Options
  • func (c *Config) Name() string
  • func (c *Config) NewIntegration(l log.Logger) (integrations.Integration, error)
  • func (c *Config) UnmarshalYAML(unmarshal func(interface{}) error) error

Variables

var DefaultConfig = Config{
	Namespace:               "redis",
	ConfigCommand:           "CONFIG",
	ConnectionTimeout:       (15 * time.Second),
	SetClientName:           true,
	CheckKeyGroupsBatchSize: 10000,
	MaxDistinctKeyGroups:    100,
}

DefaultConfig holds non-zero default options for the Config when it is unmarshaled from YAML.

Functions

func New

func New(log log.Logger, c *Config) (integrations.Integration, error)

New creates a new redis_exporter integration. The integration queries a redis instance's INFO and exposes the results as metrics.

Types

type Config

type Config struct {
	Common config.Common `yaml:",inline"`

	IncludeExporterMetrics bool `yaml:"include_exporter_metrics"`

	// exporter-specific config.
	//
	// The exporter binary config differs to this, but these
	// are the only fields that are relevant to the exporter struct.
	RedisAddr               string        `yaml:"redis_addr"`
	RedisUser               string        `yaml:"redis_user"`
	RedisPassword           string        `yaml:"redis_password"`
	RedisPasswordFile       string        `yaml:"redis_password_file"`
	Namespace               string        `yaml:"namespace"`
	ConfigCommand           string        `yaml:"config_command"`
	CheckKeys               string        `yaml:"check_keys"`
	CheckKeyGroups          string        `yaml:"check_key_groups"`
	CheckKeyGroupsBatchSize int64         `yaml:"check_key_groups_batch_size"`
	MaxDistinctKeyGroups    int64         `yaml:"max_distinct_key_groups"`
	CheckSingleKeys         string        `yaml:"check_single_keys"`
	CheckStreams            string        `yaml:"check_streams"`
	CheckSingleStreams      string        `yaml:"check_single_streams"`
	CountKeys               string        `yaml:"count_keys"`
	ScriptPath              string        `yaml:"script_path"`
	ConnectionTimeout       time.Duration `yaml:"connection_timeout"`
	TLSClientKeyFile        string        `yaml:"tls_client_key_file"`
	TLSClientCertFile       string        `yaml:"tls_client_cert_file"`
	TLSCaCertFile           string        `yaml:"tls_ca_cert_file"`
	SetClientName           bool          `yaml:"set_client_name"`
	IsTile38                bool          `yaml:"is_tile38"`
	ExportClientList        bool          `yaml:"export_client_list"`
	ExportClientPort        bool          `yaml:"export_client_port"`
	RedisMetricsOnly        bool          `yaml:"redis_metrics_only"`
	PingOnConnect           bool          `yaml:"ping_on_connect"`
	InclSystemMetrics       bool          `yaml:"incl_system_metrics"`
	SkipTLSVerification     bool          `yaml:"skip_tls_verification"`
}

Config controls the redis_exporter integration.

func (*Config) CommonConfig

func (c *Config) CommonConfig() config.Common

func (Config) GetExporterOptions

func (c Config) GetExporterOptions() re.Options

GetExporterOptions returns relevant Config properties as a redis_exporter Options struct. The redis_exporter Options struct has no yaml tags, so we marshal the yaml into Config and then create the re.Options from that.

func (*Config) Name

func (c *Config) Name() string

func (*Config) NewIntegration

func (c *Config) NewIntegration(l log.Logger) (integrations.Integration, error)

func (*Config) UnmarshalYAML

func (c *Config) UnmarshalYAML(unmarshal func(interface{}) error) error

UnmarshalYAML implements yaml.Unmarshaler for Config