Navigation
This version of the documentation is archived and no longer supported. To learn how to upgrade your version of MongoDB Ops Manager, refer to the upgrade documentation.
You were redirected from a different version of the documentation. Click here to go back.

Third-Party Service Integrations

On this page

You can integrate Ops Manager with third-party monitoring services to view and analyze performance metrics that Ops Manager collects about your cluster.

Required Access

To view or modify third-party integration settings, you must have Project Monitoring Admin access to the project.

View / Modify Third-Party Settings

To modify third-party integration settings:

1

Navigate to the Integrations page for your project.

  1. If it is not already displayed, select the organization that contains your desired project from the office icon Organizations menu in the navigation bar.
  2. If it is not already displayed, select your desired project from the Projects menu in the navigation bar.
  3. Next to the Projects menu, expand the Options menu, then click Integrations.
2

Click Configure for the third-party service you want to modify.

You can set the following:

Setting Description
PagerDuty Integration Key

Default service key for alert notifications sent to a PagerDuty account. Ops Manager 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, Ops Manager 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 replica set has elected a new primary, cannot use PagerDuty notification.

Users can acknowledge PagerDuty alert notifications only from the PagerDuty dashboard.

Important

Changing the Integration Key doesn’t change any alerts that use this integration. Those alerts still use the previous Integration Key.

Remove and re-add each PagerDuty notification(s) to use the new key.

Note

PagerDuty decommissioned their REST API v1 key in October 2018. If you have a v1 key, you can continue to use that key with Ops Manager. All new PagerDuty keys use their REST API v2, but Ops Manager does not support their v2 keys. If you don’t have their REST API v1 key, use the PagerDuty Events API v1 instead.
Flowdock Settings

Default values for alert notifications sent to Flowdock. Ops Manager 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, Ops Manager 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 name 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 org name in the URL string: www.flowdock.com/app/<org-name>/<flow-name>.
  • API Token: Your Flowdock “personal API token” found on the Tokens page of your Flowdock account.
HipChat Settings Default room and API token for alert notifications sent to a HipChat account. Ops Manager 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, Ops Manager sends an email to the Project Owner and eventually removes the token.
Slack Settings

Team name, API token and a channel name for alert notifications sent to a Slack account. You can configure a Slack integration with OAuth2 by clicking Configure and then Sign in with Slack.

When you sign in, you are taken to a Slack landing page where you may select a workspace and configure permissions. After configuring Slack to connect to Ops Manager, your API token is automatically generated and maintained. You will be redirected back to the Integrations page.

After initially configuring Slack with Ops Manager, you can Edit or Remove the integration. Editing the integration will display your team name and API token, and allow you to change your channel name.

Legacy Token Deprecation

Legacy tokens are deprecated and will be removed in a future version of Ops Manager. You cannot edit a legacy token integration. Instead, you must reconfigure your Slack integration with OAuth2.
VictorOps Settings

API key and Routing key for alert notifications sent to a VictorOps account. Ops Manager uses these values as the default VictorOps settings when configuring alerts.

Enter the following information from your VictorOps account. If you do not have an existing VictorOps account, you can sign up.

  • VictorOps API Key
  • VictorOps Routing Key (optional)
Opsgenie API Key

API key for alert notifications sent to an Opsgenie account. Ops Manager uses this value as the default Opsgenie Alert API key when configuring alerts.

Enter the following information from your Opsgenie account. If you do not have an existing Opsgenie account, you can sign up:

  • Opsgenie API Key
  • API Region (United States only)
Datadog Settings

Configuration Ops Manager uses to send metric data about your deployment to Datadog. You can view these metrics in your Datadog dashboards.

Enter the following information from your Datadog account to have Datadog begin tracking your Ops Manager metric data. If you do not have an existing Datadog account, you can sign up at DataDog.

  • Datadog API Key
Webhook Settings

Webhook URL endpoint to which Ops Manager can send alerts for programmatic processing. Ops Manager sends an alert as an HTTP POST request in which the request body contains a JSON document that uses the same format as the Ops Manager API Alerts resource.

Ops Manager 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, MongoDB Ops Manager adds the X-MMS-Signature request header. This header contains the base64-encoded HMAC-SHA-1 signature of the request body. MongoDB Ops Manager creates the signature using the provided secret.

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

Build Monitoring Integrations

You can build a monitoring integration using the Ops Manager API monitoring and alerts endpoints.

© MongoDB, Inc 2008-present. MongoDB, Mongo, and the leaf logo are registered trademarks of MongoDB, Inc.