mongodbatlasreceiver

README

MongoDB Atlas Receiver

Status
Stability	beta
Supported pipeline types	metrics, logs
Distributions	contrib

Receives metrics from MongoDB Atlas via their monitoring APIs, as well as alerts via a configured webhook.

Getting Started

The MongoDB Atlas receiver takes the following parameters. public_key and private_key are the only two required values to receive metrics and are obtained via the "API Keys" tab of the MongoDB Atlas Project Access Manager. In the example below both values are being pulled from the environment.

• public_key (required for metrics)
• private_key (required for metrics)
• granularity (default PT1M - See MongoDB Atlas Documentation)
• retry_on_failure
  • enabled (default true)
  • initial_interval (default 5s)
  • max_interval (default 30s)
  • max_elapsed_time (default 5m)
• alerts
  • enabled (default false)
  • secret (required if enabled)
  • endpoint (required if enabled)
  • tls
    • key_file
    • cert_file

Examples:

Receive metrics:

receivers:
  mongodbatlas:
    public_key: ${MONGODB_ATLAS_PUBLIC_KEY}
    private_key: ${MONGODB_ATLAS_PRIVATE_KEY}

Receive alerts:

receivers:
  mongodbatlas:
    alerts:
      enabled: true
      secret: "some_secret"
      endpoint: "0.0.0.0:7706"

Documentation

Index

• func NewFactory() component.ReceiverFactory
• type AlertConfig
• type Config
  • func (c *Config) Validate() error

Functions

func NewFactory

func NewFactory() component.ReceiverFactory

NewFactory creates a factory for MongoDB Atlas receiver

Types

type AlertConfig

type AlertConfig struct {
	Enabled  bool                        `mapstructure:"enabled"`
	Endpoint string                      `mapstructure:"endpoint"`
	Secret   string                      `mapstructure:"secret"`
	TLS      *configtls.TLSServerSetting `mapstructure:"tls"`
}

type Config

type Config struct {
	scraperhelper.ScraperControllerSettings `mapstructure:",squash"`
	PublicKey                               string                       `mapstructure:"public_key"`
	PrivateKey                              string                       `mapstructure:"private_key"`
	Granularity                             string                       `mapstructure:"granularity"`
	Metrics                                 metadata.MetricsSettings     `mapstructure:"metrics"`
	Alerts                                  AlertConfig                  `mapstructure:"alerts"`
	RetrySettings                           exporterhelper.RetrySettings `mapstructure:"retry_on_failure"`
}

func (*Config) Validate

func (c *Config) Validate() error