This is a full list and explanation of the configurable properties of the Foglight for MongoDB agent. The Agent Installer Wizard provides access to the essential subset of available properties. To modify other properties or modify the agent configuration after creation, use the Agent Status dashboard.
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. The remaining columns are collection intervals in seconds. These are used to set the sampling frequencies. You can turn off a particular collection by setting its interval to 0. The defaults are set based on the type of data being collected.
Maximum entries to retrieve - The maximum number of log entries to retrieve from per collection period. Set to zero to retrieve all available entries. To disable the log collection, set the Log (sec) period to zero.
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.
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.
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.
Get Profiled Ops Query Options? – Set to true if you wish to include Query Options in the Profiled Ops collection, if that collection is enabled. This will cause query options to also be factored into the aggregation algorithm, meaning that less aggregation will occur if query options differ in operations of the same type being performed on the same namespace. It is also possible that sensitive data may be exposed in the query options.