ntpreceiver

README

NTP Receiver

Status
Stability	alpha: metrics
Distributions	contrib
Issues
Code Owners	@atoulme | Seeking more code owners!

Purpose

This receiver periodically retrieves the clock offset from a NTP server.

Configuration

• endpoint: (default = pool.ntp.org:123) Endpoint of the NTP server. Must be formatted as {host}:{port}.

• collection_interval: (default = 30m): This receiver collects metrics on an interval. This value must be a string readable by Golang's time.ParseDuration. Valid time units are ns, us (or µs), ms, s, m, h.

• initial_delay (default = 1s): defines how long this receiver waits before starting.

• metrics (default: see DefaultMetricsSettings here): Allows enabling and disabling specific metrics from being collected in this receiver.

Example Configuration

receivers:
  ntp:
    endpoint: pool.ntp.org:123
    collection_interval: 1h
    initial_delay: 5m

The full list of settings exposed for this receiver are documented in config.go with detailed sample configurations in testdata/config.yaml.

Metrics

Details about the metrics produced by this receiver can be found in metadata.yaml

Documentation

Index

• func NewFactory() receiver.Factory
• type Config
  • func (c *Config) Validate() error

Functions

func NewFactory

func NewFactory() receiver.Factory

Types

type Config

type Config struct {
	scraperhelper.ControllerConfig `mapstructure:",squash"`
	metadata.MetricsBuilderConfig  `mapstructure:",squash"`
	Version                        int    `mapstructure:"version"`
	Endpoint                       string `mapstructure:"endpoint"`
}

Config is the configuration for the NSX receiver

func (*Config) Validate

func (c *Config) Validate() error