Skip to content

Collector Configuration Manual for "Mongodb Atlas"

Before reading this, please first read:

Before using this collector, you must install the 'Integration Core Package' and its accompanying third-party dependency packages.

Before using this collector, you need to configure the corresponding api keys with at least Project Read Only permissions, and add the IP to the API Access List.

This collector supports multi-threading by default (five threads are enabled by default). If you need to change the thread pool size, you can set the environment variable COLLECTOR_THREAD_POOL_SIZE.

1. Configuration Structure

The configuration structure of this collector is as follows:

Field Type Required Description
group_id list Optional IDs of projects to be collected. By default, if not configured, it will detect all projects under the account.

2. Configuration Example

Collecting Metrics from Specific Projects

Collect metrics from project ID 660400axxxx.

Python
1
2
3
4
collector_configs = {
    'group_id': ['660400axxxx'],

}

3. Reported Metrics Introduction

Metric Name Type Description
ASSERT_MSG float Displays the average rate per second of message assertions within the selected sample period. These internal server errors have well-defined text strings. Traces of these can be found in Atlas's logs.
ASSERT_REGULAR float Displays the average rate per second of regular assertions raised within the selected sample period.
ASSERT_USER float Displays the average rate per second of user assertions within the selected sample period. This metric includes user-generated assertions such as insufficient disk space or duplicate key errors.
ASSERT_WARNING float Displays the average rate per second of warnings within the selected sample period.
CACHE_BYTES_READ_INTO float Cache bytes read into memory.
CACHE_BYTES_WRITTEN_FROM float Cache bytes written out.
CACHE_DIRTY_BYTES float Dirty cache bytes.
CACHE_USED_BYTES float Used cache bytes.
CONNECTIONS float Displays the total number of active connections to the database deployment.
CURSORS_TOTAL_OPEN float Total number of open cursors.
CURSORS_TOTAL_TIMED_OUT float Displays the average rate per second of timed-out cursors within the selected sample period.
DATABASE_AVERAGE_OBJECT_SIZE float Average object size in the database.
DATABASE_COLLECTION_COUNT float Count of collections in the database.
DATABASE_DATA_SIZE float Data size of the database.
DATABASE_EXTENT_COUNT float Extent count in the database.
DATABASE_INDEX_COUNT float Index count in the database.
DATABASE_INDEX_SIZE float Index size in the database.
DATABASE_OBJECT_COUNT float Object count in the database.
DATABASE_STORAGE_SIZE float Storage size of the database.
DATABASE_VIEW_COUNT float View count in the database.
DB_DATA_SIZE_TOTAL float Total logical size of index data across all databases.
DB_DATA_SIZE_TOTAL_WO_SYSTEM float Sum of uncompressed document data in non-system databases.
DB_INDEX_SIZE_TOTAL float Total logical size of index data across all databases.
DB_STORAGE_TOTAL float Total compressed disk storage space allocated for document storage across all databases.
DISK_PARTITION_IOPS_READ float Disk partition I/O operations read throughput.
DISK_PARTITION_IOPS_TOTAL float Total disk partition I/O operations throughput.
DISK_PARTITION_IOPS_WRITE float Disk partition I/O operations write throughput.
DISK_PARTITION_LATENCY_READ float Read latency of the disk partition.
DISK_PARTITION_LATENCY_WRITE float Write latency of the disk partition.
DISK_PARTITION_SPACE_FREE float Available disk space on the disk partition.
DISK_PARTITION_SPACE_PERCENT_FREE float Percentage of available space on the disk partition.
DISK_PARTITION_SPACE_PERCENT_USED float Percentage of used space on the disk partition.
DISK_PARTITION_SPACE_USED float Used space on the disk partition.
DOCUMENT_METRICS_DELETED float Documents deleted.
DOCUMENT_METRICS_INSERTED float Documents inserted.
DOCUMENT_METRICS_RETURNED float Documents returned.
DOCUMENT_METRICS_UPDATED float Documents updated.
EXTRA_INFO_PAGE_FAULTS float Extra information page faults.
GLOBAL_LOCK_CURRENT_QUEUE_READERS float Number of operations queued waiting for a read lock.
GLOBAL_LOCK_CURRENT_QUEUE_TOTAL float Number of operations queued waiting for any lock.
GLOBAL_LOCK_CURRENT_QUEUE_WRITERS float Number of operations queued waiting for a write lock.
MAX_DISK_PARTITION_IOPS_READ float Maximum read throughput of disk partition I/O operations.
MAX_DISK_PARTITION_IOPS_TOTAL float Maximum total throughput of disk partition I/O operations.
MAX_DISK_PARTITION_IOPS_WRITE float Maximum write throughput of disk partition I/O operations.
MAX_DISK_PARTITION_LATENCY_READ float Maximum read latency of the disk partition.
MAX_DISK_PARTITION_LATENCY_WRITE float Maximum write latency of the disk partition.
MAX_DISK_PARTITION_SPACE_FREE float Maximum free space on the disk partition.
MAX_DISK_PARTITION_SPACE_PERCENT_FREE float Maximum percentage of free space on the disk partition.
MAX_DISK_PARTITION_SPACE_PERCENT_USED float Maximum percentage of used space on the disk partition.
MAX_DISK_PARTITION_SPACE_USED float Maximum used space on the disk partition.
MAX_PROCESS_CPU_CHILDREN_KERNEL float Maximum process CPU child kernel usage.
MAX_PROCESS_CPU_CHILDREN_USER float Maximum process CPU child user usage.
MAX_PROCESS_CPU_KERNEL float Maximum process CPU kernel usage.
MAX_PROCESS_CPU_USER float Maximum process CPU user usage.
MAX_PROCESS_NORMALIZED_CPU_CHILDREN_KERNEL float Maximum normalized process CPU child kernel usage.
MAX_PROCESS_NORMALIZED_CPU_CHILDREN_USER float Maximum normalized process CPU child user usage.
MAX_PROCESS_NORMALIZED_CPU_KERNEL float Maximum normalized process CPU kernel usage.
MAX_PROCESS_NORMALIZED_CPU_USER float Maximum normalized process CPU user usage.
MAX_SWAP_IO_IN float Maximum swap IO input.
MAX_SWAP_IO_OUT float Maximum swap IO output.
MAX_SWAP_USAGE_FREE float Maximum free swap usage.
MAX_SWAP_USAGE_USED float Maximum used swap usage.
MAX_SYSTEM_CPU_GUEST float Maximum normalized guest CPU usage for processes.
MAX_SYSTEM_CPU_IOWAIT float Maximum normalized iowait CPU usage for processes on the server.
MAX_SYSTEM_CPU_IRQ float Maximum normalized irq CPU usage for processes on the server.
MAX_SYSTEM_CPU_KERNEL float Maximum normalized CPU kernel space usage for processes on the server.
MAX_SYSTEM_CPU_NICE float Maximum normalized good CPU usage between processes on the server.
MAX_SYSTEM_CPU_SOFTIRQ float Maximum normalized soft interrupt CPU usage for processes on the server.
MAX_SYSTEM_CPU_STEAL float Maximum normalized stolen CPU usage for processes on the server.
MAX_SYSTEM_CPU_USER float Maximum normalized CPU user space usage for processes on the server.
MAX_SYSTEM_MEMORY_AVAILABLE float Maximum available physical memory.
MAX_SYSTEM_MEMORY_BUFFERS float Maximum system memory buffers.
MAX_SYSTEM_MEMORY_CACHED float Maximum cached system memory.
MAX_SYSTEM_MEMORY_FREE float Maximum available system memory.
MAX_SYSTEM_MEMORY_SHARED float Maximum shared system memory.
MAX_SYSTEM_MEMORY_USED float Maximum used physical memory.
MAX_SYSTEM_NETWORK_IN float Maximum network bytes received during the specified measurement granularity period.
MAX_SYSTEM_NETWORK_OUT float Maximum network bytes transmitted during the specified measurement granularity period.
MAX_SYSTEM_NORMALIZED_CPU_GUEST float Maximum normalized guest CPU usage for MongoDB processes.
MAX_SYSTEM_NORMALIZED_CPU_IOWAIT float Maximum normalized iowait CPU usage for processes on the server.
MAX_SYSTEM_NORMALIZED_CPU_IRQ float Maximum normalized irq CPU usage for processes on the server.
MAX_SYSTEM_NORMALIZED_CPU_KERNEL float Maximum normalized CPU kernel space usage for processes on the server.
MAX_SYSTEM_NORMALIZED_CPU_NICE float Maximum normalized good CPU usage for processes on the server.
MAX_SYSTEM_NORMALIZED_CPU_SOFTIRQ float Maximum normalized soft interrupt CPU usage for processes on the server.
MAX_SYSTEM_NORMALIZED_CPU_STEAL float Maximum normalized stolen CPU usage for processes on the server.
MAX_SYSTEM_NORMALIZED_CPU_USER float Maximum normalized CPU user space usage for processes on the server.
MEMORY_RESIDENT float Resident memory consumed by the MongoDB process on the server.
MEMORY_VIRTUAL float Virtual memory consumed by the MongoDB process on the server.
NETWORK_BYTES_IN float Displays the average rate per second of physical bytes sent to this database server within the selected sample period.
NETWORK_BYTES_OUT float Displays the average rate per second of physical bytes sent from this database server within the selected sample period.
NETWORK_NUM_REQUESTS float Displays the average rate per second of requests sent to this database server within the selected sample period.
OPCOUNTER_CMD float Command operations.
OPCOUNTER_DELETE float Delete operations.
OPCOUNTER_GETMORE float Get more operations.
OPCOUNTER_INSERT float Insert operations.
OPCOUNTER_QUERY float Query operations.
OPCOUNTER_REPL_CMD float Replica command operations.
OPCOUNTER_REPL_DELETE float Replica delete operations.
OPCOUNTER_REPL_INSERT float Replica insert operations.
OPCOUNTER_REPL_UPDATE float Replica update operations.
OPCOUNTER_UPDATE float Update operations.
OPERATIONS_SCAN_AND_ORDER float Average rate per second of operations that perform a sort but cannot use an index to perform the sort within the selected time period.
OPLOG_MASTER_LAG_TIME_DIFF float OPLOG master lag time difference.
OPLOG_MASTER_TIME float OPLOG master time.
OPLOG_RATE_GB_PER_HOUR float OPLOG rate GB/hour.
OPLOG_REPLICATION_LAG_TIME float OPLOG replication lag time.
OPLOG_SLAVE_LAG_MASTER_TIME float OPLOG slave lag master time.
OP_EXECUTION_TIME_COMMANDS float Operation execution time commands.
OP_EXECUTION_TIME_READS float Operation execution time reads.
OP_EXECUTION_TIME_WRITES float Operation execution time writes.
PROCESS_CPU_CHILDREN_KERNEL float Process execution time kernel.
PROCESS_CPU_CHILDREN_USER float Process execution time user.
PROCESS_CPU_KERNEL float Displays the percentage of time the CPU spends servicing operating system calls for the MongoDB process.
PROCESS_CPU_USER float Displays the percentage of time the CPU spends servicing the MongoDB process.
PROCESS_NORMALIZED_CPU_CHILDREN_KERNEL float Displays the percentage of time the CPU spends servicing operating system calls for the MongoDB process.
PROCESS_NORMALIZED_CPU_CHILDREN_USER float Displays the percentage of time the CPU spends servicing the MongoDB process.
PROCESS_NORMALIZED_CPU_KERNEL float Displays the percentage of time the CPU spends servicing operating system calls for the MongoDB process.
PROCESS_NORMALIZED_CPU_USER float Displays the percentage of time the CPU spends servicing the MongoDB process.
QUERY_EXECUTOR_SCANNED float Scanned query executor.
QUERY_EXECUTOR_SCANNED_OBJECTS float Objects scanned by the query executor.
QUERY_TARGETING_SCANNED_OBJECTS_PER_RETURNED float Ratio measuring MongoDB query efficiency.
QUERY_TARGETING_SCANNED_PER_RETURNED float Ratio of scanned index entries to documents returned by queries.
SWAP_IO_IN float Swap IO input.
SWAP_IO_OUT float Swap IO output.
SWAP_USAGE_FREE float Total amount of swap space being used.
SWAP_USAGE_USED float Total amount of swap space being used.
SYSTEM_CPU_GUEST float Maximum normalized guest CPU usage for MongoDB processes.
SYSTEM_CPU_IOWAIT float Normalized iowait CPU usage between processes on the server.
SYSTEM_CPU_IRQ float Normalized irq CPU usage between processes on the server.
SYSTEM_CPU_KERNEL float Normalized CPU kernel space usage between processes on the server.
SYSTEM_CPU_NICE float Normalized CPU usage between processes on the server.
SYSTEM_CPU_SOFTIRQ float Normalized CPU usage between processes on the server.
SYSTEM_CPU_STEAL float Maximum normalized soft interrupt CPU usage for processes on the server.
SYSTEM_CPU_USER float Normalized CPU user space usage between processes on the server.
SYSTEM_MEMORY_AVAILABLE float Available physical memory.
SYSTEM_MEMORY_BUFFERS float System memory buffers.
SYSTEM_MEMORY_CACHED float Cached system memory.
SYSTEM_MEMORY_FREE float Shared system memory.
SYSTEM_MEMORY_SHARED float Used physical memory.
SYSTEM_MEMORY_USED float Used physical memory.
SYSTEM_NETWORK_IN float Average rate per second of physical bytes received.
SYSTEM_NETWORK_OUT float Average rate per second of physical bytes transmitted.
SYSTEM_NORMALIZED_CPU_GUEST float Normalized guest CPU usage for MongoDB processes.
SYSTEM_NORMALIZED_CPU_IOWAIT float Normalized iowait CPU usage for processes on the server.
SYSTEM_NORMALIZED_CPU_IRQ float Normalized irq CPU usage for processes on the server.
SYSTEM_NORMALIZED_CPU_KERNEL float Normalized CPU kernel space usage for processes on the server.
SYSTEM_NORMALIZED_CPU_NICE float Normalized good CPU usage between processes on the server.
SYSTEM_NORMALIZED_CPU_SOFTIRQ float Normalized soft interrupt CPU usage for processes on the server.
SYSTEM_NORMALIZED_CPU_STEAL float Normalized stolen CPU usage for processes on the server.
SYSTEM_NORMALIZED_CPU_USER float Normalized CPU user space usage for processes on the server.
TICKETS_AVAILABLE_READS float Available tickets for reads.
TICKETS_AVAILABLE_WRITE float Available tickets for writes.

4. Data Reporting Format

After data synchronization, you can view the data in the 'Metrics' section of TrueWatch.

For example, with the following collector configuration:

Python
1
2
3
4
collector_configs = {
    'group_id': ['xxxx'],

}

The reported data example is as follows:

JSON
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
{
  "measurement": "mongodb_atlas",
  "tags": {
    "groupId": "i-xxxx"
  },
  "fields": {
    "ASSERT_MSG": 0.0,
    "ASSERT_REGULAR": 0.0
  }
}

All metric values will be reported as float type.

X. Appendix

Please refer to the official MongoDB Atlas documentation: