mongodb

README

MongoDB Output Plugin

This plugin sends metrics to MongoDB and automatically creates the collections as time series collections when they don't already exist. Please note: Requires MongoDB 5.0+ for Time Series Collections

Configuration

# A plugin that can transmit logs to mongodb
[[outputs.mongodb]]
  # connection string examples for mongodb
  dsn = "mongodb://localhost:27017"
  # dsn = "mongodb://mongod1:27017,mongod2:27017,mongod3:27017/admin&replicaSet=myReplSet&w=1"

  # overrides serverSelectionTimeoutMS in dsn if set
  # timeout = "30s"

  # default authentication, optional
  # authentication = "NONE"

  # for SCRAM-SHA-256 authentication
  # authentication = "SCRAM"
  # username = "root"
  # password = "***"

  # for x509 certificate authentication
  # authentication = "X509"
  # tls_ca = "ca.pem"
  # tls_key = "client.pem"
  # # tls_key_pwd = "changeme" # required for encrypted tls_key
  # insecure_skip_verify = false

  # database to store measurements and time series collections
  # database = "telegraf"

  # granularity can be seconds, minutes, or hours.
  # configuring this value will be based on your input collection frequency.
  # see https://docs.mongodb.com/manual/core/timeseries-collections/#create-a-time-series-collection
  # granularity = "seconds"

  # optionally set a TTL to automatically expire documents from the measurement collections.
  # ttl = "360h"

Documentation

Index

• type MongoDB
  • func (s *MongoDB) Close() error
  • func (s *MongoDB) Connect() error
  • func (s *MongoDB) Init() error
  • func (*MongoDB) SampleConfig() string
  • func (s *MongoDB) Write(metrics []telegraf.Metric) error

Types

type MongoDB

type MongoDB struct {
	Dsn                 string          `toml:"dsn"`
	AuthenticationType  string          `toml:"authentication"`
	MetricDatabase      string          `toml:"database"`
	MetricGranularity   string          `toml:"granularity"`
	Username            string          `toml:"username"`
	Password            string          `toml:"password"`
	ServerSelectTimeout config.Duration `toml:"timeout"`
	TTL                 config.Duration `toml:"ttl"`
	Log                 telegraf.Logger `toml:"-"`

	tls.ClientConfig
	// contains filtered or unexported fields
}

func (*MongoDB) Close

func (s *MongoDB) Close() error

func (*MongoDB) Connect

func (s *MongoDB) Connect() error

func (*MongoDB) Init

func (s *MongoDB) Init() error

func (*MongoDB) SampleConfig

func (*MongoDB) SampleConfig() string

func (*MongoDB) Write

func (s *MongoDB) Write(metrics []telegraf.Metric) error