Database Connections
The Connections property list contains the connection details necessary to access the database instances as well as host and display aliases, and collection intervals. Add one row for each mongos query server, config server, and mongod data server in the sharded cluster or replica set to be monitored. Do not add a row for arbiters. In each row, enter the host and port of the instance, the username and password of the database user, check whether SSL is required for access, and specify the authentication method. See below for host aliases - these can be configured as needed. Display aliases are solely for human readability and convenience, for example to shorten long alphanumeric host addresses to descriptive, quickly recognizable names such as "PROD_BillingApp_QueryServer2". Leave "Enable Monitoring" checked unless the server should be ignored for some reason.
Collection Periods
The collection periods are intervals between collections in seconds. They are used to set the sampling frequencies. A given collection can be disabled by setting its interval to zero. The defaults are set based on the type of data being collected. The following are the configurable collection periods: Connection Status, Server, Database, Collection, Top, Shard, Replication, Profiled Ops, Profiled Ops Buffer, Role, Parameters, Log.
RMI
- RMI Host - The public address of the FglAM running the MongoDB Foglight Agent. This is required for the collection of profiled operation live buffer data. Leave blank to disable.
- RMI Port – An available port on the FglAM host, specified by the RMI Host property, to be used for RMI communication with the FMS.
Log
- Maximum entries to retrieve – The maximum number of log entries to retrieve per instance, per collection period. Set to zero to disable the log collection for all MongoDB instances monitored by the agent. To disable the log collection on an individual instance, set the Log period to zero for just that instance in the Database Connections list.
- Log entry match list – A list of rules specifying conditions for when log entries should cause a Foglight alert to fire. Consists of a severity level found in the log entry, a regular expression text to search for in the log entry message text and the Foglight severity at which to fire an alarm if a match is found. Any entry with a log severity more extreme than the one provided in the list will naturally also trigger an alarm. Note that the log entry match list works by submitting data through the agent that will cause the rule “MongoDB Log Patterns” to trigger. Hence if this rule is disabled, no alerts will fire on log entries even if the match list has been set up with matching conditions.
- Log entry ignore list – The ignore list looks much like the match list except that it prevents triggering of the rule “MongoDB Log Patterns”. If a collected log entry matches a rule in the match list, it will only fire if it does not also match a rule in the ignore list.
Profiled Operations
- Max DBs To Collect – The maximum number of databases from which to collect profiled operations. Set to zero to disable profiled operation collection. The maximum allowed value is 100.
- DB Allow List – An optional list of database names to either allow or disallow. If any entry is disallowed, then data on all non-disallowed databases will be collected, otherwise only data for the specifically allowed databases will be collected.
- Profiled Ops Limit – The maximum number of profiled operations to collect in each collection period.
- Command Max Characters – The maximum character length of the profiled operation command text to store. Set to zero to disable command text collection.
- Sort Aggregated Ops By – The numerical property by which to select the top profiled operations. Available metrics are: Average Time, Executions, Max Time, and Total Time.
- In-Memory Buffer Size – The size of the in-memory buffer used to store the profiled operations buffer data (individual operations). This buffer resides on the Foglight Agent Manager and contributes to its memory usage. Set to zero to disable the profiled operations buffer collection. The maximum allowed value is 10 MB.
Options
- Host Aliases – A list of hostnames or IP addresses mapped to aliases. Can be used to standardize discovered hostnames from internal representations (e.g. in a cloud environment) to their external address. Enables, for example, the MongoDB cartridge to link directly to the Hosts dashboard by ensuring host data is submitted uniformly across the monitoring environment.
- Replica Set Aliases – A mapping from actual replica set names to aliases. This alias map is required to prevent collisions in collected data between different replica sets with the same name. Ideally, each replica set in an environment should be set up with a unique name.
- Cluster Alias – An arbitrary human-friendly name to display in place of the UUID cluster ID. Only used for sharded clusters.
- Enable Dynamic Memory Allocation? – Select yes to enable dynamic memory allocation. In this case memory may be added to the environment as the number of monitored MongoDB collections grows. If set to false, memory allocation is performed by the agent manager on a per-agent basis only.