- API >
- API Resources >
- Monitoring and Logs >
- Get Measurements for a MongoDB Process
Get Measurements for a MongoDB Process¶
On this page
Note
Groups and projects are synonymous terms. Your {GROUP-ID}
is the
same as your project ID. For existing groups, your group/project ID
remains the same. The resource and corresponding endpoints use the
term groups
.
Get measurements for a specific Atlas MongoDB process. A Atlas MongoDB
process can be either a mongod
or mongos
.
The Atlas API uses HTTP Digest Authentication. Provide a programmatic API public key and corresponding private key as the username and password when constructing the HTTP request.
For complete documentation on configuring API access for an Atlas project, see Configure Atlas API Access.
Base URL: https://cloud.mongodb.com/api/atlas/v1.0
Resource¶
Request Path Parameters¶
Parameter | Required/Optional | Description |
---|---|---|
GROUP-ID |
Required | ID of the project that owns this Atlas MongoDB process. |
HOST |
Required | The hostname of the machine running the Atlas MongoDB process. |
PORT |
Required | The port to which the Atlas MongoDB process listens. |
Request Query Parameters¶
Field | Required/Optional | Description |
---|---|---|
granularity |
Required | An ISO-8601-formatted time
period that specifies the interval between measurement data points. For
example, The supported values for this parameter are:
When you specify |
period |
Required | An ISO-8601-formatted time period that specifies the length of time in
the past to query. For example, to request the last 36 hours, specify:
period=P1DT12H . Mutually exclusive with start and end . |
start |
Required | The time at which to start retrieving measurements, as specified by an
ISO-8601 timestamp string. If you specify start you must also
specify end . Mutually exclusive with period . |
end |
Required | The time at which to stop retrieving measurements, as specified by an
ISO-8601 timestamp string. If you specify end you must also
specify start . Mutually exclusive with period . |
m |
Optional | Specifies which measurements to return. If To specify multiple values for You must specify measurements that are valid for the host. Atlas returns an error if any specified measurements are invalid For available measurements, see Measurement Values. |
pageNum |
Optional. | The page to return. Defaults to |
itemsPerPage |
Optional. | Number of items to return per page, up to a maximum of 500. Defaults to |
envelope |
Optional. | A boolean that specifies whether or not to wrap the response in an envelope. Defaults to |
pretty |
Optional | A boolean that specifies whether or not to return a “pretty-printed” JSON document. Defaults to |
Request Body Parameters¶
This endpoint does not use HTTP request body parameters.
Response Elements¶
Free Tier
M0
Free Tier clusters return a subset of the metrics documented here.
If you set the query element envelope
to true
, the response is wrapped
by the content
object.
The HTTP response returns a JSON document that includes the following objects:
Name | Type | Description |
---|---|---|
end |
string | The end of the period for which to retrieve measurements, specified as an ISO-8601 timestamp. |
granularity |
string | An ISO-8601-formatted
time period that specifies the size of the interval covered by each
data point. For example, PT5M specifies a 5-minute granularity. |
groupId |
string | ID of the project that owns the Atlas MongoDB process. |
hostId |
string | The hostname of the machine running the Atlas MongoDB process. |
links |
array | An array of documents, representing a link to one or more sub-resources and/or related resources such as list pagination. See Linking for more information. |
measurements |
object array | An array of measurements and their data points. |
measurements.dataPoints |
object array | An array of objects, where each object represents a single data
point. If there is no data point available for a particular moment in
time (i.e., a timestamp), the value field is set to null . |
measurements.dataPoints.timestamp |
string | The timestamp of the beginning of the time interval represented by this data point. |
measurements.dataPoints.value |
float | The value of the data point. |
measurements.name |
string | The name of the measurement. For possible values, see Measurement Values below on this page. |
measurements.units |
string | How the measurement is quantified. Possible units are:
|
processId |
string | The hostname and port of the machine running the Atlas MongoDB process. |
start |
string | The start of the period for which to retrieve measurements, specified as an ISO-8601 timestamp. |
Measurement Values¶
|
Measures the rate of asserts for a MongoDB process, as collected from
the MongoDB serverStatus
command’s asserts document. |
|
Applies to a MongoDB process’s WiredTiger
storage engine, as collected from the MongoDB serverStatus command’s
wiredTiger.cache and
wiredTiger.concurrentTransactions documents. |
|
Measures connections to a MongoDB process, as collected from the
MongoDB serverStatus
command’s connections document. |
|
Measures the number of cursors for a MongoDB
process, as collected from the MongoDB serverStatus command’s
metrics.cursor document. |
|
Measures the daily spend amount to determine if daily spend amount exceeds the daily spend limit. |
|
Measures the database’s on-disk storage space, as collected from the MongoDB dbStats command. |
|
The average rate per second of documents returned, inserted, updated, or deleted for a selected time period. |
|
Measurements on page faults related to the host. |
|
Memory usage for Full Text Search processes, in bytes. |
|
Disk space in use by Full Text Search indexes, in bytes. |
|
Percentage of CPU in use by Full Text Search processes. |
|
Measures operations waiting on locks, as collected from the MongoDB serverStatus command. |
|
Measures memory for a MongoDB process, as collected from the MongoDB
serverStatus command’s
mem document. |
|
Measures throughput for MongoDB process, as collected from the MongoDB
serverStatus command’s
network document. |
|
Measures the rate of database operations on a MongoDB process since the
process last started, as collected from the MongoDB
serverStatus command’s
opcounters document. |
|
Measures the rate of database operations on MongoDB secondaries, as collected from the MongoDB serverStatus command’s
opcountersRepl document. |
|
For a selected time period, the average rate per second for operations that perform a sort but cannot perform the sort using an index. |
|
Available to hosts running MongoDB v3.4+. The execution time in milliseconds per read, write, or command operation over the selected time period. |
|
Measurements that apply to the MongoDB process’s oplog. |
|
Amount in the pending invoice for the month is higher than the amount limit for the month. If necessary, use the API to Get Pending Invoice for an Organization. |
|
The average rate per second to scan index items during
queries and query-plan evaluations. This rate is driven by
the same value as totalKeysExamined in the output of
explain. This
measurement is found on the host’s Query Executor
chart, accessed when viewing metrics. |
|
The average rate per second to scan documents during queries
and query-plan evaluations. Atlas derives the rate using the
explain output’s
totalDocsExamined value. This measurement is found on the
host’s Query Executor chart, accessed when viewing
metrics. |
|
The ratio of the number of index items scanned to the number of
documents returned. This measurement is found on the host’s
Query Targeting chart, accessed when viewing metrics. |
|
The ratio of the number of documents scanned to the number of
documents returned. This measurement is found on the host’s
Query Targeting chart, accessed when viewing metrics. |
|
Measurement of the WiredTiger storage
engine wiredTiger.cache and
wiredTiger.concurrentTransactions documents as
collected from the MongoDB serverStatus command. |
|
The CPU usage of MongoDB. For servers with more than 1 CPU core, these values can exceed 100%. |
|
The CPU usage of MongoDB, scaled to a range of 0-100% by dividing by the number of CPU cores. |
|
CPU usage of processes on the host server. For servers with more than 1 CPU core, this value can exceed 100%. |
|
CPU usage of processes on the host server, scaled to a range of 0-100% by dividing by the number of CPU cores. |
Example Request¶
The following example request sets a granularity
and period
of one
minute. Replace the information in brackets {}
with your own Atlas
information to execute this example request: