アラート構成ファイル

項目一覧

アラート構成設定

アラート構成ファイルの例
アラート構成コマンドの例

構成ファイルを使用して、Atlas CLI を通じてアラート構成を作成または更新するの設定を指定できます。 Atlas CLI は .json構成ファイルを受け入れます。

アラート構成設定

アラート構成のタイプに応じて、次の設定を指定して、構成ファイルでアラート構成を作成または更新できます。

フィールド	タイプ	説明
`enabled`	ブール値	指定されたプロジェクトに対して誰かがこのアラート構成を有効にしたかどうかを示すフラグ。
`eventTypeName`	string	必須。アラートをトリガーするイベントの種類。
`matchers`	オブジェクトの配列	このアラート構成に対してオブジェクトを照合するときに適用するルール。このフィールドは、 `eventTypeName`がホスト、レプリカセット、またはシャーディングされたクラスターのイベントを指定している場合にのみ使用できます。
`metricThreshold`	オブジェクト	超えた場合にアラートをトリガーするメトリクスのしきい値。このフィールドは、 `eventTypeName`が測定値またはメトリクスの変更を反映している場合にのみ使用できます。
`notifications`	オブジェクトの配列	Atlas が通知を送信するターゲットを含むリスト。
`threshold`	オブジェクト	超えたときにアラートをトリガーする制限。

詳細な説明と利用可能な設定の完全なリストについては、 API 仕様のリクエスト本文スキーマを参照してください。

アラート構成ファイルの例

アラート構成を作成または更新するには、構成ファイルに含めるフィールドを指定します。たとえば、次のサンプルファイルでは、 event-replica-setというレプリカセットがプライマリノードを失ったときに通知するアラート構成が有効になります。

{
  "enabled": true,
  "eventTypeName": "NO_PRIMARY",
  "matchers": [
    {
      "fieldName": "REPLICA_SET_NAME",
      "operator": "EQUALS",
      "value": "event-replica-set"
    }
  ],
  "notifications": [
    {
      "datadogApiKey": "****************************a23c",
      "datadogRegion": "US",
      "delayMin": 0,
      "intervalMin": 5,
      "notifierId": "6462742adc47d365036da07c",
      "typeName": "DATADOG"
    }
  ],
  "threshold": {
    "operator": "<",
    "threshold": 0,
    "units": "bits"
  }
}

アラート構成コマンドの例

ファイルを作成したら、Atlas CLI コマンドを実行してアラート構成を作成または更新します。

アラート構成の作成

アラート構成を作成するには、 --flagオプションとファイルへのパスを指定します。次の例では、 alert-config.jsonという名前の構成ファイルを使用してアラート構成を作成します。

atlas alerts settings create --file /alert-config.json

アラート構成の更新

アラート構成を更新するには、更新するアラート構成の ID、 --flagオプション、およびファイルへのパスを指定します。次の例では、 alert-config.jsonという名前の構成ファイルを使用して既存のアラート構成を更新します。

atlas alerts settings update <alertConfigId> --file /alert-config.json

戻る

Online Archive

トラブルシューティング