Administration >
Administer the System

Administer the System¶

On this page

General Tab
Backup Tab
Alerts Tab
Control Panel Tab

The Administration section of the Ops Manager application provides a tool to view system status, set cron jobs, manage users and groups, and perform other administrative functions.

If you have administrative privileges for the Ops Manager deployment, click the Admin link in the top right corner of Ops Manager to access the system administration tool.

This page describes the Admin section’s tabs and pages.

General Tab¶

The Admin interface’s General tab provides overview information, messages, reports, and access to users.

Overview Page¶

The General tab’s Overview page provides reports on system use and activity.

This page displays the summary table and Total Pages Viewed and Total Chart Requests charts.

A summary table reports totals for:

groups
active groups
active hosts
users
users active
ping spillover queue
increment spillover queue

Additionally two charts report:

total page views
total chart requests

Users Page¶

The General tab’s Users page displays a list of user information for all people with permission to use the Ops Manager application as well as provides an interface to manage users. Use the search box on the upper right corner to find a user record.

Users Information¶

For each user, the users table reports:

the username
the available roles, if any
the date and time of the last login.
the date and time of the last access event.
the total number of login.
the user’s configured timezone.
the creation date and time.

Edit a User Record¶

To edit a user record:

Click the pencil icon at the far right of the user record.
In the Edit User interface, you can:
- Edit the user’s email.
- Select the user’s groups and roles.
- Lock or unlock the account.
- Specify the user’s global roles.
When finished, click the Save button to save any changes and exit.

Groups Page¶

The General tab’s Groups page lists all groups created with their date created and the last date and time an agent for the group pinged Ops Manager.

Task	Procedure
Find a group	Use the search box at the top right of the page.
View a group’s details	Click the group name.
Delete a group	Click the group’s trash icon.

Logs Page¶

The General tab’s Logs page lists backup logs by job and class with messages grouped and counted by last hour, 6 hours, and last 2 days. Click a count number to see all messages in the group.

Version Manifest Page¶

The Version Manifest page lists all released MongoDB versions. Ops Manager requires this list to run in local mode. See Version Manifest in the Configure “Local Mode” if Servers Have No Internet Access tutorial for more information.

Messages Page¶

The General tab’s Messages page provides information on existing messages and provides an interface to add new messages or manage existing messages.

You can display a short message on any page of the Ops Manager application to notify or remind users, such as impending maintenance windows. Messages may be active, i.e. visible, on all pages or a subset of pages.

UI Messages Table¶

The UI Messages table holds all available messages. Use the search box on the top right to filter the list of messages.

For each message, the table reports:

which page or page prefix the message will appear on.
the text of the message.
whether the message is active or inactive. Active messages are also highlighted in orange.
the creation date and time for the message.
the date and time of the last modification for the message.

Add a Message¶

To add a message which appears on one page, or on all pages,

Click the Add Message button.
In the Add Message interface, enter
- the message, and
- the page URL or optionally, page prefix in the Add Message interface.
  
  The page prefix allows you to specify a path of a single page or the URL prefix of a group of pages. The prefix must begin with a / character.
Click the Active checkbox to make the message live. Optionally, you can leave the box unchecked to disable the message.
Click the Add button to add the message.

Once added, active messages take 60 seconds before they display.

Disable a Message¶

To disable a message, click the orange square button to the right of any alert listed on the Messages page. The orange button will change to a grey button.

To re-enable a disabled message, click the grey button; the grey button will change to back to an orange button.

Delete a Message¶

To delete a message, click the garbage can icon to the right of any alert listed on the Messages page.

Audits Page¶

The General tab’s Audits page displays all events tracked by Ops Manager. This includes the group events as well as internal and system events, which are not tracked at a group level.

Backup Tab¶

The Admin interface’s Backup tab provides information on Backup resources, including jobs, daemons, and blockstores. For an overview of Backup and Backup resources, see Backup Flows.

Jobs Page¶

