Reference >
Monitoring Agent Configuration

Monitoring Agent Configuration¶

On this page

Connection Settings
HTTP Proxy Settings
MongoDB SSL Settings
MongoDB Kerberos Settings
MMS Server SSL Settings
Munin Settings
Deprecated Settings

Connection Settings¶

For the Monitoring Agent communication with the MMS Servers, the following connection settings are required:

mmsApiKey¶

Type: string

The MMS agent API key for a MMS group. The API Key appears in the MMS interface on the Settings in the Agent API Settings section. For example:

copy

mmsApiKey=abc123

mmsBaseUrl¶

Type: string

The URL of the MMS Web Server.

Set this to the URL of your MMS HTTP Service. For example:

copy

mmsBaseUrl=http://example.com:8080

HTTP Proxy Settings¶

httpProxy¶

New in version 2.3.1.

Type: string

To connect to the MMS HTTP Service via a proxy, specify the URL of the proxy. For example:

copy

httpProxy=http://example-proxy.com:8080

MongoDB SSL Settings¶

Specify these settings when the Monitoring Agent is connecting to MongoDB instances with SSL.

useSslForAllConnections¶

Type: boolean

Set to true``to enables SSL support globally and to use SSL for all MongoDB connections. Setting this to ``true overrides any per-host SSL settings configured in the On-Prem MongoDB Management Service interface.

When true, On-Prem MongoDB Management Service requires that you also specify a value for the``sslTrustedServerCertificates`` setting.

sslClientCertificate¶

Type: string

The path to the private key, client certificate, and optional intermediate certificates in PEM format. The agent will use the client certificate when connecting to any configured MongoDB that use SSL and require client certificates, i.e. that are running using the --sslCAFile option.

sslClientCertificatePassword¶

Type: string

The password needed to decrypt the private key in the sslClientCertificate file. This setting is only necessary if the client certificate PEM file is encrypted.

sslTrustedServerCertificates¶

Type: string

The path on disk that contains the trusted certificate authority certificates in PEM format. These certificates will verify the server certificate returned from any MongoDBs running with SSL. For example:

copy

sslTrustedServerCertificates=/etc/mongodb-mms/mongodb-certs.pem

sslRequireValidServerCertificates¶

Type: boolean

Use this option to disable certificate verification by setting this value to false. That configuration is only recommended for testing purposes as it makes connections susceptible to man-in-the-middle attacks.

MongoDB Kerberos Settings¶

See Connect to Hosts with Kerberos Authentication

krb5Principal¶

Type: string

The Kerberos principal used by the agent. For example:

copy

krb5Principal=mmsagent/myhost@EXAMPLE.COM

krb5Keytab¶

Type: string

The absolute path to Kerberos principal’s keytab file. For example:

copy

krb5Keytab=/etc/mongodb-mms/mms-monitoring-agent.keytab

MMS Server SSL Settings¶

Advanced SSL settings used by the Monitoring Agent when communicating to the MMS HTTP Service.

sslTrustedMMSServerCertificate¶

By default the Monitoring Agent will use the trusted root CAs installed on the system. If the agent cannot find the trusted root CAs, configure these settings manually.

If the MMS HTTP Service uses a self-signed SSL certificate, you must specify sslTrustedMMSServerCertificate.

The path on disk that contains the trusted certificate authority certificates in PEM format. The agent will use this certificate to verify that the agent is communicating with the designated MMS HTTP Service. For example:

copy

sslTrustedMMSServerCertificate=/etc/mongodb-mms/mms-certs.pem

sslRequireValidMMSServerCertificates¶

Type: boolean

You can disable certificate verification by setting this value to false. That configuration is only recommended for testing purposes as it makes connections susceptible to man-in-the-middle attacks.

Munin Settings¶

See Configure Hardware Monitoring with munin-node for information on configuring Munin-node.

enableMunin¶

Type: boolean

Set to false if you do not with the Monitoring Agent to collect hardware statistics via Munin-node. The default is true. If the agent detects munin-node, MMS will collect hardware statistics.

Deprecated Settings¶

MongoDB Authentication Settings¶

If all monitored MongoDB instances use the same MONGODB-CR credentials, you may use these settings. Setting the username and password here will override any configuration in the MMS UI.

See Required Access for Monitoring Agent for information on the privileges needed for this user.

globalAuthUsername¶

Type: string

The MongoDB username that the Monitoring Agent will use to connect. This value overrides all other usernames configured for the Monitoring Agent.

Example:

copy

globalAuthUsername=mms-monitoring-agent

globalAuthPassword¶

Type: string

The password for the globalAuthUsername user. This value overrides all other passwords configured for the Monitoring Agent.

Example:

copy

globalAuthPassword=somePassword

← Monitoring Reference Backup Agent Configuration →