アラート構成の更新

ブール値

省略した場合、構成は無効になります。

string

アラートをトリガーするイベントの種類。

値には、次のものが含まれます。

エージェント

• AUTOMATION_AGENT_DOWN

• AUTOMATION_AGENT_UP

• BACKUP_AGENT_CONF_CALL_FAILURE

• BACKUP_AGENT_DOWN

• BACKUP_AGENT_UP

• BACKUP_AGENT_VERSION_BEHIND

• BACKUP_AGENT_VERSION_CURRENT

• MONITORING_AGENT_DOWN

• MONITORING_AGENT_UP

• MONITORING_AGENT_VERSION_BEHIND

• MONITORING_AGENT_VERSION_CURRENT

• NEW_AGENT

アラート

• WEBHOOK_TEMPLATE_RENDER_FAILED

オートメーション構成

• AUTOMATION_CONFIG_PUBLISHED_AUDIT

バックアップ

• BAD_CLUSTERSHOTS

• CLUSTER_DENYLIST_UPDATED_AUDIT

• CLUSTER_CHECKKPOINT_UPDATED_AUDIT

• CLUSTER_CREDENTIAL_UPDATED_AUDIT

• CLUSTER_SNAPSHOT_SCHEDULE_UPDATED_AUDIT

• CLUSTER_STATE_CHANGED_AUDIT

• CLUSTER_STORAGE_ENGINE_UPDATED_AUDIT

• CLUSTERSHOT_DELETED_AUDIT

• CLUSTERSHOT_EXPIRY_UPDATED_AUDIT

• CONSISTENT_BACKUP_CONFIGURATION

• GOOD_CLUSTERSHOT

• INCONSISTENT_BACKUP_CONFIGURATION

• INITIAL_SYNC_FINISHED_AUDIT

• INITIAL_SYNC_STARTED_AUDIT

• OPLOG_BEHIND

• OPLOG_CURRENT

• RESTORE_REQUESTED_AUDIT

• RESYNC_PERFORMED

• RESYNC_REQUIRED

• RS_DENYLIST_UPDATED_AUDIT

• RS_CREDENTIAL_UPDATED_AUDIT

• RS_ROTATE_MASTER_KEY_AUDIT

• RS_SNAPSHOT_SCHEDULE_UPDATED_AUDIT

• RS_STATE_CHANGED_AUDIT

• RS_STORAGE_ENGINE_UPDATED_AUDIT

• SNAPSHOT_DELETED_AUDIT

• SNAPSHOT_EXPIRY_UPDATED_AUDIT

• SYNC_PENDING_AUDIT

• SYNC_REQUIRED_AUDIT

BI Connector

• BI_CONNECTOR_DOWN

• BI_CONNECTOR_UP

請求

• ACCOUNT_DOWNGRADED

• ACCOUNT_UPGRADED

• CHARGE_FAILED

• CHARGE_SUCCEEDED

• CHECK_PAYMENT_RECEIVED

• CREDIT_CARD_ABOUT_TO_EXPIRE

• CREDIT_CARD_CURRENT

• CREDIT_ISSUED

• DAILY_BILL_OVER_THRESHOLD

• DAILY_BILL_UNDER_THRESHOLD

• DISCOUNT_APPLIED

• INVOICE_ADDRESS_ADDED

• INVOICE_ADDRESS_CHANGED

• INVOICE_CLOSED

• PAYMENT_FORGIVEN

• PENDING_INVOICE_OVER_THRESHOLD

• PENDING_INVOICE_UNDER_THRESHOLD

• PREPAID_PLAN_ACTIVATED

• PROMO_CODE_APPLIED

• REFUND_ISSUED

• STALE_PENDING_INVOICES

• WIRE_TRANSFER_PAYMENT_RECEIVED

クラスター

• CLUSTER_MONGOS_IS_MISSING

• CLUSTER_MONGOS_IS_PRESENT

• SHARD_ADDED

• SHARD_REMOVED

Data Explorer のアクセス

• DATA_EXPLORER

• DATA_EXPLORER_CRUD

ディスクバックアップ

• CPS_RESTORE_REQUESTED_AUDIT

Host

• ADD_HOST_AUDIT

• ADD_HOST_TO_REPLICA_SET_AUDIT

• ATTEMPT_KILLOP_AUDIT

• ATTEMPT_KILLSESSION_AUDIT

• DB_PROFILER_DISABLE_AUDIT

• DB_PROFILER_ENABLE_AUDIT