The Backup tab’s Jobs page lets you manage Backup jobs and Backup resources for each group. The top part of the page displays Active Jobs and the bottom part displays Stopped Jobs. The following fields on the page have a yellow background if delayed:

Last Agent Conf, if older than 1 hour.
Last Oplog, if older than 1 hour before the Last Agent Conf.
Head Time, if older than 1 hour before Last Oplog.
Last Snapshot, if older than the snapshot interval multiplied by 1.5.

Manage Backup Jobs¶

From the Jobs page, you can do the following:

Task	Procedure
Assign a group to particular set of Backup Daemons or blockstores.	Click the group, select the daemons or blockstores, and select Save Changes.
View a job’s log.	Click the name of the job and then click the Logs link. Contact MongoDB Support if you need help interpreting the error message.
View information about a job.	Click the job. From the job’s page you can access logs, conf calls, and other information, and you can download diagnostics.
Move a job to a new Backup Daemon.	Click the job. On the job’s page, click the Move head link, select the new head, and click the Move Head button.
Filter the page to display the jobs assigned to a particular daemon or blockstore.	Click the name of the daemon or blockstore.

Manage Backup Resources¶

The Jobs page lets you assign which backup resources can be used by a particular group. You might do this, for example, for data locality or for data that requires a certain hardware profile.

You can make these changes for existing backups, but only new backup jobs will follow the new rules. Making these changes does not affect existing deployments. For additional procedural information, see Configure Backup Jobs and Storage.

Task

Procedure

Assign a group to particular daemons, blockstores, sync stores, or oplog stores.

Click the group to open the group’s assignment page; make the assignments; select Save Changes.

Assign a group to a labelled set of daemons, blockstores, sync stores, and oplog stores.

First assign the label on the Admin page for each resource. See Daemons Page, Blockstores Page, Sync Stores Page, and Oplog Stores Page.

Then, on the Jobs page:

Click the group name to open the group’s assignment page.
In the Assignment Labels list box, click Select Labels.
Select the label. Each selected label must exist on at least one daemon, one blockstore, one sync store, and one oplog store. If you select multiple labels, the resource must meet all selected labels.

Keep in mind that the resource must also meet any other selected criteria on this page. For example, for a daemon to match, it must also meet any selections you have made in the Backup Daemon field.
Click Save Changes.

Job Timeline Page¶

The Backup tab’s Job Timeline page displays a graphical representation of information found on other Admin pages, in particular the Jobs page. The Job Timeline page displays critical timestamps (head, last snapshot, next snapshot) and offers a way to assign a daemon to a given job.

Click the Auto refresh checkbox to update the list automatically every 10 seconds. Click the Refresh button to refresh data manually.

To view the backup job JSON, click the Show JSON link under the Group heading for any backup job. When the JSON displays, click the View raw runtime data link under the code to view the raw data. To hide the daemon JSON, click the Hide JSON link.

To move the job to a new Backup Daemon, click the Move head link under the Machine heading for a backup job. Select the location and click the Move head button to move the job to a new Backup Daemon. Ops Manager does not automatically move jobs between daemons.

You can bind a backup job to a head by clicking Set binding under the Machine heading for a backup job. You can bind a job to a preferred Backup Daemon during initial sync. After initial sync completes, Ops Manager automatically assigns jobs to Backup Daemons.

Logs Page¶

The Backup tab’s Logs page lists backup logs by job and class with messages grouped and counted by last 2 hours, last day, and last 3 days. Click a count number to see all messages in the group.

Restores Page¶

The Backup tab’s Restores page displays the last 100 requested restores and their progress. To show all restores ever requested, click Show All.

Resource Usage Page¶

The Backup tab’s Resource Usage page provides key size and throughput statistics on a per-job basis for all groups for which Backup is enabled. The page displays such throughput statistics as the size of the data set, how active it is, and how much space is being used on the blockstore.

To export the information, click Export as CSV.

