To modify the agent properties for a new agent instance:
- IP or Hostname – Host where MongoDB database server is running. Default is “localhost”. (e.g.or hostname or IP address )
- Port – Port the MongoDB database is running. Default is 27017.
- Username – User that can connect to the MongoDB server being monitored.
- Password – Password of the user that can connect to the MongoDB server being monitored.
- Use TLS/SSL? – Enable an SSL connection to the MongoDB server. SSL must be enabled on the server. More information can be found in the Configuring an SSL Connection KB article 233610.
- Allow Invalid Cert Hostname? – If the client certificate is not configured specifically for the FglAM host, you can set this option to true to allow the certificate to be used anyway.
The Collection Interval fields in the agent properties are used to set the sample frequencies. You can turn off a collection by setting the interval to 0. The defaults are set based on the type of data being collected for relevancy.
- 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.
- 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.
- Server Display Aliases - A mapping from server address and port pairs to arbitrary name strings. The purpose of the alias is solely for human readability and convenience, to shorten long alphanumeric host addresses to descriptive, quickly recognizable names such as “PROD_BillingApp_QueryServer2”.
- 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.
- Monitor connection status for discoverable servers in sharded cluster? – If the agent is connecting to a mongos query server, setting this option to true enables discovery of all servers in the associated sharded cluster. Availability metrics will be collected for each mongos, mongod config server, and mongod shard server in the cluster.
- 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.
Two roles, MongoDB User and MongoDB Administrator, are installed with the cartridge. Viewing MongoDB dashboards requires that a user be assigned one of these or have the core Administrator role. Currently, there are no added privileges for the MongoDB Administrator role, but future cartridge versions which allow user interaction with the MongoDB Server will require this role.