Navigation

View/Modify Project Settings

Required Access

To view project settings, the user must have Project Owner access for the project. To modify project settings, click Settings, then Project Settings.

View/Modify Project Settings

Project settings apply to all the users in the project [1]. The Project ID displayed at the top of the page is used by the Atlas API.

You can set the following:

Setting Description
Project

Sets your project’s name.

Note

Only a user with Owner role for the project or the Organization Owner role for the project’s organization can edit the project name.

Project Time Zone Sets your project’s time zone. This does not affect the timezones set for individual user accounts. [1]
Collect Database Specific Statistics Allows you to enable or disable the collection of database statistics in cluster metrics.
Set Preferred Cluster Maintenance Start Time

Set which hour of the day that Atlas should start weekly maintenance on your cluster.

If you toggle to On, click pencil icon to set the Maintenance Start Time. Atlas displays this time in the time zone you set in your Profile.

Maintenance Window Considerations

Urgent Maintenance Activities Cannot Wait

Urgent maintenance activities such as security patches cannot wait for your chosen window. Atlas will start those maintenance activities when needed.

Once maintenance is scheduled for your cluster, you cannot change your maintenance window until the current maintenance efforts have completed.

Maintenance Requires Replica Set Elections
Atlas performs maintenance the same way as the manual maintenance procedure. This requires at least one replica set election during the maintenance window per replica set.
Maintenance Starts As Close to the Hour As Possible
Maintenance always begins as close to the scheduled hour as possible, but in-progress cluster updates or expected system issues could delay the start time.

When maintenance is required, a banner appears in your cluster list showing the day and time when the maintenance is scheduled. With this information, you can choose one of three options:

  1. Do nothing. The maintenance occurs during your scheduled maintenance window.
  2. Begin Maintenance Now. The scheduled maintenance starts immediately. If you choose this option, you are asked to confirm it in a separate modal.
  3. Defer Maintenance for One Week. The scheduled maintenance starts during your preferred maintenance window one week after the given scheduled maintenance date and time. If you choose this option, you are asked to confirm it in a separate modal.
Enable Public API Allows you to access your project and its clusters through the Public API.
Public Key for SCP Restores If you use Atlas Backup, this setting allows you to generate a public key for SCP backup restoration. If you restore a snapshot through SCP, Atlas uses the key to transmit the snapshot.
PagerDuty Service Key

Sets a default service key for alert notifications sent to a PagerDuty account. Atlas enters the key by default when you add a PagerDuty notification to an alert configuration. If you add PagerDuty notifications and if the key used to send the notifications becomes invalid, Atlas sends an email to the project owner and eventually removes the key.

You can add PagerDuty notifications only for alerts that require user acknowledgement. Informational alerts, such as the alert that a user has joined a project, cannot use this notification method.

Users can acknowledge PagerDuty alerts only from the PagerDuty dashboard.

Flowdock Settings

Sets default values for alert notifications sent to Flowdock. Atlas enters the values by default when you add a Flowdock notification to an alert configuration. If you add Flowdock notifications, and if credentials to send notifications become invalid, Atlas sends an email to the project owner and eventually removes the credentials.

Set the following:

Org Name The Flowdock organization name in lower-case letters. This is the name that appears after www.flowdock.com/app/ in the URL string.
Flow Name

The flow name in lower-case letters. The flow name appears after the organization name in the URL string:

www.flowdock.com/app/<organization-name>/<flow-name>

API Token Your Flowdock “personal API token” found on the https://www.flowdock.com/account/tokens page of your Flowdock account.
HipChat Settings Sets a default room and API token for alert notifications sent to a HipChat account. Atlas enters the values by default when you add a HipChat notification to an alert configuration. If you add HipChat notifications and the token used to send notifications becomes invalid, Atlas sends an email to the project owner and eventually removes the token.
Slack Settings

Sets a default channel and token for alert notifications sent to a Slack account. You can use either an API token or a Bot token. To create an API token, see the https://api.slack.com/web page in your Slack account. For information on Bot users in Slack, see https://api.slack.com/bot-users.

Atlas enters these values by default when you add a Slack notification to an alert configuration. If add Slack notifications and the token used to send notifications becomes invalid, Atlas sends an email to the project owner and eventually removes the token.

Webhook Settings

Adds a Webhook URL endpoint to which Atlas can send alert notifications for programmatic processing. Atlas sends an alert notification as an HTTP POST request. The request body contains a JSON document that uses the same format as the Public API’s Alerts resource.

Atlas adds a request header called X-MMS-Event to distinguish between various alert states. The possible values for this header are:

alert.open The alert was just opened.
alert.close The alert was resolved.
alert.update A previously opened alert is still open.
alert.acknowledge The alert was acknowledged.
alert.cancel The alert became invalid and was canceled.
alert.inform Represents an informational alert, which is a point-in-time event, such as “Primary Elected.”

If you specify a key in the Webhook Secret field, Atlas adds the X-MMS-Signature request header, which contains the hex-encoded HMAC signature of the request body. The signature is created using the provided secret.

To send alert notifications to a Webhook, select the Webhook notification option when creating or editing an alert. If you add a Webhook notification and the URL or optional key becomes invalid, Atlas sends an email to the project owner and eventually removes the Webhook settings.

Datadog Settings

Configures Atlas to send metric data about your deployment to Datadog. You can view these metrics in your Datadog dashboards. For a detailed list of all Atlas metrics that Datadog tracks, refer to the Datadog Integration page.

Enter your Datadog API Key to have Datadog begin tracking your Atlas metric data. If you do not have an existing Datadog account, you can sign up at https://app.datadoghq.com/signup.

New Relic Settings

Configures Atlas to send metric data about your deployment to New Relic for viewing through the New Relic MongoDB plugin. You can also use Insights for New Relic to run analytics on the collected data. Atlas sends New Relic the same metric data as displayed in Atlas cluster metrics.

Enter the following information from your New Relic account. If you do not have an existing New Relic account, you can sign up using http://newrelic.com/mongodb.

  • Account ID
  • License Key
  • Insights API Insert Key
  • Insights API Query Key

If any of the keys later become invalid, Atlas sends an email to the project owner and eventually removes the invalid credentials.

[1](1, 2) To modify your user settings, click on your user name in the upper-right hand corner and select Account.