exporter

Documentation

Overview

Package exporter implements the collectors and metrics handlers.

Index

• Constants
• Variables
• func RunWebServer(opts *ServerOpts, exporters []*Exporter, log *logrus.Logger)
• type Exporter
  • func New(opts *Opts) *Exporter
  • func (e *Exporter) Handler() http.Handler
• type Opts
• type ServerMap
• type ServerOpts
• type ShardingChangelogStats
• type ShardingChangelogSummary
• type ShardingChangelogSummaryID

Constants

const (
	// PrimaryState is the state of the primary node in a replica set.
	// See: https://docs.mongodb.com/manual/reference/replica-states/
	PrimaryState = 1

	// SecondaryState is the state of a secondary node in a replica set.
	SecondaryState = 2

	// UnknownState is the state of an unknown node in a replica set.
	UnknownState = 6

	// ArbiterState is the state of an arbiter in a replica set.
	ArbiterState = 7

	// EnterpriseEdition shows that MongoDB is Enterprise edition.
	EnterpriseEdition = "Enterprise"
	// CommunityEdition shows that MongoDB is Community edition.
	CommunityEdition = "Community"

	// PerconaVendor means that MongoDB provided by Percona.
	PerconaVendor = "Percona"
	// MongoDBVendor means that MongoDB provided by Mongo.
	MongoDBVendor = "MongoDB"
)

Variables

var ErrCannotGetTopologyLabels = fmt.Errorf("cannot get topology labels")

ErrCannotGetTopologyLabels Cannot read topology labels.

var ErrInvalidOrMissingInprogEntry = errors.New("invalid or missing inprog entry in currentop results")

var ErrInvalidOrMissingTotalsEntry = fmt.Errorf("Invalid or misssing totals entry in top results")

Functions

func RunWebServer

func RunWebServer(opts *ServerOpts, exporters []*Exporter, log *logrus.Logger)

Runs the main web-server

Types

type Exporter

type Exporter struct {
	// contains filtered or unexported fields
}

Exporter holds Exporter methods and attributes.

func New

func New(opts *Opts) *Exporter

New connects to the database and returns a new Exporter instance.

func (*Exporter) Handler

func (e *Exporter) Handler() http.Handler

Handler returns an http.Handler that serves metrics. Can be used instead of run for hooking up custom HTTP servers.

type Opts

type Opts struct {
	// Only get stats for the collections matching this list of namespaces.
	// Example: db1.col1,db.col1
	CollStatsNamespaces    []string
	CollStatsLimit         int
	CompatibleMode         bool
	DirectConnect          bool
	ConnectTimeoutMS       int
	DisableDefaultRegistry bool
	DiscoveringMode        bool
	GlobalConnPool         bool
	ProfileTimeTS          int
	TimeoutOffset          int
	CurrentOpSlowTime      string

	CollectAll               bool
	EnableDBStats            bool
	EnableDBStatsFreeStorage bool
	EnableDiagnosticData     bool
	EnableReplicasetStatus   bool
	EnableCurrentopMetrics   bool
	EnableTopMetrics         bool
	EnableIndexStats         bool
	EnableCollStats          bool
	EnableProfile            bool
	EnableShards             bool
	EnableFCV                bool // Feature Compatibility Version.

	EnableOverrideDescendingIndex bool

	// Enable metrics for Percona Backup for MongoDB (PBM).
	EnablePBMMetrics bool

	IndexStatsCollections []string
	Logger                *logrus.Logger

	URI string
}

Opts holds new exporter options.

type ServerMap

type ServerMap map[string]http.Handler

ServerMap stores http handlers for each host

type ServerOpts

type ServerOpts struct {
	Path             string
	MultiTargetPath  string
	WebListenAddress string
	TLSConfigPath    string
}

ServerOpts is the options for the main http handler

type ShardingChangelogStats

type ShardingChangelogStats struct {
	Items *[]ShardingChangelogSummary
}

ShardingChangelogStats is an array of Sharding changelog stats.

type ShardingChangelogSummary

type ShardingChangelogSummary struct {
	ID    *ShardingChangelogSummaryID `bson:"_id"`
	Count float64                     `bson:"count"`
}

ShardingChangelogSummary Sharding Changelog Summary.

type ShardingChangelogSummaryID

type ShardingChangelogSummaryID struct {
	Event string `bson:"event"`
	Note  string `bson:"note"`
}

ShardingChangelogSummaryID Sharding Changelog Summary ID.