MongoDB Receiver

OpenTelemetry Collector receiver · contrib distribution

This receiver fetches stats from a MongoDB instance using the golang mongo driver. Stats are collected via MongoDB's dbStats and serverStatus commands.

Component ID: contrib-mongodbreceiver
Name: mongodbreceiver
Type: receiver
Distribution: contrib
Repository: opentelemetry-collector-contrib

Stability

Level	Signals
beta	metrics
development	logs

Metrics

Metric	Type	Value type	Unit	Stability	Enabled	Attributes	Description
`mongodb.active.reads`	sum	int	{reads}	development	no		The number of read operations currently being processed.
`mongodb.active.writes`	sum	int	{writes}	development	no		The number of write operations currently being processed.
`mongodb.cache.operations`	sum (monotonic)	int	{operations}	development	yes	`type` (string)	The number of cache operations of the instance.
`mongodb.collection.count`	sum	int	{collections}	development	yes	`db.namespace` (string)	The number of collections.
`mongodb.commands.rate`	gauge	double	{command}/s	development	no		The number of commands executed per second.
`mongodb.connection.count`	sum	int	{connections}	development	yes	`connection_type` (string), `db.namespace` (string)	The number of connections.
`mongodb.cursor.count`	sum	int	{cursors}	development	yes		The number of open cursors maintained for clients.
`mongodb.cursor.timeout.count`	sum	int	{cursors}	development	yes		The number of cursors that have timed out.
`mongodb.data.size`	sum	int	By	development	yes	`db.namespace` (string)	The size of the collection. Data compression does not affect this value.
`mongodb.database.count`	sum	int	{databases}	development	yes		The number of existing databases.
`mongodb.deletes.rate`	gauge	double	{delete}/s	development	no		The number of deletes executed per second.
`mongodb.document.operation.count`	sum	int	{documents}	development	yes	`db.namespace` (string), `operation` (string)	The number of document operations executed.
`mongodb.extent.count`	sum	int	{extents}	development	yes	`db.namespace` (string)	The number of extents.
`mongodb.flushes.rate`	gauge	double	{flush}/s	development	no		The number of flushes executed per second.
`mongodb.getmores.rate`	gauge	double	{getmore}/s	development	no		The number of getmores executed per second.
`mongodb.global_lock.time`	sum (monotonic)	int	ms	development	yes		The time the global lock has been held.
`mongodb.health`	gauge	int	1	development	no		The health status of the server. A value of '1' indicates healthy. A value of '0' indicates unhealthy.
`mongodb.index.access.count`	sum	int	{accesses}	development	yes	`collection` (string), `db.namespace` (string)	The number of times an index has been accessed.
`mongodb.index.count`	sum	int	{indexes}	development	yes	`db.namespace` (string)	The number of indexes.
`mongodb.index.size`	sum	int	By	development	yes	`db.namespace` (string)	Sum of the space allocated to all indexes in the database, including free index space.
`mongodb.inserts.rate`	gauge	double	{insert}/s	development	no		The number of insertions executed per second.
`mongodb.lock.acquire.count`	sum (monotonic)	int	{count}	development	no	`db.namespace` (string), `lock_mode` (string), `lock_type` (string)	Number of times the lock was acquired in the specified mode.
`mongodb.lock.acquire.time`	sum (monotonic)	int	us	development	no	`db.namespace` (string), `lock_mode` (string), `lock_type` (string)	Cumulative wait time for the lock acquisitions.
`mongodb.lock.acquire.wait_count`	sum (monotonic)	int	{count}	development	no	`db.namespace` (string), `lock_mode` (string), `lock_type` (string)	Number of times the lock acquisitions encountered waits because the locks were held in a conflicting mode.
`mongodb.lock.deadlock.count`	sum (monotonic)	int	{count}	development	no	`db.namespace` (string), `lock_mode` (string), `lock_type` (string)	Number of times the lock acquisitions encountered deadlocks.
`mongodb.memory.usage`	sum	int	By	development	yes	`db.namespace` (string), `memory_type` (string)	The amount of memory used.
`mongodb.network.io.receive`	sum	int	By	development	yes		The number of bytes received.
`mongodb.network.io.transmit`	sum	int	By	development	yes		The number of by transmitted.
`mongodb.network.request.count`	sum	int	{requests}	development	yes		The number of requests received by the server.
`mongodb.object.count`	sum	int	{objects}	development	yes	`db.namespace` (string)	The number of objects.
`mongodb.operation.count`	sum (monotonic)	int	{operations}	development	yes	`operation` (string)	The number of operations executed.
`mongodb.operation.latency.time`	gauge	int	us	development	no	`operation_latency` (string)	The latency of operations.
`mongodb.operation.repl.count`	sum (monotonic)	int	{operations}	development	no	`operation` (string)	The number of replicated operations executed.
`mongodb.operation.time`	sum (monotonic)	int	ms	development	yes	`operation` (string)	The total time spent performing operations.
`mongodb.page_faults`	sum (monotonic)	int	{faults}	development	no		The number of page faults.
`mongodb.queries.rate`	gauge	double	{query}/s	development	no		The number of queries executed per second.
`mongodb.repl_commands_per_sec`	gauge	double	{command}/s	development	no		The number of replicated commands executed per second.
`mongodb.repl_deletes_per_sec`	gauge	double	{delete}/s	development	no		The number of replicated deletes executed per second.
`mongodb.repl_getmores_per_sec`	gauge	double	{getmore}/s	development	no		The number of replicated getmores executed per second.
`mongodb.repl_inserts_per_sec`	gauge	double	{insert}/s	development	no		The number of replicated insertions executed per second.
`mongodb.repl_queries_per_sec`	gauge	double	{query}/s	development	no		The number of replicated queries executed per second.
`mongodb.repl_updates_per_sec`	gauge	double	{update}/s	development	no		The number of replicated updates executed per second.
`mongodb.session.count`	sum	int	{sessions}	development	yes		The total number of active sessions.
`mongodb.storage.size`	sum (monotonic)	int	By	development	yes	`db.namespace` (string)	The total amount of storage allocated to this collection. If collection data is compressed it reflects the compressed size.
`mongodb.updates.rate`	gauge	double	{update}/s	development	no		The number of updates executed per second.
`mongodb.uptime`	sum (monotonic)	int	ms	development	no		The amount of time that the server has been running.
`mongodb.wt.concurrent_transaction.ticket.in_use`	sum	int	{ticket}	development	no	`mongodb.wt.concurrent_transaction.ticket.type` (string)	The number of in-flight WiredTiger read/write concurrent-transaction tickets.
`mongodb.wt.fsync.count`	sum (monotonic)	int	{fsync}	development	no		The total number of fsync I/Os issued by the WiredTiger storage engine.
`mongodb.wt.log.operation.count`	sum (monotonic)	int	{operation}	development	no	`mongodb.wt.log.operation.type` (string)	The total number of WiredTiger journal operations.
`mongodb.wt.log.sync.time`	sum (monotonic)	double	s	development	no		The cumulative time spent syncing the WiredTiger journal.
`mongodb.wt.log.write`	sum (monotonic)	int	By	development	no		The total number of bytes written to the WiredTiger journal.
`mongodb.wtcache.bytes.read`	sum (monotonic)	int	By	development	no		The number of bytes read into the WiredTiger cache.

Attributes

Attribute	Type	Description
`client.address`	string	Hostname or address of the client.
`client.port`	int	TCP port used by the client.
`collection`	string	The name of a collection.
`connection_type`	string	The status of the connection.
`db.collection.name`	string	The MongoDB collection being accessed within the database stated in db.namespace.
`db.namespace`	string	The name of a database.
`db.operation.name`	string	The name of the MongoDB command being executed (e.g. find, aggregate, insert).
`db.query.text`	string	The obfuscated MongoDB command statement.
`db.system.name`	string	The database management system (DBMS) product as identified by the client instrumentation.
`lock_mode`	string	The mode of Lock which denotes the degree of access
`lock_type`	string	The Resource over which the Lock controls access
`memory_type`	string	The type of memory used.
`mongodb.client.app.name`	string	The identifier of the client application which ran the operation, as set by the driver's `appName` connection option.
`mongodb.cursor.await_data`	bool	Whether the tailable cursor waits for new data instead of returning immediately.
`mongodb.cursor.id`	string	The identifier of the cursor.
`mongodb.cursor.no_timeout`	bool	Whether the cursor is configured not to time out when idle.
`mongodb.cursor.originating_command`	string	The obfuscated command that originally created the cursor.
`mongodb.cursor.returned_batches`	int	The cumulative number of batches returned by the cursor.
`mongodb.cursor.returned_documents`	int	The cumulative number of documents returned by the cursor.
`mongodb.cursor.tailable`	bool	Whether the cursor is a tailable cursor.
`mongodb.explain_plan.hash`	string	FNV-64a hash of the obfuscated explain plan structure, identifying the execution plan shape.
`mongodb.explain_plan.text`	string	The obfuscated query explain plan, if collection is enabled.
`mongodb.lsid.id`	string	The UUID portion of the logical session identifier associated with the MongoDB operation.
`mongodb.operation.comment`	slice	The comments attached to the MongoDB command. String comments are reported as-is; array comments are expanded into multiple entries; non-string values are reported as MongoDB Extended JSON.
`mongodb.operation.cpu.time`	double	CPU time in seconds for this query execution.
`mongodb.operation.docs_examined`	int	Number of documents examined by this query execution.
`mongodb.operation.docs_returned`	int	Number of documents returned by this query execution.
`mongodb.operation.duration`	double	The duration of the MongoDB operation in seconds.
`mongodb.operation.id`	string	Identifier of the MongoDB operation.
`mongodb.operation.keys_examined`	int	Number of index keys examined by this query execution.
`mongodb.operation.plan.summary`	string	Summary of the execution plan for the MongoDB operation.
`mongodb.operation.prepared_read_conflict.count`	int	The number of times the MongoDB operation had to wait for a prepared transaction with a write to commit or abort.
`mongodb.operation.response_length`	int	Response length in bytes for this query execution.
`mongodb.operation.state`	string	Simplified state of the MongoDB operation.
`mongodb.operation.type`	string	The raw MongoDB operation type from `$currentOp.op` (e.g. query, insert, update, remove, getmore, command).
`mongodb.operation.wait.details`	string	Details about what the MongoDB operation is waiting on.
`mongodb.operation.wait.type`	slice	The set of wait conditions the MongoDB operation is currently blocked on. Possible values: `lock` (from `waitingForLock`), `flow_control` (from `waitingForFlowControl`), and `latch` (when `waitingForLatch` is a non-empty document). An empty slice indicates the operation is not waiting on any of these conditions.
`mongodb.operation.write_conflict.count`	int	The number of times the MongoDB operation conflicted with another write operation on the same document.
`mongodb.operation.yield.count`	int	The number of times the MongoDB operation yielded to allow other operations to complete.
`mongodb.query.framework`	string	The MongoDB query execution engine that processed this operation. Only present for operations that flow through the query subsystem (reads, read-modify-writes, and getMore continuations); absent for pure inserts, index management, and administrative commands. Known values include `classic` and `sbe`.
`mongodb.query.truncated`	bool	Whether the value carried by db.query.text is a truncated rendering of the MongoDB command, as indicated by `$truncated` in the currentOp output.
`mongodb.wt.concurrent_transaction.ticket.type`	string	The WiredTiger concurrent-transaction ticket type.
`mongodb.wt.log.operation.type`	string	The WiredTiger journal operation type.
`operation`	string	The MongoDB operation being counted.
`operation_latency`	string	The MongoDB operation with regards to latency
`type`	string	The result of a cache request.
`user.name`	string	Name of the user associated with the operation.

Data

JSON (latest): /data/collector/components/contrib-mongodbreceiver/latest.json
JSON (pinned): /data/collector/components/contrib-mongodbreceiver/contrib-mongodbreceiver-17c03051faa1.json
Explore: /collector/components/contrib/mongodbreceiver