Metrics¶
On this page
Important
The metrics
resource is deprecated and replaced by the
measurements resource.
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. This page uses the more familiar term group when
referring to descriptions. The endpoint remains as stated in the
document.
Base URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Endpoints¶
Get All Available Metrics¶
Get a list of all available metrics for the host. Each entity in the
list will be a partial metric entity. No data is
returned, but each entity contains a self
link which you may follow
to retrieve the full metric entity.
Get a Host Metric¶
Get the data points for the specified host and metric. If no additional query parameters are given, then the minute-level data for the past hour is returned.
The METRIC-NAME
may be any of the supported values listed for the
metricName
field, above. If the provided metric is a database-
level metric (e.g. DB_LOCK_PERCENTAGE
) or a hardware metric for a specific
device, then the response entity will contain a list of links to all available
database or hardware device metrics. You may also provide additional query
parameters:
Parameter | Acceptable Values | Default Value |
---|---|---|
granularity | The size of the epoch. Acceptable values are:
|
MINUTE . |
period | The ISO-8601 formatted time period that specifies how far back in the past to query. Example To request the last 36 hours of hour-level data,
you must specify: |
Get a Database Metric¶
Get the data points for the specified host, database metric, and
database name. The only available database-level metric is
DB_LOCK_PERCENTAGE
.
You may also provide additional query parameters:
Parameter | Acceptable Values | Default Value |
---|---|---|
granularity | The size of the epoch. Acceptable values are:
|
MINUTE . |
period | The ISO-8601 formatted time period that specifies how far back in the past to query. Example To request the last 36 hours of hour-level data,
you must specify: |
Get a Hardware Metric¶
Get the data points for the specified host, hardware metric, and device name.
The device-specific hardware metrics include the supported values for the
metricName
field can begin with MUNIN_IOSTAT_
.
Important
As of Automation 2.7.0, hardware monitoring using munin-node
is
deprecated.
You may also provide additional query parameters:
Parameter | Acceptable Values | Default Value |
---|---|---|
granularity | The size of the epoch. Acceptable values are:
|
MINUTE . |
period | The ISO-8601 formatted time period that specifies how far back in the past to query. Example To request the last 36 hours of hour-level data,
you must specify: |
Sample Entity¶
Entity Fields¶
Name | Type | Description |
---|---|---|
hostId | string | Unique identifier of the host to which this metric pertains. |
groupId | string | Unique identifier of the group that owns this host. |
metricName | string | The name of the metric. Possible values are:
|
units | string | The units in which the metric values are expressed. Possible values are:
|
granularity | string | The size of the epoch covered by each data point. Possible values are:
|
deviceName | string | The name of the device. Only present for hardware (e.g. Munin) metrics. |
databaseName | string | The name of the database. Only present for database-level metrics. |
dataPoints | object array | An array of objects, where each object represents a single metric data point. When there is no data point available for a particular epoch, then it will simply be missing from the array. Example If you request minute-level data points for 1:30PM through 2:00PM, but Ops Manager does not have a 1:31PM sample, then: |
dataPoints.$.timestamp |
date | The timestamp of the beginning of the epoch represented by this data point. |
dataPoints.$.value |
number | The value of the data point. |
Links¶
Relation | Description |
---|---|
self | Me |
http://mms.mongodb.com/group |
The group that the host belongs to. |
http://mms.mongodb.com/host |
The host to which the metric pertains. |