Grooms Page¶

New in version 1.4.

The Backup tab’s Grooms page lists active and recent groom jobs.

Ops Manager performs periodic garbage collection on blockstores through groom jobs that remove unused blocks to reclaim space. Unused blocks are those that are no longer referenced by a live snapshot. A scheduling process determines when grooms are necessary.

A groom job forces the backup process to:

write all new data to a new location,
copy all existing, needed data from the old location to the new one,
update references, to maintain data relationships, and
drop the old database.

During groom operations, you may notice that blockstore file size will fluctuate, sometimes dramatically.

You can manually direct Ops Manager to move blocks between blockstores through the Groom Priority.

You can also Configure the Size of the Blocks in the Blockstore.

Groom Priority¶

New in version 1.6.

The Backup tab’s Groom Priority page allows you to manually schedule jobs to move a backup’s blocks to a different blockstore and to manually schedule grooms. The page lists each backup by its replica set and highlights a backup in blue if a groom is in progress.

To move a backup’s chunks to a different blockstore, select the destination blockstore in the backup’s Blockstore List column. You might want to do this, for example, if you add a new blockstore and would like to balance data.

Typically, you should not need to manually schedule groom jobs. Ops Manager runs the jobs automatically. If you do need to initiate a job, click the Schedule button for the backup’s replica set.

Daemons Page¶

The Backup tab’s Daemons page lists all active Backup Daemons and provides configuration options. Ops Manager automatically detects Backup Daemons and displays them here. You can reconfigure daemons from this page. Changes can take up to 5 minutes to take effect.

Use the Pre-Configure New Daemon button at the bottom of the page if you want to add a daemon but do not want it to take new jobs. Type the <machine>:<roothead path> in the text field above the Pre-Configure New Daemon button. Click the button to configure the new Backup Daemon.

For each daemon, the page lists the server name, configuration, head space used, head space free, the number of replica sets backed up, the percentage of time the Backup Daemon Service was busy, and job runtime counts by 1 minute, 10 minutes, 60 minutes, less than or equal to 180 minutes, and greater than 180 minutes.

The page includes the following fields and links to manage and configure daemons:

Field	Description
Show Detailed JSON	Displays the Backup Daemon JSON. When the JSON displays, the View raw runtime data link appears under the code, allowing you to view the raw data.
Move all heads	Moves all the Backup Daemon jobs that live on this daemon to a new daemon location. Click the link, then select the location, and then click the Move all heads button.
Delete Daemon	Deletes a Backup Daemon.
Assignment	Allows the daemon to take more jobs. If a disk fills on daemon server, you can deselect this so the server isn’t overloaded.
Backup Jobs	Allows the daemon to take more backup jobs. Deselect this, for example, when performing maintenance on a daemon’s server.
Restore Jobs	Allows the daemon to take more restore jobs.
Resource Usage	Collects information on blockstore use (i.e., on how many blocks are still referenced by snapshots). Ops Manager uses this information to generate the Resource Usage Page page and to prioritize garbage collection.
Garbage Collection	Enables garbage collection.
Head Disk Type	Indicates whether the disk type is SSD or HDD. If you change a daemon to SSD, then only jobs with an oplog greater than 1GB/hour will go to this daemon. Any jobs with an oplog less than 1GB/hour can only go to a daemon marked HDD.
Assignment Labels	Creates one or more labels that can be used to assign the daemon to a specific group.

Blockstores Page¶

The Backup tab’s Blockstores page lists all blockstores and provides the ability to add a new blockstore. You can use multiple blockstores if your existing blockstores have reached capacity, for data locality, or for regulatory reasons.

Edit an Existing Blockstore¶

Warning

After you save changes to the connection string, you must restart all the Ops Manager instances and Backup Daemons for the changes to take effect.

To edit the connection string for a Blockstore, edit the <hostname>:<port> field, MongoDD Auth Username field, and MongoDB Auth Password field. If the username and password had used the credentialstool for encryption, click the Encrypted Credentials checkbox. Once you save your changes, restart all the Ops Manager instances and Backup Daemons.

