- User Guide >
- User Settings
User Settings¶
On this page
The Administration tab lets users personalize their console and activate or deactivate a variety of features. The Administration tab provides the pages described here.
Account Page¶
The Account page allows users to update their personal information.
The username, email address, and password are also used for jira.mongodb.org. Changing your email address or password in MMS will also change the email address and password you use to log into Jira.
User Name: Displays the user’s name. You cannot change your username.
Email Address: Displays the email address MMS associates with your account. You can change your email address by clicking on the “pencil” icon.
Mobile Phone Number: The number to use to receive SMS alerts, including two-factor authentication codes.
Password: Allows you to change your MMS password. Passwords must fulfill MMS’s password requirements.
Two-Factor Authentication: MMS requires two factor authentication for login. For details, see Two-Factor Authentication.
To delete or reset two-factor authentication, contact your MMS system administrator.
Personalization Page¶
The Personalization page allows users to configure the console to suit their needs and preferences.
- My Dashboard: Sets the default dashboard on the “Dashboard” page. You can select from a list of all of your dashboards.
- My Time Zone: Sets your local time zone.
- My Date Format: Allows you to select your preferred date format.
- Page Shown When Switching Groups: Sets which page of the MMS console you will see when you select a different group. If you select Current, MMS will not change pages when you select a different group.
- Display Opcounters On Separate Charts: Allows you to control the presentation of Opcounter Charts. If enabled, MMS charts each opcounter type separately. Otherwise, each opcounter type is overlaid together in a single chart.
- Display Chart Annotations: Toggles the presence of chart annotations. Chart annotations overlay information about significant system events on the charts. For example, with chart annotations MMS will draw a red vertical line over the charts.
- Receive MMS Newsletters: Allows you to opt-in to, or opt-out of receiving e-mail newsletters about MMS.
Public API Settings Page¶
Public API Settings displays the On Prem MMS Monitoring API Key for your MMS group. Keep this key private. Use the API key to support automated installation of your Monitoring Agent with scripts included with the agent installation files.
Group Settings Page¶
These settings are general settings that apply to all users in the current group. There are also admin only group settings, see Admin Only Group Settings.
- Group Time Zone: Sets your group’s time zone.
- Collect Logs For All Hosts: Activates or deactivates the collection of log data for all hosts. This overwrites the statuses set on the individual hosts.
- Collect Profiling Information for All Hosts: Activates or deactivates the collection of profiling information for all hosts. MMS Monitoring can collect data from MongoDB’s profiler to provide statistics about performance and database operations. Ensure exposing profile data to MMS Monitoring is consistent with your information security practices. Also be aware the profiler can consume resources which may adversely affect MongoDB performance.
- Collect Database Specific Statistics: Allows you to enable or disable the collection of database statistics. For more information, see “How does MMS gather database statistics?”.
- Monitoring Agent’s Log Level: Allows adjustment of the log level of the Monitoring Agent from the settings menu without restarting the agent. The Default level maintains the level specified when starting the Monitoring Agent. Setting the log level on the agent requires Monitoring Agent version 2.0.0+.
- Preferred Hostnames: Allows you to specify the hostname to use for servers with multiple aliases. This prevents servers from appearing multiple times under different names. By default, the Monitoring Agent tries to connect by resolving hostnames. If the agent cannot connect by resolving a hostname, you can force the Monitoring Agent to prefer an IP address over its corresponding hostname for a specific IP address. To override this default behavior, set an IP address as a preferred hostname. If your IP addresses have a common prefix, create a preferred hostname with the ends-with button or click the regexp button to use a regular expression.
- Reset Duplicates: Allows you to reset and remove all detected duplicate hosts. This is useful if your server environment has drastically changed and you believe a host is incorrectly marked as a duplicate.
Group Alerts Page¶
Group Alerts defines the default settings for HipChat, PagerDuty, and other third-party groups used to send alerts. See Activity Alert Settings page page for details about using these third-party services to manage alerts.
Agent API Settings Page¶
- Group ID: The group ID.
- API Key: Displays the API key that identifies the group to the agents. All Monitoring, Backup, and Automation agents in this group include this key in their configuration files. They key ensures the agents communicate with the correct group.
On Prem MMS Backup Settings¶
The following settings will only be visible to users of On Prem MMS Backup.
Backup Agent¶
Backup Agent provides links for downloading the
pre-configured Backup Agent in both .zip and .tar.gz formats,
on a variety of platforms. Backup
requires this agent.
Public Key for SCP Restores¶
Public Key for SCP Restores, or “MMS Backup Public Key” enables users who have signed up for doc:Backup </tutorial/nav/backup-agent> to generate a new public key that MMS will use to connect via SSH and transmit a snapshot of your data.
Restore Settings Page¶
The Restore Settings page provides the ability to generate a public key for SCP backup restoration through the Backup and Restore Service.
If using SCP backup restoration, see how to validate an SCP restore and other SCP FAQs.
Agents Page¶
The Agent page displays the status of your installed agent and
provides links to download new agents, in both .zip and .tar.gz
formats. The software is dynamically assembled with your API key.
Instructions are included to set up and start the downloaded agent, as
well as create a new user for the agent if MongoDB authentication is used.
The Agents page includes the following information about your installed agents:
| Field | Description |
|---|---|
| Status | The time of the last ping from the agent. |
| Type | The type of agent. |
| Hostname | The hostname for the agent and any warnings, such as that the agent is down or out-of-date. |
| State | Indicates whether the agent is active. |
| Ping Count | The number of pings (i.e. data payloads) sent by the agent since midnight GMT. Typically agents send pings every minute. |
| Version | The version of the agent software running on this agent instance. |
| Log | Click view logs to view the agent’s log. |
If you have more than one Monitoring Agent, only one agent actively monitors MongoDB instances at a time. See Monitoring Architecture for more information.
Admin Only Group Settings¶
New in version 1.5.4.
To access the admin-only group settings, click the Group Settings Page link, which is located under the Admin Only header of the Settings tab.
In certain situations, these settings can affect more than the group. For example, setting logging to high verbosity would cause system logs to roll over faster.
Only users with the Global Owner role can edit these settings:
- Mongos Deactivation Threshold: Change the amount of time before On-Prem MongoDB Management Service stops monitoring an unreachable mongos. By default, the Monitoring Agent stops monitoring an unreachable mongos after 24 hours. Set this to the amount of time in hours to wait before deactivation.
- Monitoring Agent Log Level: Change the verbosity of the Monitoring Agent log.
- Automation Agent Log Level: Change the verbosity of the Automation Agent log.