• DELETE_HOST_AUDIT

• DISABLE_HOST_AUDIT

• HIDE_AND_DISABLE_HOST_AUDIT

• HIDE_HOST_AUDIT

• HOST_DOWN

• HOST_EXPOSED

• HOST_IP_CHANGED_AUDIT

• HOST_LOCKED_DOWN

• HOST_RECOVERING

• HOST_RESTARTED

• HOST_ROLLBACK

• HOST_SECURITY_CHECKUP_NOT_MET

• HOST_SSL_CERTIFICATE_CURRENT

• HOST_SSL_CERTIFICATE_STALE

• OUTSIDE_METRIC_THRESHOLD

• PAUSE_HOST_AUDIT

• REMOVE_HOST_FROM_REPLICA_SET_AUDIT

• RESUME_HOST_AUDIT

• UNDELETE_HOST_AUDIT

• VERSION_BEHIND

組織

• ALL_ORG_USERS_HAVE_MFA

• ORG_ACTIVATED

• ORG_ADMIN_SUSPENDED

• ORG_API_KEY_ADDED

• ORG_API_KEY_DELETED

• ORG_CREDIT_CARD_ABOUT_TO_EXPIRE

• ORG_CREDIT_CARD_ADDED

• ORG_CREDIT_CARD_CURRENT

• ORG_CREDIT_CARD_UPDATED

• ORG_DAILY_BILL_OVER_THRESHOLD

• ORG_DAILY_BILL_UNDER_THRESHOLD

• ORG_EMPLOYEE_ACCESS_RESTRICTED

• ORG_EMPLOYEE_ACCESS_UNRESTRICTED

• ORG_GROUP_CHARGES_OVER_THRESHOLD

• ORG_GROUP_CHARGES_UNDER_THRESHOLD

• ORG_INVOICE_OVER_THRESHOLD

• ORG_INVOICE_UNDER_THRESHOLD

• ORG_LOCKED

• ORG_PUBLIC_API_ACCESS_LIST_NOT_REQUIRED

• ORG_PUBLIC_API_ACCESS_LIST_REQUIRED

• ORG_RENAMED

• ORG_SUSPENDED

• ORG_TEMPORARILY_ACTIVATED

• ORG_TWO_FACTOR_AUTH_OPTIONAL

• ORG_TWO_FACTOR_AUTH_REQUIRED

• ORG_USERS_WITHOUT_MFA

プロジェクト

• ALL_USERS_HAVE_MULTI_FACTOR_AUTH

• DELINQUENT

• PAID_IN_FULL

• USERS_WITHOUT_MULTI_FACTOR_AUTH

レプリカセット

• CONFIGURATION_CHANGED

• ENOUGH_HEALTHY_MEMBERS

• MEMBER_ADDED

• MEMBER_REMOVED

• MULTIPLE_PRIMARIES

• NO_PRIMARY

• ONE_PRIMARY

• PRIMARY_ELECTED

• TOO_FEW_HEALTHY_MEMBERS

• TOO_MANY_ELECTIONS

• TOO_MANY_UNHEALTHY_MEMBERS

サポートケース

• CASE_CREATED

チーム

• TEAM_ADDED_TO_GROUP

• TEAM_CREATED

• TEAM_DELETED

• TEAM_NAME_CHANGED

• TEAM_REMOVED_FROM_GROUP

• TEAM_ROLES_MODIFIED

• TEAM_UPDATED

• USER_ADDED_TO_TEAM

user

• INVITED_TO_GROUP

• INVITED_TO_ORG

• JOIN_GROUP_REQUEST_APPROVED_AUDIT

• JOIN_GROUP_REQUEST_DENIED_AUDIT

• JOINED_GROUP

• JOINED_ORG

• JOINED_TEAM

• REMOVED_FROM_GROUP

• REMOVED_FROM_ORG

• REMOVED_FROM_TEAM

• REQUESTED_TO_JOIN_GROUP

• USER_ROLES_CHANGED_AUDIT

アラートとその説明を生成するイベントの完全なリストを確認するには、「アラート タイプ 」を参照してください。

string

一致するターゲット オブジェクト内のフィールドの名前。

• ホスト アラートは、次のフィールドをサポートします。

  • HOSTNAME

  • PORT

  • HOSTNAME_AND_PORT

  • REPLICA_SET_NAME

  • TYPE_NAME

• レプリカセット アラートは次のフィールドをサポートします。

  • REPLICA_SET_NAME

  • SHARD_NAME

  • CLUSTER_NAME

