Navigation

Get Monitoring Log Settings

Required Roles

This resource requires the Project Automation Admin role.

Resource

Base URL: https://cloud.mongodb.com/api/public/v1.0

GET /groups/{PROJECT-ID}/automationConfig/monitoringAgentConfig

Request

Path Parameters

Name Type Necessity Description
PROJECT-ID string Required Unique identifier of the group that owns the monitoring configuration.

Query Parameters

The following query parameters are optional:

Name Type Necessity Description Default
pretty boolean Optional Flag indicating whether the response body should be in a prettyprint format. false
envelope boolean Optional

Flag that 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 envelope=true in the query.

For endpoints that return one result, the response body includes:

Name Description
status HTTP response code
envelope Expected response body
false

Body Parameters

This endpoint does not use HTTP request body parameters.

Response

Parameter Type Necessity Description
logPath string Optional Absolute file path to which this MongoDB Agent writes its logs. If this is not specified, the log writes to standard error (stderr) on UNIX- and Linux-based systems and to the Event Log on Windows systems.
logRotate object Optional Thresholds after which this MongoDB Agent rotates the monitoring log.
logRotate
.sizeThresholdMB
integer Optional Maximum size, in MB, of a log file before this MongoDB Agent rotates the logs.
logRotate
.timeDurationHrs
integer Optional Number of hours after which this MongoDB Agent rotates the log file.
username string Optional

MongoDB user in the application database that manages the monitoring logs.

If you use the API to enable authentication for the MongoDB Agent, set this parameter to mms-automation when executing this endpoint.

Example Request

1
2
3
4
5
6
curl --user "{publicApiKey}:{privateApiKey}" --digest \
     --header "Accept: application/json" \
     --header "Content-Type: application/json" \
     --include \
     --request GET "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/automationConfig/monitoringAgentConfig?pretty=true" \
     --output currentMonitoringConfig.json

Example Response

Response Header

HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=ISO-8859-1
Date: {dateInUnixFormat}
WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=false
Content-Length: {requestLengthInBytes}
Connection: keep-alive
HTTP/1.1 200 OK
Vary: Accept-Encoding
Content-Type: application/json
Strict-Transport-Security: max-age=300
Date: {dateInUnixFormat}
Connection: keep-alive
Content-Length: {requestLengthInBytes}
X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}

Response Body

1
2
3
4
5
6
7
8
9
{
  "logPath": "/var/log/mongodb-mms-automation/monitoring-agent.log",
  "logPathWindows": "%SystemDrive%\\MMSAutomation\\log\\mongodb-mms-automation\\monitoring-agent.log",
  "logRotate": {
    "sizeThresholdMB": 1000.0,
    "timeThresholdHrs": 24
  },
  "username": "mms-automation"
}