exporter

Documentation

Overview

Package exporter implements the collectors and metrics handlers.

Index

• Constants
• Variables
• type Exporter
  • func New(opts *Opts) *Exporter
  • func (e *Exporter) Handler() http.Handler
  • func (e *Exporter) Run()
• type Opts
• type ShardingChangelogStats
• type ShardingChangelogSummary
• type ShardingChangelogSummaryID

Constants

const (
	// UnknownState is the values for an unknown rs state.
	// From MongoDB documentation: https://docs.mongodb.com/manual/reference/replica-states/
	UnknownState = 6

	// 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 ErrInvalidOrMissingTotalsEntry = fmt.Errorf("Invalid or misssing totals entry in top results")

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.

func (*Exporter) Run

func (e *Exporter) Run()

Run starts the exporter.

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
	DisableDefaultRegistry bool
	DiscoveringMode        bool
	GlobalConnPool         bool

	CollectAll             bool
	EnableDBStats          bool
	EnableDiagnosticData   bool
	EnableReplicasetStatus bool
	EnableTopMetrics       bool
	EnableIndexStats       bool
	EnableCollStats        bool

	EnableOverrideDescendingIndex bool

	IndexStatsCollections []string
	Logger                *logrus.Logger
	Path                  string
	URI                   string
	WebListenAddress      string
	TLSConfigPath         string
}

Opts holds new exporter options.

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.