• シャーディングされたクラスター アラートは、次のフィールドをサポートします。

  • CLUSTER_NAME

  • SHARD_NAME

他のタイプのアラートはすべてマッチャーをサポートしていません。

string

フィールドの値をテストする演算子。 指定できる値は以下のとおりです。

• EQUALS

• NOT_EQUALS

• CONTAINS

• NOT_CONTAINS

• STARTS_WITH

• ENDS_WITH

• REGEX

string

指定された演算子でテストする値。

matchers.fieldNameがTYPE_NAMEに設定されている場合は、次の値を照合できます。

• PRIMARY

• SECONDARY

• STANDALONE

• CONFIG

• MONGOS

オブジェクト配列

このアラート構成に対してオブジェクトを照合するときに適用するルール。 これらのすべてのルールに一致するエンティティのみがアラート条件についてチェックされます。

eventTypeNameがホスト、レプリカセット、またはシャーディングされたクラスターのイベントを指定している場合にのみ、 matchers配列を使用してフィルタリングできます。

string

確認するメトリクスの名前。 alertsリソースのmetricNameフィールドと同じ値をサポートします。

string

このメトリクスの平均を計算するには、 AVERAGEに設定します。

string

現在のメトリクス値をしきい値と照合するときに適用する演算子。 指定できる値は以下のとおりです。

• GREATER_THAN

• LESS_THAN

数値

アラートがトリガーされる範囲外のしきい値。

string

しきい値の単位。 メトリクスの型によって異なります。

たとえば、メモリ消費を測定するメトリクスにはバイト単位が含まれ、時間を測定するメトリクスには時間単位が含まれます。

指定できる値は次のとおりです。

• RAW

• BITS

• BYTES

• KILOBITS

• KILOBYTES

• MEGABITS

• MEGABYTES

• GIGABITS

• GIGABYTES

• TERABYTES

• PETABYTES

• MILLISECONDS

• SECONDS

• MINUTES

• HOURS

• DAYS

オブジェクト

アラートがトリガーされるしきい値。 "eventTypeName" : "OUTSIDE_METRIC_THRESHOLD"の場合は必須です。

string

Slack API トークンまたは Bot トークン。 "notifications.typeName" : "SLACK"の場合は必須です。 後でトークンが無効になった場合、Cloud Manager は プロジェクト所有者 にメールを送信し、最終的にトークンを削除します。

API または統合キーが必要なサードパーティ統合を作成してから次の操作を行うと、キーは部分的に伏字で表示されます。

• UI を通じてアラートを表示または編集します。

• APIを介してサードパーティ統合設定をクエリします。

string

Slack チャンネル名。 "notifications.typeName" : "SLACK"の場合は必須です。

string

DataDog API キー。 DataDog ダッシュボードで確認できます。 "notifications.typeName" : "DATADOG"の場合は必須です。

API または統合キーが必要なサードパーティ統合を作成してから次の操作を行うと、キーは部分的に伏字で表示されます。

• UI を通じてアラートを表示または編集します。

• APIを介してサードパーティ統合設定をクエリします。

数値

アラート条件が検出された後最初の通知を送信するまでに待機する時間（分）。

string

通知を送信するメールアドレス。 "notifications.typeName" : "EMAIL"の場合は必須です。

ブール値

メール通知を送信するかどうかを決定します。 次の場合は必須です。

• "notifications.typeName" : "GROUP"

• "notifications.typeName" : "USER"

数値

解決されていない未確認アラートの連続した通知間で待機する時間（分）。

string

通知を受け入れ、転送する Webhook で認証するために使用される値。 シークレットを明示的に宣言できるのは、次の両方を持つリクエストでのみです。

• A notifications.typeName WEBHOOK

• 明示的に宣言された notifications.webhookURL

統合ページまたは統合 APIを使用してのみ、デフォルトのwebhookURLにwebhookSecretを構成できます。

webhookSecret webhookURLを明示的に宣言するには、このフィールドを省略します。

Webhook 通知の作成後、アラートを表示または編集すると、URL が部分的に編集され、シークレットは完全に伏字化されます。

string

この通知をトリガーする Webhook のURL 。webhookUrl を明示的に宣言しない場合、リクエストはデフォルトの webhookUrl を使用します。これは、Integrations ページか、Integrations API のいずれかで設定されます。

Webhook 通知の作成後、アラートを表示または編集すると、URL が部分的に編集され、シークレットは完全に伏字化されます。

string

