- API >
- Public API Resources >
- Deployments >
- Hosts >
- Begin Monitoring One Host
Begin Monitoring One Host¶
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. This page uses the more familiar term group when
referring to descriptions. The endpoint remains as stated in the
document.
Start monitoring a new MongoDB process. The Monitoring Agent starts monitoring the MongoDB process on the hostname and port you specify. Ops Manager knows only the information that you provide. The response document includes blank values until Ops Manager completes discovery of the MongoDB processes configuration.
Base URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Resource¶
Request Path Parameters¶
Parameter |
Type | Necessity | Description |
---|---|---|---|
PROJECT-ID |
string | Required | Unique identifier of the project that owns this MongoDB process. |
Request Query Parameters¶
This endpoint may use any of the HTTP request query parameters available to all Ops Manager API resources. These are all optional.
Name | Type | Description | Default | ||||||
---|---|---|---|---|---|---|---|---|---|
pretty |
boolean | Indicates whether the response body should be in a prettyprint format. | false |
||||||
envelope |
boolean | Indicates whether or not to wrap the response in an envelope. Some API clients cannot access the HTTP response headers or
status code. To remediate this, set For endpoints that return one result, the response body includes:
|
false |
Request Body Parameters¶
Name |
Type | Necessity | Description |
---|---|---|---|
alertsEnabled |
boolean | Optional | Set to true if alerts should be enabled for this MongoDB
process. |
authMechanismName |
string | Optional | Specify which authentication mechanism should be used to connect to this MongoDB process. Possible values are:
|
hostname |
string | Required | Set the primary hostname Ops Manager should use to connect to this MongoDB instance. |
logsEnabled |
boolean | Optional | Set to true if Ops Manager should collect logs for this MongoDB
process. |
muninPort |
number | Optional | Port number Munin uses to collect hardware statistics for this MongoDB process. Note Ops Manager deprecated using Munin to monitor hardware. To learn more about Munin and Ops Manager, see Configure Hardware Monitoring with munin-node. |
password |
string | Optional | Password associated with Set this parameter if Ops Manager doesn’t include this parameter in any Host || response. |
port |
number | Required | Port on which MongoDB process listens. |
profilerEnabled |
boolean | Optional | Flag indicating whether Ops Manager collects profile information from this MongoDB process. |
sslEnabled |
boolean | Conditional | Flag indicating whether TLS should be enabled for this MongoDB process. Set to |
username |
string | Conditional | Username needed to connect to this MongoDB process. Required if |
Response¶
Name | Type | Description |
---|---|---|
aliases |
array of strings | A list of alternate hostname:port combinations that Ops Manager discovered for the MongoDB process. |
alertsEnabled |
boolean | true if this MongoDB process has alerts enabled. |
authMechanismName |
string | The authentication mechanism used to connect to this MongoDB process. This displays only one of the following values:
|
clusterId |
string | The ID of the cluster to which the MongoDB process belongs. |
created |
date | Date Ops Manager created or first discovered this MongoDB process. |
groupId |
string | ID of the group that owns this alert configuration. |
hasStartupWarnings |
boolean | true if this MongoDB process had startup warnings. |
hidden |
boolean | true if host is displayed in the Ops Manager UI. Hosts set to
true are omitted from API responses. |
hiddenSecondary |
boolean | true if this host is a
hidden secondary. |
hostEnabled |
boolean | true if the MongoDB process currently enabled. |
hostname |
string | The primary hostname as Ops Manager can best determine. |
id |
string | Unique identifier. |
ipAddress |
string | IP address associated with the hostname of this MongoDB
process. Additional accessible IP addresses may be displayed
in the aliases array. |
journalingEnabled |
boolean | true if journaling is enabled for this MongoDB process. |
lastDataSizeBytes |
number | The uncompressed size of the host’s databases on disk in bytes
excluding indexes. lastDataSizeBytes does not include
the data in the local
database. |
lastIndexSizeBytes |
number | The uncompressed size of the host’s database indexes on disk in bytes. This number does not include the size of the index for the local database. |
lastPing |
date | The point in time when the last ping for this MongoDB process was received in ISO 8601 date and time format in UTC. |
lastRestart |
date | The point in time when this process last restarted in
ISO 8601
date and time format in UTC. If the MongoDB process has never been restarted, the
lastRestart field is omitted. |
links |
array | This array includes one or more links to sub-resources and/or
related resources. The relations between URLs are explained in
the Web Linking Specification. At minimum, a
links array contains one link called self . |
logsEnabled |
boolean | true if Ops Manager is collecting logs for this MongoDB
process. |
lowUlimit |
boolean | true if this MongoDB process’s host has a low ulimit
setting. |
muninEnabled |
boolean |
Note Use of Munin for hardware monitoring is deprecated. For more information on Munin and Ops Manager, see Configure Hardware Monitoring with munin-node. |
muninPort |
number | Port number Munin uses to collect hardware statistics for this MongoDB process. Note Use of Munin for hardware monitoring is deprecated. For more information on Munin and Ops Manager, see Configure Hardware Monitoring with munin-node. |
port |
number | Port on which the MongoDB process listens. |
profilerEnabled |
boolean | true if Ops Manager collects profile information from this
MongoDB process. |
replicaSetName |
string | Name of the replica set this process belongs to. Only present if this process is part of a replica set. |
replicaStateName |
string | Current state of this MongoDB process within a replica set. Only present if this process is part of a replica set. See Replica Set Member States for possible values. |
shardName |
string | Name of the shard this process belongs to. Only present if the process is part of a sharded cluster. |
slaveDelaySec |
number | Number of seconds this replica set member’s data
trails the primary. If this value is set to 0 ,
the member is not configured as a delayed member.
For additional details on slave delays, see
Delayed Replica Set Members |
sslEnabled |
boolean | true if SSL/TLS and is enabled for this MongoDB
process. |
typeName |
string | Type for this MongoDB process. Possible values are:
The type for new hosts added to Ops Manager will be |
uptimeMsec |
number | Number of milliseconds since this process last restarted. |
version |
string | Version of MongoDB running for this process. |