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 logs 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.

In order to collect logs, at least one project must be specified. By default, logs for all clusters within a project will be collected. Clusters can be limited using either the include_clusters or exclude_clusters setting.

MongoDB Atlas Documentation recommends a polling interval of 5 minutes.

• public_key (required for metrics, logs, or alerts in poll mode)
• private_key (required for metrics, logs, or alerts in poll mode)
• granularity (default PT1M - See MongoDB Atlas Documentation)
• storage (optional) The component ID of a storage extension which can be used when polling for alerts or events . The storage extension prevents duplication of data after a collector restart by remembering which data were previously collected.
• retry_on_failure
  • enabled (default true)
  • initial_interval (default 5s)
  • max_interval (default 30s)
  • max_elapsed_time (default 5m)
• alerts
  • enabled (default false)
  • mode (default listen. Options are poll or listen)
  • secret (required if using listen mode)
  • endpoint (required if using listen mode)
  • poll_interval (default 5m, only relevant using poll mode)
  • page_size (default 100)
    • When in poll mode, this is the number of alerts that will be processed per request to the MongoDB Atlas API.
  • max_pages (default 10)
    • When in poll mode, this will limit how many pages of alerts the receiver will request for each project.
  • projects (required if using poll mode)
    • name (required if using poll mode)
    • include_clusters (default empty, exclusive with exclude_clusters)
    • exclude_clusters (default empty, exclusive with include_clusters)
      • If both include_clusters and exclude_clusters are empty, then all clusters in the project will be included
  • tls (relevant only for listen mode)
    • key_file
    • cert_file
• logs
  • enabled (default false)
  • projects (required if enabled)
    • name (required if enabled)
    • collect_audit_logs (default false)
    • include_clusters (default empty)
    • exclude_clusters (default empty)
• events
  • projects
    • name Name of the Project to discover events from
  • poll_interval (default 1m)
    • How often the receiver will poll the Events API for new events.
  • page_size (default 100)
    • This is the number of events that will be processed per request to the MongoDB Atlas API.
  • max_pages (default 25)
    • This will limit how many pages of events the receiver will request from the MongoDB Atlas API for each project.
  • types (defaults to all types of events)
    • This is a list of event types that the receiver will request from the API. If specified, the receiver will collect only the indicated types of events.

Examples:

Receive metrics:

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

Listen for alerts (default mode):

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

Poll alerts from API:

receivers:
  mongodbatlas:
    public_key: <redacted>
    private_key: <redacted>
    alerts:
      enabled: true
      mode: poll
      projects:
      - name: Project 0
        include_clusters: [Cluster0]
      poll_interval: 1m
    # use of a storage extension is recommended to reduce chance of duplicated alerts
    storage: file_storage

Receive logs:

receivers:
  mongodbatlas:
    logs:
      enabled: true
      projects: 
        - name: "project 1"
          collect_audit_logs: true

Receive events:

receivers:
  mongodbatlas:
    events:
      projects:
        - name: "project 1"
      poll_interval: 1m
      page_size: 100
      max_pages: 25
    # use of a storage extension is recommended to reduce chance of duplicated events
    storage: file_storage

Documentation

Index

• func NewFactory() rcvr.Factory
• type AlertConfig
• type Config
  • func (c *Config) Validate() error
• type EventsConfig
• type LogConfig
• type ProjectConfig
• type ProjectContext

Functions

func NewFactory

func NewFactory() rcvr.Factory

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"`
	Mode     string                      `mapstructure:"mode"`

	// these parameters are only relevant in retrieval mode
	Projects     []*ProjectConfig `mapstructure:"projects"`
	PollInterval time.Duration    `mapstructure:"poll_interval"`
	PageSize     int64            `mapstructure:"page_size"`
	MaxPages     int64            `mapstructure:"max_pages"`
}

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"`
	Events                                  *EventsConfig                `mapstructure:"events"`
	Logs                                    LogConfig                    `mapstructure:"logs"`
	RetrySettings                           exporterhelper.RetrySettings `mapstructure:"retry_on_failure"`
	StorageID                               *component.ID                `mapstructure:"storage"`
}

func (*Config) Validate

func (c *Config) Validate() error

type EventsConfig

type EventsConfig struct {
	Projects     []*ProjectConfig `mapstructure:"projects"`
	PollInterval time.Duration    `mapstructure:"poll_interval"`
	Types        []string         `mapstructure:"types"`
	PageSize     int64            `mapstructure:"page_size"`
	MaxPages     int64            `mapstructure:"max_pages"`
}

EventsConfig is the configuration options for events collection

type LogConfig

type LogConfig struct {
	Enabled  bool             `mapstructure:"enabled"`
	Projects []*ProjectConfig `mapstructure:"projects"`
}

type ProjectConfig

type ProjectConfig struct {
	Name            string   `mapstructure:"name"`
	ExcludeClusters []string `mapstructure:"exclude_clusters"`
	IncludeClusters []string `mapstructure:"include_clusters"`
	EnableAuditLogs bool     `mapstructure:"collect_audit_logs"`
	// contains filtered or unexported fields
}

type ProjectContext

type ProjectContext struct {
	Project mongodbatlas.Project
	// contains filtered or unexported fields
}