nats

README

NATS Output Plugin

This plugin writes to a (list of) specified NATS instance(s).

[[outputs.nats]]
  ## URLs of NATS servers
  servers = ["nats://localhost:4222"]
  ## Optional credentials
  # username = ""
  # password = ""
  ## NATS subject for producer messages
  subject = "telegraf"
  ## Optional TLS Config
  ## CA certificate used to self-sign NATS server(s) TLS certificate(s)
  # tls_ca = "/etc/telegraf/ca.pem"
  ## Use TLS but skip chain & host verification
  # insecure_skip_verify = false

  ## Data format to output.
  ## Each data format has it's own unique set of configuration options, read
  ## more about them here:
  ## https://github.com/influxdata/telegraf/blob/master/docs/DATA_FORMATS_OUTPUT.md
  data_format = "influx"

Required parameters:

• servers: List of strings, this is for NATS clustering support. Each URL should start with nats://.
• subject: The NATS subject to publish to.

Optional parameters:

• username: Username for NATS
• password: Password for NATS
• tls_ca: TLS CA
• insecure_skip_verify: Use SSL but skip chain & host verification (default: false)

Documentation

Index

• type NATS
  • func (n *NATS) Close() error
  • func (n *NATS) Connect() error
  • func (n *NATS) Description() string
  • func (n *NATS) SampleConfig() string
  • func (n *NATS) SetSerializer(serializer serializers.Serializer)
  • func (n *NATS) Write(metrics []telegraf.Metric) error

Types

type NATS

type NATS struct {
	// Servers is the NATS server pool to connect to
	Servers []string
	// Credentials
	Username string
	Password string
	// NATS subject to publish metrics to
	Subject string

	// Path to CA file
	SSLCA string `toml:"ssl_ca"`
	// Path to host cert file
	SSLCert string `toml:"ssl_cert"`
	// Path to cert key file
	SSLKey string `toml:"ssl_key"`
	// Use SSL but skip chain & host verification
	InsecureSkipVerify bool
	// contains filtered or unexported fields
}

func (*NATS) Close

func (n *NATS) Close() error

func (*NATS) Connect

func (n *NATS) Connect() error

func (*NATS) Description

func (n *NATS) Description() string

func (*NATS) SampleConfig

func (n *NATS) SampleConfig() string

func (*NATS) SetSerializer

func (n *NATS) SetSerializer(serializer serializers.Serializer)

func (*NATS) Write

func (n *NATS) Write(metrics []telegraf.Metric) error