Atlas アラート設定の作成

項目一覧

構文

オプション
継承されたオプション
出力
例

プロジェクトのアラート構成を作成します。

このコマンドを使用するには、プロジェクトオーナーのユーザーアカウントまたは API キーで認証する必要があります。

構文

コマンド構文

atlas alerts settings create [options]

オプション

名前	タイプ	必須	説明
--apiKey	string	false	Datadog API キー、Opsgenie API キー、または VictorOps API キーのいずれか。 notificationType がそれぞれ DATADOG、OPS_GENIE、または VICTOR_OPS の場合に必要です。
--enabled		false	アラート構成を有効にするかどうかを示すフラグ。
--event	string	false	アラートをトリガーしたイベントのタイプ。 CLI が受け入れる値については、Atlas Admin API 仕様の eventTypeName の列挙型 https://docub.mongodb.org/core/atlas-event-names）を参照してください。
-f, --file	string	false	アラート構成設定を定義する JSON 構成ファイルへのパス。 Atlas CLI のアラート構成ファイルの詳細については、 https://docub.mongodb.org/core/alert-config-atlas-cli を参照してください。
-h, --help		false	作成用ヘルプ
--matcherFieldName	string	false	一致するターゲットオブジェクト内のフィールドの名前。有効な値を確認するには、「 Atlas alerts settings fields type 」を実行します。
--matcherOperator	string	false	現在のメトリクスをmatcherValueと照合するときに適用する比較演算子。有効な値は、CONTAINS、ENDS_With、Equals、NOT_CONTAINS、NOT_Equals、REGEX、STARTS_With」です。
--matcherValue	string	false	指定された演算子でテストする値。 matcherFieldName が Type_NAME に設定されている場合は、次の値を照合できます: CONドライバー、MONGOS、プライマリ、セカンダリ、スタンドアロン。
--metricMode	string	false	Atlas が現在のメトリクス値を平均として計算するかどうかを示すオプション。有効な値は AVERAGE です。
--metricName	string	false	このコマンドが構成されたアラートをチェックするメトリクスの名前。有効な値については、 https://docub.mongodb.org/core/alert-host-metrics-atlas を参照してください。。このオプションが適用されるのは、イベントが OUTSIDE_METRICS_threshold に設定されている場合のみです。
--metricOperator	string	false	現在のメトリクス値をチェックするときに適用する比較演算子。有効な値は LESS_THAN と greater_Than です。
--metricThreshold	float	false	アラートがトリガーされるしきい値。
--metricUnits	string	false	しきい値の単位。有効な値は、BITS、BYTES、DAYS、GeoBITS、GBITES、時間、キロビット、キロバイト、メガバイト、メガバイト、ミリ秒、分、ペタバイト、未加工、秒、テラバイトです。
--notificationChannelName	string	false	Slack チャンネル名。 Slack通知の種類に必須です。
--notificationDelayMin	整数	false	アラート条件が検出された後最初の通知を送信するまでに待機する時間（分）。
--notificationEmailAddress	string	false	アラート通知が送信されるメールアドレス。
--notificationEmailEnabled		false	メール通知を有効にするフラグ。 GROUP および USER の通知タイプを構成可能です。
--notificationIntervalMin	整数	false	解決されていない未確認アラートの連続した通知間で待機する時間（分）。
--notificationMobileNumber	string	false	アラート通知が送信されるモバイル番号。
--notificationRegion	string	false	使用する API URL を示すリージョン。
--notificationRole	string	false	構成されたアラートを受信する 1 件以上の組織またはプロジェクトロールを含むリスト。
--notificationServiceKey	string	false	PagerDuty サービスキー。
--notificationSmsEnabled		false	テキストメッセージ通知を有効にするフラグ。
--notificationTeamId	string	false	チームの一意の識別子。
--notificationToken	string	false	Slack API token, or Bot token.
--notificationType	string	false	アラート通知のタイプ。有効な値は、DATADOG、EMAIL、GROUP（プロジェクト）、MICROSOFT_TEAMS、ORG、OPS_GENIE、PAGER_DUTY、 Slack 、SMS、TEAM、USER、VICTOR_OPS、または WEBHOOK です。
--notificationUsername	string	false	通知の送信先となるAtlas userの名前。
--notificationVictorOpsRoutingKey	string	false	Splunk On-Call アカウントに関連付けられたルーティングキー。
--notificationWebhookSecret	string	false	Webhook ベースのアラートの認証シークレット。
--notificationWebhookUrl	string	false	Webhook ベースのアラートまたは Microsoft Teams アラートのターゲット URL。
-o, --output	string	false	出力形式。有効な値は、 JSON 、 JSON -path、go-template、または go-template-file です。完全な出力を表示するには、 -o JSONオプションを使用します。
--projectId	string	false	使用するプロジェクトを識別する 16 進数の string。このオプションは、構成ファイルまたは環境変数の設定を上書きします。

継承されたオプション

名前	タイプ	必須	説明
-P, --profile	string	false	構成ファイルから使用するプロファイルの名前。 Atlas CLI のプロファイルの詳細については、 https://docub.mongodb.org/core/atlas-cli-save- connection-settings を参照してください。

出力

コマンドが成功すると、CLI は次のサンプルのような出力を返します。括弧内の値は値を表します。

Alert configuration <Id> created.

例

# Create an alert configuration that notifies a user when they join a group for the project with the ID 5df90590f10fab5e33de2305:
atlas alerts settings create --event JOINED_GROUP --enabled \
--notificationType USER --notificationEmailEnabled \
--notificationIntervalMin 60 --notificationUsername john@example.com \
--output json --projectId 5df90590f10fab5e33de2305

# Create alert using json file containing alert configuration
atlas alerts settings create 5d1113b25a115342acc2d1aa --file alerts.json

# Create an alert that shows possible connection storms based on the number of connections
atlas alerts settings create --event OUTSIDE_METRIC_THRESHOLD --metricName CONNECTIONS --metricOperator LESS_THAN --metricThreshold 1 --metricUnits RAW --projectId 5df90590f10fab5e33de2305 --notificationType GROUP --notificationEmailEnabled --notificationIntervalMin 5 --enabled

戻る

設定

削除