Webhook 通知のボディコンテンツをレンダーする、"${field}" 補間を使用したテンプレート。Cloud Manager は、通知を送信するときに、${eventType} などの各 ${field} プレースホルダーを一致するアラート値に置き換えます。レンダリングされたボディは有効な JSON でなければなりません。また、Content-Type: application/json ヘッダーとともに送信されます。

テンプレートのレンダーに失敗したり、サイズ制限を超えたり、無効な出力が生成された場合、 Cloud Manager は代わりにデフォルトのペイロードを送信します。

string

Webhook 通知に含めるカスタムヘッダーを、${field} の差し込みを使用してレンダーするテンプレート。Cloud Manager は、通知を送信するときに、各 ${field} プレースホルダを対応するアラート値に置き換えます。レンダリングされたヘッダーは、各ヘッダー名をその値にマップする JSON オブジェクトである必要があります。Cloud Manager は、テンプレートにウェブフックシークレットまたは署名ヘッダーを公開しません。

テンプレートのレンダーが失敗した場合、サイズ制限を超えた場合、または無効な出力を生成した場合、Cloud Manager はデフォルトヘッダーを送信します。

string

Microsoft Teams チャネルの受信 Webhook URL 。 "notifications.typeName" : "MICROSOFT_TEAMS"の場合は必須です。

Webhook 通知のアラートを表示または編集すると、URL が部分的に編集され、シークレットは完全に伏字化された状態で表示されます。

string

SMS メッセージの送信先の携帯電話番号。 "notifications.typeName" : "SMS"の場合は必須です。

string

HipChat API トークン。 "notifications.typeName" : "HIP_CHAT"の場合は必須です。 後でトークンが無効になった場合、Cloud Manager は プロジェクト所有者 にメールを送信し、最終的にトークンを削除します。

API または統合キーが必要なサードパーティ統合を作成してから次の操作を行うと、キーは部分的に伏字で表示されます。

• UI を通じてアラートを表示または編集します。

• APIを介してサードパーティ統合設定をクエリします。

string

構成されたアラートを受信する 1 つ以上のプロジェクト ロール。 受け入れ可能な値は以下の通りです。

• GROUP_AUTOMATION_ADMIN: Project Automation Admin

• GROUP_BACKUP_ADMIN: Project Backup Admin

• GROUP_DATA_ACCESS_ADMIN: Project Data Access Admin

• GROUP_DATA_ACCESS_READ_ONLY: Project Data Access Read Only

• GROUP_DATA_ACCESS_READ_WRITE: Project Data Access Read/Write

• GROUP_MONITORING_ADMIN: Project Monitoring Admin

• GROUP_OWNER: Project Owner

• GROUP_READ_ONLY: Project Read Only

• GROUP_USER_ADMIN: Project User Admin

このフィールドを含めると、Cloud Manager は、配列で指定されたロールを割り当てられたユーザーにのみアラートを送信します。 このフィールドを省略すると、Cloud Manager はロールを割り当てられたユーザーにアラートを送信します。

GROUPの通知タイプで構成可能です。

string

HipChat ルーム名。 "notifications.typeName" : "HIP_CHAT"の場合は必須です。

string

PagerDuty 統合キー。 "notifications.typeName" : "PAGER_DUTY"の場合は必須です。

ブール値

SMS 通知を送信する必要があることを示すフラグ。 次の場合は必須です。

• "notifications.typeName" : "GROUP"

• "notifications.typeName" : "USER"

string

チームの一意の識別子。

string

アラート通知のタイプ。 指定できる値は以下のとおりです。

• EMAIL

• GROUP （プロジェクト）

• HIPCHAT

• ORG

• PAGER_DUTY

• SLACK

• SMS

• TEAM

• USER

• WEBHOOK

• MICROSOFT_TEAMS

string

通知を送信する Cloud Manager ユーザーの名前。 アラート構成を所有するプロジェクト内のユーザーを指定します。 "notifications.typeName" : "USER"の場合は必須です。

オブジェクト配列

アラート条件が検出されたときに送信する通知。

string

現在のメトリクス値をしきい値と照合するときに適用する演算子。

• GREATER_THAN

• LESS_THAN

数値

アラートがトリガーされる範囲外のしきい値。

オブジェクト

アラートがトリガーされるしきい値。 次の場合は必須です。

• "eventTypeName" : "TOO_FEW_HEALTHY_MEMBERS"

• "eventTypeName" : TOO_MANY_UNHEALTHY_MEMBERS