mongo

package
v0.55.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 15, 2023 License: GPL-3.0 Imports: 13 Imported by: 1

README

MongoDB collector

Overview

MongoDB is a source-available cross-platform document-oriented database program.

This collector monitors one or more MongoDB instances, depending on your configuration.

Executed queries:

Collected metrics

Metrics grouped by scope.

The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.

  • WireTiger metrics are available only if WiredTiger is used as the storage engine.
  • Sharding metrics are available on shards only for mongos.
global

These metrics refer to the entire monitored application.

This scope has no labels.

Metrics:

Metric Dimensions Unit
mongodb.operations_rate reads, writes, commands operations/s
mongodb.operations_latency_time reads, writes, commands milliseconds
mongodb.operations_by_type_rate insert, query, update, delete, getmore, command operations/s
mongodb.document_operations_rate inserted, deleted, returned, updated operations/s
mongodb.scanned_indexes_rate scanned indexes/s
mongodb.scanned_documents_rate scanned documents/s
mongodb.active_clients_count readers, writers clients
mongodb.queued_operations_count reads, writes operations
mongodb.cursors_open_count open cursors
mongodb.cursors_open_no_timeout_count open_no_timeout cursors
mongodb.cursors_opened_rate opened cursors/s
mongodb.cursors_timed_out_rate timed_out cursors/s
mongodb.cursors_by_lifespan_count le_1s, 1s_5s, 5s_15s, 15s_30s, 30s_1m, 1m_10m, ge_10m cursors
mongodb.transactions_count active, inactive, open, prepared transactions
mongodb.transactions_rate started, aborted, committed, prepared transactions/s
mongodb.connections_usage available, used connections
mongodb.connections_by_state_count active, threaded, exhaust_is_master, exhaust_hello, awaiting_topology_changes connections
mongodb.connections_rate created connections/s
mongodb.asserts_rate regular, warning, msg, user, tripwire, rollovers asserts/s
mongodb.network_traffic_rate in, out bytes/s
mongodb.network_requests_rate requests requests/s
mongodb.network_slow_dns_resolutions_rate slow_dns resolutions/s
mongodb.network_slow_ssl_handshakes_rate slow_ssl handshakes/s
mongodb.memory_resident_size used bytes
mongodb.memory_virtual_size used bytes
mongodb.memory_page_faults_rate pgfaults pgfaults/s
mongodb.memory_tcmalloc_stats allocated, central_cache_freelist, transfer_cache_freelist, thread_cache_freelists, pageheap_freelist, pageheap_unmapped bytes
mongodb.wiredtiger_concurrent_read_transactions_usage available, used transactions
mongodb.wiredtiger_concurrent_write_transactions_usage available, used transactions
mongodb.wiredtiger_cache_usage used bytes
mongodb.wiredtiger_cache_dirty_space_size dirty bytes
mongodb.wiredtiger_cache_io_rate read, written pages/s
mongodb.wiredtiger_cache_evictions_rate unmodified, modified pages/s
mongodb.sharding_nodes_count shard_aware, shard_unaware nodes
mongodb.sharding_sharded_databases_count partitioned, unpartitioned databases
mongodb.sharding_sharded_collections_count partitioned, unpartitioned collections
lock type

These metrics refer to the lock type.

Labels:

Label Description
lock_type lock type (e.g. global, database, collection, mutex)

Metrics:

Metric Dimensions Unit
mongodb.lock_acquisitions_rate shared, exclusive, intent_shared, intent_exclusive acquisitions/s
commit type

These metrics refer to the commit type.

Labels:

Label Description
commit_type commit type (e.g. noShards, singleShard, singleWriteShard)

Metrics:

Metric Dimensions Unit
mongodb.transactions_commits_rate success, fail commits/s
mongodb.transactions_commits_duration_time commits milliseconds
database

These metrics refer to the database.

Labels:

Label Description
database database name

Metrics:

Metric Dimensions Unit
mongodb.database_collection_count collections collections
mongodb.database_indexes_count indexes indexes
mongodb.database_views_count views views
mongodb.database_documents_count documents documents
mongodb.database_data_size data_size bytes
mongodb.database_storage_size storage_size bytes
mongodb.database_index_size index_size bytes
replica set member

These metrics refer to the replica set member.

