consul

Documentation

Index

• type Config
  • func (c *Config) Init()
  • func (c Config) Prom(conf *config.ScrapeConfig)
  • func (c Config) PromConfig() *config.ConsulSDConfig
  • func (c Config) Service() string
  • func (c Config) ServiceID() string
  • func (c Config) Validate() error
• type Diagnostic
• type Service
  • func NewService(c []Config, r scraper.Registry, d Diagnostic) *Service
  • func (s *Service) Close() error
  • func (s *Service) Open() error
  • func (s *Service) Test(options interface{}) error
  • func (s *Service) TestOptions() interface{}
  • func (s *Service) Update(newConfigs []interface{}) error

Types

type Config

type Config struct {
	Enabled      bool     `toml:"enabled" override:"enabled"`
	ID           string   `toml:"id" override:"id"`
	Address      string   `toml:"address" override:"address"`
	Token        string   `toml:"token" override:"token,redact"`
	Datacenter   string   `toml:"datacenter" override:"datacenter"`
	TagSeparator string   `toml:"tag-separator" override:"tag-separator"`
	Scheme       string   `toml:"scheme" override:"scheme"`
	Username     string   `toml:"username" override:"username"`
	Password     string   `toml:"password" override:"password,redact"`
	Services     []string `toml:"services" override:"services"`
	// Path to CA file
	SSLCA string `toml:"ssl-ca" override:"ssl-ca"`
	// Path to host cert file
	SSLCert string `toml:"ssl-cert" override:"ssl-cert"`
	// Path to cert key file
	SSLKey string `toml:"ssl-key" override:"ssl-key"`
	// SSLServerName is used to verify the hostname for the targets.
	SSLServerName string `toml:"ssl-server-name" override:"ssl-server-name"`
	// Use SSL but skip chain & host verification
	InsecureSkipVerify bool `toml:"insecure-skip-verify" override:"insecure-skip-verify"`
}

Config is a Consul service discovery configuration

func (*Config) Init

func (c *Config) Init()

Init adds defaults to Consul

func (Config) Prom

func (c Config) Prom(conf *config.ScrapeConfig)

Prom writes the prometheus configuration for discoverer into ScrapeConfig

func (Config) PromConfig

func (c Config) PromConfig() *config.ConsulSDConfig

PromConfig returns the prometheus configuration for this discoverer

func (Config) Service

func (c Config) Service() string

Service return discoverer type

func (Config) ServiceID

func (c Config) ServiceID() string

ServiceID returns the discoverers name

func (Config) Validate

func (c Config) Validate() error

Validate validates the consul configuration

type Diagnostic

type Diagnostic scraper.Diagnostic

type Service

type Service struct {
	Configs []Config
	// contains filtered or unexported fields
}

Service is the consul discovery service

func NewService

func NewService(c []Config, r scraper.Registry, d Diagnostic) *Service

NewService creates a new unopened service

func (*Service) Close

func (s *Service) Close() error

Close stops the service

func (*Service) Open

func (s *Service) Open() error

Open starts the service

func (*Service) Test

func (s *Service) Test(options interface{}) error

Test a service with the provided options.

func (*Service) TestOptions

func (s *Service) TestOptions() interface{}

TestOptions returns an object that is in turn passed to Test.

func (*Service) Update

func (s *Service) Update(newConfigs []interface{}) error

Update updates configuration while running