Add a Blockstore¶

To add a blockstore, first deploy the dedicated MongoDB instance(s) to host the blockstore.

Then, on the Blockstores page, enter the <id> and <hostname:port> in the text fields above the Add New Blockstore button. For replica sets, enter a comma-separated list for <hostname:port>. Finally, click the button to save and add the blockstore. A newly configured blockstore becomes active when you select the assignment checkbox.

Delete a Blockstore¶

To delete a blockstore, click the Delete blockstore link for the blockstore.

To assign labels to assign the blockstore to a specific group, enter the labels in Assignment Labels. Separate multiple labels with commas.

Additional Information¶

For additional information on managing blockstores, see:

Configure Multiple Blockstores in Multiple Data Centers
Configure the Size of the Blocks in the Blockstore
Groom Priority, to manually direct Ops Manager to move blocks between blockstores

Sync Stores Page¶

The Backup tab’s Sync Stores page configures the backing replica sets that store sync slices. Sync slices are temporary backups of your deployment batched into 10MB slices. The Backup Agent creates sync slices during an initial sync, and the Backup Daemon uses them to create the permanent backup. Ops Manager deletes sync slices once the initial sync completes.

Do not modify a sync store’s connection string to point to a different replica set. Doing so requires all Ops Manager components to be restarted. Existing data will not be copied automatically.

Warning

Any edits to the sync store’s connection string require you to restart all the Ops Manager instances and Backup Daemons. Making edits and clicking Save is not sufficient. You must restart the instances.

From this page you can:

Add a member to a replica set by adding the host to the replica set connection string in the <hostname>:<port> field. Do not modify the connection string to point to a different replica set.
Change the authentication credentials or connection options for a sync store by modifying the appropriate fields.
Add an additional sync store by clicking the Add New Sync Store button at the bottom of the page.
Enable and disable new assignments to sync stores using the checkboxes in the Assignment Enabled column.
Assign labels that can be used to assign the sync store to a specific group. Enter labels in Assignment Labels. Separate multiple labels with commas.

Oplog Stores Page¶

The Backup tab’s Oplog Stores page configures the backing replica sets that store oplog slices. Oplog slices are compressed batches of the entries in the tailed oplogs of your backed-up deployments.

Do not modify the oplog store’s connection string to point to a different replica set. Doing so requires all Ops Manager components to be restarted. Existing data will not be copied automatically.

Warning

Any edits to the oplog store’s connection string require you to restart all the Ops Manager instances and Backup Daemons. Making edits and clicking Save is not sufficient. You must restart the instances.

From this page you can:

Add a member to a replica set by adding the host to the replica set connection string in the <hostname>:<port> field. Do not modify the connection string to point to a different replica set.
Change the authentication credentials or connection options for a oplog store by modifying the appropriate fields.
Add an additional oplog store by clicking the Add New Oplog Store button at the bottom of the page.
Enable and disable new assignments to oplog stores using the checkboxes in the Assignment Enabled column.
Assign labels that can be used to assign the oplog store to a specific group. Enter labels in Assignment Labels. Separate multiple labels with commas.

Alerts Tab¶

The Admin interface’s Alerts tab sets and displays global and system alerts. Global alerts apply a group-level alert condition to multiple groups. System alerts monitor the health of Ops Manager.

Control Panel Tab¶

The Admin interface’s Control Panel tab provides access to Cron jobs and email history.

Email History Page¶

The Control Panel tab’s Email History page displays all alerts emails sent, the subject, and the recipient. To view an email, click the subject link. To filter the list, click Filter by Recipient.

Cron Jobs Page¶

The Control Panel tab’s Cron Jobs page displays all scheduled processes and their statuses. To disable a job, uncheck its box in the Enabled column. To run a job, click Run Now.

← Manage Your Account Manage Groups →