Labels:

Label Description
repl_set_member replica set member name

Metrics:

Metric Dimensions Unit
mongodb.repl_set_member_state primary, startup, secondary, recovering, startup2, unknown, arbiter, down, rollback, removed state
mongodb.repl_set_member_health_status up, down status
mongodb.repl_set_member_replication_lag_time replication_lag milliseconds
mongodb.repl_set_member_heartbeat_latency_time heartbeat_latency milliseconds
mongodb.repl_set_member_ping_rtt_time ping_rtt milliseconds
mongodb.repl_set_member_uptime uptime seconds
shard

These metrics refer to the shard.

Labels:

Label Description
shard_id shard id

Metrics:

Metric Dimensions Unit
mongodb.sharding_shard_chunks_count chunks chunks

Setup

Prerequisites
Create a read-only user

Create a read-only user for Netdata in the admin database.

  • Authenticate as the admin user:

    use admin
db.auth("admin", "<MONGODB_ADMIN_PASSWORD>")

  • Create a user:

    db.createUser({
  "user":"netdata",
  "pwd": "<UNIQUE_PASSWORD>",
  "roles" : [
    {role: 'read', db: 'admin' },
    {role: 'clusterMonitor', db: 'admin'},
    {role: 'read', db: 'local' }
  ]
})
Configuration
File

The configuration file name is go.d/mongodb.conf.

The file format is YAML. Generally, the format is:

update_every: 1
autodetection_retry: 0
jobs:
  - name: some_name1
  - name: some_name1

You can edit the configuration file using the edit-config script from the Netdata config directory.

cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
sudo ./edit-config go.d/mongodb.conf
Options

The following options can be defined globally: update_every, autodetection_retry.

Config options
Name Description Default Required
update_every Data collection frequency. 5
autodetection_retry Re-check interval in seconds. Zero means not to schedule re-check. 0
uri MongoDB connection string. See URI syntax. mongodb://localhost:27017 yes
timeout Query timeout in seconds. 2
databases Databases selector. Determines which database metrics will be collected.
databases

Metrics of databases matching the selector will be collected.

  • Logic: (pattern1 OR pattern2) AND !(pattern3 or pattern4)
  • Pattern syntax: matcher.
  • Syntax: 
    per_user_stats:
  includes:
    - pattern1
    - pattern2
  excludes:
    - pattern3
    - pattern4
Examples
TCP socket

An example configuration.

Config 
jobs:
  - name: local
    uri: mongodb://netdata:password@localhost:27017
With databases metrics

An example configuration.

Config 
jobs:
  - name: local
    uri: mongodb://netdata:password@localhost:27017
    databases:
      includes:
        - "* *"
Multi-instance

Note: When you define multiple jobs, their names must be unique.

Local and remote instances.

Config 
jobs:
  - name: local
    uri: mongodb://netdata:password@localhost:27017

  - name: remote
    uri: mongodb://netdata:password@203.0.113.0:27017

Troubleshooting

Debug mode

To troubleshoot issues with the mongodb collector, run the go.d.plugin with the debug option enabled. The output should give you clues as to why the collector isn't working.

  • Navigate to the plugins.d directory, usually at /usr/libexec/netdata/plugins.d/. If that's not the case on your system, open netdata.conf and look for the plugins setting under [directories].

    cd /usr/libexec/netdata/plugins.d/

  • Switch to the netdata user.

    sudo -u netdata -s

  • Run the go.d.plugin to debug the collector:

    ./go.d.plugin -d -m mongodb

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Config 

type Config struct {
	URI       string             `yaml:"uri"`
	Timeout   time.Duration      `yaml:"timeout"`
	Databases matcher.SimpleExpr `yaml:"databases"`
}

type Mongo 

type Mongo struct {
	module.Base
	Config `yaml:",inline"`
	// contains filtered or unexported fields
}

func New 

func New() *Mongo

func (*Mongo) Charts 

func (m *Mongo) Charts() *module.Charts

func (*Mongo) Check 

func (m *Mongo) Check() bool

func (*Mongo) Cleanup 

func (m *Mongo) Cleanup()

func (*Mongo) Collect 

func (m *Mongo) Collect() map[string]int64

func (*Mongo) Init 

func (m *Mongo) Init() bool

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.