作成¶
POST /api/v1/checker/add
概要¶
モニターを作成します
Body リクエストパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| queryType | string | extend.querylist が未指定の場合に使用・検証される DQL フロントエンド表示モード。simple は Studio が解析してシンプルモードのフィールドを注入することを意味し、dql は DQL テキストモードを意味します。デフォルトは dql です。extend.querylist が明示的に指定された場合はそのまま優先され、queryType の注入セマンティクスは無視されます。simple への変換に失敗した場合は自動的に dql にフォールバックしますが、jsonScript.targets で実際に実行される DQL は変更されません。空の値を許可: False 例: simple |
|
| type | string | モニタータイプ、デフォルトは trigger。trigger:通常モニター、smartMonitor:インテリジェントモニタリング空の値を許可: False 例: smartMonitor |
|
| status | integer | モニターのステータスフィールド。0:有効、2:無効、デフォルトは有効(2025-02-19 のイテレーションで追加) 空の値を許可: False 選択可能な値: [0, 2] |
|
| extend | json | 追加情報(インシデント関連フィールドおよびフロントエンド表示用フィールド) 空の値を許可: True |
|
| alertPolicyUUIDs | array | アラートポリシー UUID 空の値を許可: False |
|
| dashboardUUID | string | 関連付けるダッシュボード ID 空の値を許可: False |
|
| tags | array | フィルタリングに使用するタグ名 空の値を許可: False 例: ['xx', 'yy'] |
|
| secret | string | Webhook アドレスの中間部分の一意識別子 secret(通常はランダムな UUID で、ワークスペース内で一意であることを確認) 空の値を許可: False 例: secret_xxxxx |
|
| jsonScript | json | ルール設定 空の値を許可: False |
|
| jsonScript.targetWorkspaceUUID | string | ターゲットワークスペース。クロススペースクエリ。しきい値検出タイプのみサポート(2025-08-13 のイテレーションで追加) 空の値を許可: False 空文字列を許可: False |
|
| jsonScript.type | string | Y | チェックメソッドタイプ 例: simpleCheck 空の値を許可: False |
| jsonScript.windowDql | string | window DQL 空の値を許可: False |
|
| jsonScript.title | string | Y | イベントのタイトルを生成 例: モニター: {{monitor_name}} チェッカー:{{monitor_checker_name}} トリガー値:{{M1}} 空の値を許可: False 空文字列を許可: True 最大長: 256 |
| jsonScript.message | string | イベントの内容 例: status: {{status}}, title: {{title}} 空の値を許可: False 空文字列を許可: True |
|
| jsonScript.recoverTitle | string | 復旧イベントのタイトルテンプレートを出力 例: モニター: {{monitor_name}} チェッカー:{{monitor_checker_name}} トリガー値:{{M1}} 空の値を許可: False 空文字列を許可: True |
|
| jsonScript.recoverMessage | string | 復旧イベントの情報テンプレートを出力 例: status: {{status}}, title: {{title}} 空の値を許可: False 空文字列を許可: True |
|
| jsonScript.noDataTitle | string | データ欠落イベントのタイトルテンプレートを出力 例: モニター: {{monitor_name}} チェッカー:{{monitor_checker_name}} トリガー値:{{M1}} 空の値を許可: False 空文字列を許可: True |
|
| jsonScript.noDataMessage | string | データ欠落イベントの情報テンプレートを出力 例: status: {{status}}, title: {{title}} 空の値を許可: False 空文字列を許可: True |
|
| jsonScript.openNotificationMessage | boolean | イベントの通知内容を有効にするかどうか。デフォルトは無効(イベント内容を通知内容として使用) 例: False 空の値を許可: False |
|
| jsonScript.notificationMessage | string | イベントの通知内容 例: モニター: {{monitor_name}} チェッカー:{{monitor_checker_name}} トリガー値:{{M1}} 空の値を許可: False 空文字列を許可: True |
|
| jsonScript.openNoDataNotificationMessage | boolean | データ欠落イベントの通知内容を有効にするかどうか。デフォルトは無効(データ欠落イベント内容を通知内容として使用) 例: False 空の値を許可: False |
|
| jsonScript.noDataNotificationMessage | string | データ欠落イベントの通知内容 例: status: {{status}}, title: {{title}} 空の値を許可: False 空文字列を許可: True |
|
| jsonScript.noDataRecoverTitle | string | データ欠落復旧アップロードイベントのタイトルテンプレートを出力 例: モニター: {{monitor_name}} チェッカー:{{monitor_checker_name}} トリガー値:{{M1}} 空の値を許可: False 空文字列を許可: True |
|
| jsonScript.noDataRecoverMessage | string | データ欠落復旧アップロードイベントの情報テンプレートを出力 例: status: {{status}}, title: {{title}} 空の値を許可: False 空文字列を許可: True |
|
| jsonScript.every | string | チェック頻度 例: 1m 空の値を許可: False |
|
| jsonScript.customCrontab | string | カスタムチェック頻度 例: 0 */12 * * * 空の値を許可: False |
|
| jsonScript.delaySeconds | integer | 通常モニターのデータ待機ウィンドウ(秒単位)。0 は待機なしを意味します。インテリジェントモニタリングはこの設定をサポートしません。 例: 60 空の値を許可: False 選択可能な値: [0, 60, 120, 180, 300, 600, 900, 1800] |
|
| jsonScript.interval | integer | クエリ間隔。1 回のクエリの時間範囲の時差 例: 60 空の値を許可: False |
|
| jsonScript.range | integer | アドバンスト検出、変化点検出の range パラメータ。単位は秒。 例: 3600 空の値を許可: False |
|
| jsonScript.range_2 | integer | アドバンスト検出、変化点検出の range_2 パラメータ。単位は秒。特殊な説明:(-1 は前周期比、0 は periodBefore フィールドを使用することを意味します) 例: 600 空の値を許可: False |
|
| jsonScript.periodBefore | integer | アドバンスト検出、変化点検出の(前日/1時間前)パラメータ。単位は秒。 例: 600 空の値を許可: False |
|
| jsonScript.recoverNeedPeriodCount | integer | 異常が発生してから復旧イベントを生成するまでのチェック周期数。チェック頻度がカスタム crontab の場合、このフィールドは時間の長さ(秒)を表し、それ以外の場合はチェック頻度の回数を表します。 例: 60 空の値を許可: False |
|
| jsonScript.noDataInterval | integer | この時間内にデータがない場合、データ欠落イベントを生成する 例: 60 空の値を許可: False |
|
| jsonScript.noDataAction | string | データ欠落時の処理操作 空の値を許可: False 選択可能な値: ['none', 'checkAs0', 'noDataEvent', 'fatalEvent', 'criticalEvent', 'errorEvent', 'warningEvent', 'okEvent', 'noData', 'recover'] |
|
| jsonScript.checkFuncs | array | チェック関数情報リスト 例: [{'funcId': 'xxx', 'kwargs': {}}] 空の値を許可: False |
|
| jsonScript.groupBy | array | トリガー次元 例: ['性別'] 空の値を許可: False |
|
| jsonScript.targets | array | チェックターゲット 例: [{'dql': 'M:: 兵士情報:(AVG(潜在能力値)) [::auto] by 性別', 'alias': 'M1'}] 空の値を許可: False |
|
| jsonScript.checkerOpt | json | チェック条件設定 空の値を許可: False |
|
| jsonScript.checkerOpt.disableLargeScaleEventProtect | boolean | 大規模イベント保護を無効にするかどうか。デフォルトは false。 例: True |
|
| jsonScript.checkerOpt.script | string | プログラマブルモニターのスクリプト内容 空の値を許可: False 空文字列を許可: True |
|
| jsonScript.checkerOpt.rules | array | トリガー条件リスト 例: [{'status': 'warning', 'conditions': [{'operands': [60], 'operator': '>', 'alias': 'M1'}], 'conditionLogic': 'and', 'matchTimes': 10}] 空の値を許可: False |
|
| jsonScript.checkerOpt.openOkConditions | boolean | 段階的復旧を有効にする。デフォルトは無効 false。 例: True |
|
| jsonScript.checkerOpt.openMatchTimes | boolean | 連続トリガー判定を有効にする。デフォルトは無効 false。 例: True |
|
| jsonScript.checkerOpt.infoEvent | boolean | 正常状態が継続している場合に info イベントを生成するかどうか。デフォルトは false。 例: True |
|
| jsonScript.checkerOpt.infoEventCondition | json | 情報イベント生成条件。しきい値モニターのみサポート。空オブジェクトは無条件生成を意味します。 例: {'alias': 'M1', 'operator': '>=', 'operands': [60]} 空の値を許可: False |
|
| jsonScript.checkerOpt.infoEventCondition.alias | string | 判定対象のエイリアス | |
| jsonScript.checkerOpt.infoEventCondition.operator | string | 判定演算子 | |
| jsonScript.checkerOpt.infoEventCondition.operands | array | 判定オペランドリスト | |
| jsonScript.checkerOpt.diffMode | string | アドバンスト検出の変化点検出における差分モード。列挙値:value、percent 例: value 選択可能な値: ['value', 'percent'] |
|
| jsonScript.checkerOpt.direction | string | アドバンスト検出の変化点検出、区間検出におけるトリガー条件の方向 例: up 選択可能な値: ['up', 'down', 'both'] |
|
| jsonScript.checkerOpt.eps | float | 距離パラメータ。範囲:0~3.0 例: 0.5 |
|
| jsonScript.checkerOpt.threshold | json | 変化点検出のトリガー前提条件設定 空の値を許可: False |
|
| jsonScript.checkerOpt.threshold.status | boolean | Y | 変化点検出のトリガー前提条件を有効にするかどうか。 例: True |
| jsonScript.checkerOpt.threshold.operator | string | Y | 変化点検出のトリガー前提条件の演算子 例: |
| jsonScript.checkerOpt.threshold.value | float | Y | 変化点検出のトリガー前提条件の検出値 例: 90 空の値を許可: True |
| jsonScript.checkerOpt.combineExpr | string | 複合モニターの組み合わせ方法 例: A && B 空文字列を許可: False |
|
| jsonScript.checkerOpt.ignoreNodata | boolean | 複合モニターで、データ欠落結果を無視するかどうか(true は無視することを意味) 例: True |
|
| jsonScript.checkerOpt.confidenceInterval | integer | 区間検出 V2 で追加されたパラメータ。信頼区間の範囲。1~100 の値をとります。 例: 10 |
|
| jsonScript.channels | array | チャンネル UUID リスト 例: ['名前1', '名前2'] 空の値を許可: False |
|
| jsonScript.atAccounts | array | 通常検出時に @ されるアカウント UUID リスト 例: ['xx1', 'xx2'] 空の値を許可: False |
|
| jsonScript.atNoDataAccounts | array | データ欠落時に @ されるアカウント UUID リスト 例: ['xx1', 'xx2'] 空の値を許可: False |
|
| jsonScript.subUri | string | OuterEventChecker の Webhook アドレスサフィックス。新規作成時は必須ですが、一意性は要求されません。 例: datakit/push 空の値を許可: False |
|
| jsonScript.isChangeEvent | boolean | OuterEventChecker を変更イベントとして処理するかどうか。デフォルトは false。既存ルールで欠落している場合は false として処理されます。 例: False 空の値を許可: False |
|
| jsonScript.disableCheckEndTime | boolean | 終了時間制限を無効にするかどうか 例: True 空の値を許可: False |
|
| jsonScript.eventChartEnable | boolean | イベントチャートを有効にするかどうか。デフォルトは無効(主記憶エンジン logging が doris の場合のみ有効) 例: False 空の値を許可: False |
|
| jsonScript.eventCharts | array | イベントチャートリスト 例: True 空の値を許可: False |
|
| jsonScript.eventCharts[*] | None | ||
| jsonScript.eventCharts[*].dql | string | イベントチャートのクエリ文 例: M:: cpu:(avg(load5s)) BY host 空の値を許可: False |
|
| openPermissionSet | boolean | カスタム権限設定を有効にする(デフォルト false:無効)。有効にすると、このルールの操作権限は permissionSet に従います。 空の値を許可: False |
|
| permissionSet | array | 操作権限設定。設定可能な値:ロール(所有者を除く)、メンバー UUID、チーム UUID。 例: ['wsAdmin', 'acnt_xxxx', 'group_yyyy'] 空の値を許可: False |
パラメータ補足説明¶
データ説明
jsonScript パラメータ説明
1. チェックタイプ jsonScript.type の説明
| key | 説明 |
|---|---|
| simpleCheck | しきい値検出 |
| seniorMutationsCheck | 変化点検出 |
| seniorRangeCheck | 区間検出 |
| seniorRangeV2Check | 区間検出 V2 |
| outlierCheck | 外れ値検出 |
| loggingCheck | ログ検出 |
| processCheck | プロセス異常検出 |
| objectSurvivalCheck | インフラストラクチャ生存検出 |
| objectSurvivalV2Check | インフラストラクチャ生存検出 V2、doris ワークスペースのみサポート |
| objectChangeCheck | インフラストラクチャ変更検出 |
| apmCheck | アプリケーションパフォーマンスモニタリング(APM)指標検出 |
| rumCheck | リアルユーザーモニタリング(RUM)指標検出 |
| securityCheck | セキュリティチェック異常検出 |
| cloudDialCheck | Synthetic テスト異常検知 |
| networkCheck | ネットワークデータ検出 |
| OuterEventChecker | 外部イベント検出 |
| smartHostCheck | インテリジェントモニタリング、ホストインテリジェント検出 |
| smartLogCheck | インテリジェントモニタリング、ログインテリジェント検出 |
| smartApmCheck | インテリジェントモニタリング、アプリケーションインテリジェント検出 |
| smartRumCheck | インテリジェントモニタリング、ユーザーアクセスインテリジェント検出 |
| smartKubeCheck | インテリジェントモニタリング、Kubernetes インテリジェント検出 |
| smartCloudBillingCheck | インテリジェントモニタリング、クラウド請求書インテリジェント検出 |
| combinedCheck | 複合モニター |
| programmableCheck | プログラマブルモニター |
2. 廃止されたチェックタイプ jsonScript.type の説明
| key | 説明 |
|---|---|
| seniorCheck | アドバンストチェック、廃止 |
| mutationsCheck | 変化点チェック、廃止、seniorMutationsCheck に更新 |
| waterLevelCheck | 水位チェック、廃止 |
| rangeCheck | 区間チェック、廃止、seniorRangeCheck に更新 |
3. トリガー条件比較演算子の説明(checkerOpt.rules のパラメータ説明)
| パラメータ名 | type | 必須 | 説明 |
|---|---|---|---|
| conditions | Array[Dict] | 必須 | 条件 |
| conditions[#].alias | String | 必須 | 検出対象のエイリアス。上記 targets[#].alias を参照 |
| conditions[#].operator | String | 必須 | 演算子。= , > , < など |
| conditions[#].operands | Array[Any] | 必須 | オペランド配列(between, in などの演算子は複数のオペランドが必要) |
| conditionLogic | string | 必須 | 条件間の論理。and, or |
| status | string | 必須 | 条件を満たした場合に出力されるイベントの status。イベントの status と同じ値をとります。 |
| direction | string | 【区間/水位/変化点パラメータ】検出方向。値:"up", "down", "both" | |
| periodNum | integer | 【区間/水位/変化点パラメータ】最近のデータポイント数のみを検出 | |
| checkPercent | integer | 【区間パラメータ】異常パーセンテージしきい値。値:1~100 | |
| checkCount | integer | 【水位/変化点パラメータ】連続異常ポイント数 | |
| strength | integer | 【水位/変化点パラメータ】検出強度。値:1=弱、2=中、3=強 | |
| matchTimes | integer | 連続トリガー設定(checkerOpt.openMatchTimes)が有効な場合の連続トリガー回数 [1,10] | |
| okConditions | Array[Dict] | 復旧条件 | |
| okConditions[#].alias | String | 検出対象のエイリアス。上記 targets[#].alias を参照 | |
| okConditions[#].operator | String | 演算子。= , > , < など | |
| okConditions[#].operands | Array[Any] | オペランド配列(between, in などの演算子は複数のオペランドが必要) |
4. シンプル/ログ/水位/変化点/区間チェック jsonScript.type in (simpleCheck, loggingCheck, waterLevelCheck, mutationsCheck, rangeCheck, securityCheck)のパラメータ情報
| パラメータ名 | type | 必須 | 説明 |
|---|---|---|---|
| title | string | Y | 障害イベントのタイトルテンプレートを出力 |
| message | string | N | 障害イベントの情報テンプレートを出力 |
| recoverTitle | string | N | 復旧イベントのタイトルテンプレートを出力 |
| recoverMessage | string | N | 復旧イベントの情報テンプレートを出力 |
| noDataTitle | string | N | データ欠落イベントのタイトルテンプレートを出力 |
| noDataMessage | string | N | データ欠落イベントの情報テンプレートを出力 |
| noDataRecoverTitle | string | N | データ欠落復旧アップロードイベントのタイトルテンプレートを出力 |
| noDataRecoverMessage | string | N | データ欠落復旧アップロードイベントの情報テンプレートを出力 |
| openNotificationMessage | boolean | N | イベントの通知内容を有効にするかどうか |
| notificationMessage | string | N | イベントの通知内容 |
| openNoDataNotificationMessage | string | N | データ欠落イベントの通知内容を有効にするかどうか |
| noDataNotificationMessage | string | N | データ欠落イベントの通知内容 |
| name | string | Y | ルール名 |
| type | string | Y | ルールタイプ |
| every | string | Y | チェック頻度。単位は (1m/1h/1d) |
| customCrontab | string | N | カスタムチェック頻度の crontab |
| delaySeconds | integer | N | データ待機ウィンドウ(秒単位)。サポートされる値:0、60、120、180、300、600、900、1800。デフォルトは 0。 |
| interval | integer | Y | データ時間範囲の時差、つまり time_range の時差。単位:秒 |
| recoverNeedPeriodCount | integer | Y | 指定されたチェック周期数を超えた後に復旧イベントを生成します。チェック頻度がカスタム crontab の場合、このフィールドは時間の長さ(秒)を表し、それ以外の場合はチェック頻度の回数を表します。 |
| noDataInterval | integer | N | この時間内にデータがない場合、データ欠落イベントを生成する |
| noDataAction | string | N | データ欠落時の処理操作 |
| targets | array | Y | シンプルチェックのチェックターゲットリスト |
| targets[*].dql | string | Y | DQL クエリ文 |
| targets[*].alias | string | Y | エイリアス |
| targets[*].monitorCheckerId | string | Y | 複合モニターのモニター ID(rul_xxxxx) |
| checkerOpt | json | N | チェック設定。オプション。 |
| checkerOpt.rules | array | Y | チェックルールリスト |
| checkerOpt.openMatchTimes | boolean | N | 連続トリガー判定を有効にするかどうか。デフォルトは無効 false。 |
| checkerOpt.openOkConditions | boolean | N | 復旧条件設定を有効にするかどうか。デフォルトは無効 false。 |
| checkerOpt.disableLargeScaleEventProtect | boolean | N | 大規模イベント保護を無効にするかどうか。デフォルトは false。 |
5. jsonScript.noDataAction パラメータ情報
| パラメータ名 | 説明 |
|---|---|
| none | アクションなし(「データ欠落関連処理を無効にする」と同じ) |
| checkAs0 | クエリ結果を 0 とみなす |
| noDataEvent | 復旧イベント(noData)をトリガー |
| fatalEvent | 致命的イベント(fatal)をトリガー |
| criticalEvent | 緊急イベント(critical)をトリガー |
| errorEvent | 重要イベント(error)をトリガー |
| warningEvent | 警告イベント(warning)をトリガー |
| okEvent | 復旧イベント(ok)をトリガー |
| noData | データ欠落イベントを生成。このパラメータは 2024-04-10 に廃止され、その機能ロジックは noDataEvent と同じです。noDataEvent に直接置き換えることができます。 |
| recover | 復旧イベントをトリガー。このパラメータは 2024-04-10 に廃止され、その機能ロジックは okEvent と同じです。okEvent に直接置き換えることができます。 |
6. アドバンストチェック jsonScript.type in (seniorCheck)のパラメータ情報
| パラメータ名 | type | 必須 | 説明 |
|---|---|---|---|
| title | string | Y | 障害イベントのタイトルテンプレートを出力 |
| message | string | N | 障害イベントの情報テンプレートを出力 |
| recoverTitle | string | N | 復旧イベントのタイトルテンプレートを出力 |
| recoverMessage | string | N | 復旧イベントの情報テンプレートを出力 |
| noDataTitle | string | N | データ欠落イベントのタイトルテンプレートを出力 |
| noDataMessage | string | N | データ欠落イベントの情報テンプレートを出力 |
| noDataRecoverTitle | string | N | データ欠落復旧アップロードイベントのタイトルテンプレートを出力 |
| noDataRecoverMessage | string | N | データ欠落復旧アップロードイベントの情報テンプレートを出力 |
| type | string | Y | ルールタイプ |
| every | string | Y | チェック頻度。単位は (1m/1h/1d) |
| customCrontab | string | N | カスタムチェック頻度の crontab |
| delaySeconds | integer | N | データ待機ウィンドウ(秒単位)。サポートされる値:0、60、120、180、300、600、900、1800。デフォルトは 0。 |
| checkFuncs | array | Y | アドバンストチェック関数リスト。注意:要素は1つだけです。 |
| checkFuncs[#].funcId | string | Y | 関数 ID。【外部関数】一覧表示 インターフェースを使用して、funcTags=monitorType|custom のカスタムチェック関数リストを取得できます。 |
| checkFuncs[#].kwargs | json | N | このアドバンスト関数に必要なパラメータデータ |
7. 変化点チェック seniorMutationsCheck のパラメータ説明
| パラメータ名 | type | 必須 | 説明 |
|---|---|---|---|
| jsonScript.range | integer | N | 検出指標の Result 期間1 |
| jsonScript.range_2 | integer | N | 検出指標の Result 期間2。特殊な説明:(-1 は前周期比、0 は periodBefore フィールドを使用することを意味します) |
| jsonScript.periodBefore | integer | N | jsonScript.range_2 が 0 の場合、このフィールドは(前日/1時間前)を表します |
| jsonScript.checkerOpt.diffMode | string | N | 変化点検出の差分モード(差分値:value、差分パーセンテージ:percent) |
| jsonScript.checkerOpt.threshold.status | boolean | N | 変化点検出のトリガー前提条件設定。有効/無効 |
| jsonScript.checkerOpt.threshold.operator | string | N | 変化点検出のトリガー前提条件設定。演算子 |
| jsonScript.checkerOpt.threshold.value | float | N | 変化点検出のトリガー前提条件設定。検出値 |
8. 複合モニター関連フィールドのパラメータ説明
| パラメータ名 | type | 必須 | 説明 |
|---|---|---|---|
| jsonScript.checkerOpt.combineExpr | string | Y | 組み合わせ方法。例:A && B |
| jsonScript.checkerOpt.ignoreNodata | boolean | N | データ欠落結果を無視するかどうか(true は無視することを意味) |
9. 外部イベント検出 jsonScript.type in (OuterEventChecker)関連フィールドのパラメータ説明
| パラメータ名 | type | 必須 | 説明 |
|---|---|---|---|
| secret | string | N | イベントが属するモニターを識別するために使用します。グローバルに一意です。作成時に省略した場合は Studio が生成し、Import では古い値を再利用しません。 |
| jsonScript.subUri | string | Y | Webhook アドレスサフィックス。新規作成時は必須ですが、一意性は要求されません。 |
| jsonScript.isChangeEvent | boolean | N | 変更イベントとして処理するかどうか。デフォルトは false。既存ルールでこのフィールドが欠落している場合も false として処理されます。 |
10. フィールド disableCheckEndTime の説明
注意:このセクションの Guance はテンプレート変数のため、そのまま保持します。
報告されたデータに対して、Guance はその処理ロジックとして「追記書き込み」と「更新上書き」の2つのモードを持ちます。これらのデータの特性に基づき、モニターは検出を区別して処理する必要があります。この区別は、モニター、インテリジェントモニタリング、インテリジェントインスペクションのすべてのモジュールに適用されます。 更新上書きメカニズムを持つすべてのデータタイプでモニター検出を設定する場合、モニターの実行 delay 1 分により、更新モードのデータが固定の時間範囲内でエスケープする現象を防ぐため、このようなモニタータイプの検出区間では終了時間を指定しません。 該当するモニタータイプ:しきい値検出、変化点検出、区間検出、外れ値検出、プロセス異常検出、インフラストラクチャ生存検出、リアルユーザーモニタリング(RUM)指標検出(一部の指標。詳細は以下の表を参照)
| データタイプ | Namespace | 書き込みモード |
|---|---|---|
| メトリクス | M | 追記 |
| イベント | E | 追記 |
| 未復旧イベント | UE | 上書き |
| インフラストラクチャ - オブジェクト | O | 上書き |
| インフラストラクチャ - カスタムオブジェクト | CO | 上書き |
| インフラストラクチャ - オブジェクト履歴 | OH | 追記 |
| インフラストラクチャ - カスタムオブジェクト履歴 | COH | 追記 |
| ログ / Synthetic モニタリング / CI 可視化 | L | 追記 |
| アプリケーションパフォーマンスモニタリング(APM)- トレース | T | 追記 |
| アプリケーションパフォーマンスモニタリング(APM)- プロファイル | P | 追記 |
| リアルユーザーモニタリング(RUM)- セッション | R::session | 上書き |
| リアルユーザーモニタリング(RUM)- ビュー | R::view | 上書き |
| リアルユーザーモニタリング(RUM)- リソース | R::resource | 追記 |
| リアルユーザーモニタリング(RUM)- ロングタスク | R::long_task | 追記 |
| リアルユーザーモニタリング(RUM)- アクション | R::action | 追記 |
| リアルユーザーモニタリング(RUM)- エラー | R::error | 追記 |
| セキュリティチェック | S |
書き込みモードが「上書き」のものは、すべて disableCheckEndTime を true に指定する必要があります。
11. 区間検出 V2 バージョンの関連パラメータフィールド説明
| パラメータ名 | type | 必須 | 説明 |
|---|---|---|---|
| jsonScript.checkerOpt.confidenceInterval | integer | Y | 信頼区間の範囲。1~100% の値をとります。 |
12. モニター操作権限設定のパラメータ説明
| パラメータ名 | type | 説明 |
|---|---|---|
| openPermissionSet | boolean | カスタム権限設定を有効にするかどうか。デフォルトは false。 |
| permissionSet | array | 操作権限設定 |
permissionSet, openPermissionSet フィールドの説明(2024-06-26 イテレーションで追加されたフィールド):
openPermissionSet を有効にすると、ワークスペース所有者および permissionSet 設定に含まれるロール、チーム、メンバーのみが編集/有効化/無効化/削除を実行できます。
openPermissionSet を無効にすると(デフォルト)、削除/有効化/無効化/編集権限は既存のインターフェースの編集/有効化/無効化/削除権限に従います。
permissionSet フィールドには、ロール UUID(wsAdmin, general, readOnly, role_xxxxx)、チーム UUID(group_yyyy)、メンバー UUID(acnt_xxx)を設定できます。
permissionSet フィールドの例:
13. インシデント連携の設定説明
| パラメータ名 | type | 説明 |
|---|---|---|
| extend.isNeedCreateIssue | boolean | インシデントを連携するかどうか。デフォルトは連携しない。 |
| extend.issueDfStatus | array | 選択可能な5タイプ(fatal, critical, error, warning, nodata)。issueDfStatus が存在する場合、モニターが生成したイベントの df_status が issueDfStatus に含まれている場合のみ Issue が作成されます。issueDfStatus が存在しない場合は、すべてのイベントで Issue が作成されます。 |
| extend.issueLevelUUID | string | Issue のレベル UUID |
| extend.manager | array | Issue 作成時の担当者情報(メールアドレス/ワークスペースメンバー/チーム)。例:["xxx@guance.com","acnt_yyyy", "group_"] |
| extend.needRecoverIssue | boolean | イベント復旧時に Issue を同期クローズする必要があるかどうか。デフォルトは false。 |
| jsonScript.channels | string | isNeedCreateIssue が true の場合、このフィールドは必須です。Issue のチャンネル情報。例:["chan_xxx", "chan_yyy"] |
14. DQL 表示モード queryType の説明
extend.querylist が未指定の場合、queryType は自動注入を制御する外部オプションフィールドです。simple と dql のみをサポートし、未指定の場合はデフォルトで dql になります。simple を指定すると、Studio はローカルの DQL パーサーを使用して jsonScript.targets からシンプルモードのフィールドを解析・注入します。解析または変換に失敗した場合は、自動的に DQL テキストモードにフォールバックします。extend.querylist が明示的に指定された場合は、呼び出し元の構造を完全に保持し、queryType の注入セマンティクスは無視されます。
リクエスト例¶
curl 'https://openapi.guance.com/api/v1/checker/add' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json;charset=UTF-8' \
--data-raw '{"queryType":"simple","extend":{"funcName":"","isNeedCreateIssue":false,"issueLevelUUID":"","needRecoverIssue":false,"querylist":[{"datasource":"dataflux","qtype":"dql","query":{"alias":"","code":"Result","dataSource":"ssh","field":"ssh_check","fieldFunc":"count","fieldType":"float","funcList":[],"groupBy":["host"],"groupByTime":"","namespace":"metric","q":"M::`ssh`:(count(`ssh_check`)) BY `host`","type":"simple"},"uuid":"aada629a-672e-46f9-9503-8fd61065c382"}],"rules":[{"conditionLogic":"and","conditions":[{"alias":"Result","operands":["90"],"operator":">="}],"status":"critical"},{"conditionLogic":"and","conditions":[{"alias":"Result","operands":["0"],"operator":">="}],"status":"error"}]},"jsonScript":{"atAccounts":[],"atNoDataAccounts":[],"channels":[],"checkerOpt":{"infoEvent":false,"rules":[{"conditionLogic":"and","conditions":[{"alias":"Result","operands":["90"],"operator":">="}],"status":"critical"},{"conditionLogic":"and","conditions":[{"alias":"Result","operands":["0"],"operator":">="}],"status":"error"}]},"disableCheckEndTime":false,"every":"1m","groupBy":["host"],"interval":300,"message":">Level:{{status}} \n>Host:{{host}} \n>Content:Host SSH Status {{ Result | to_fixed(2) }}% \n>Suggestion:Check Host SSH Service Status","noDataMessage":"","noDataTitle":"","recoverNeedPeriodCount":2,"targets":[{"alias":"Result","dql":"M::`ssh`:(count(`ssh_check`)) BY `host`","qtype":"dql"}],"title":"Host {{ host }} SSH Service Exception-Add Alert Policy","type":"simpleCheck"},"alertPolicyUUIDs":["altpl_xxxx32","altpl_xxxx32"]}' \
--compressed
レスポンス¶
{
"code": 200,
"content": {
"alertPolicyUUIDs": [
"altpl_xxxx32",
"altpl_xxxx32"
],
"createAt": 1710831393,
"createdWay": "manual",
"creator": "wsak_xxxx",
"crontabInfo": {
"crontab": "*/1 * * * *",
"id": "cron-2n8ZyrMWKXB8"
},
"declaration": {
"b": [
"asfawfgajfasfafgafwba",
"asfgahjfaf"
],
"business": "aaa",
"organization": "64fe7b4062f74d0007b46676"
},
"deleteAt": -1,
"extend": {
"funcName": "",
"isNeedCreateIssue": false,
"issueLevelUUID": "",
"needRecoverIssue": false,
"querylist": [
{
"datasource": "dataflux",
"qtype": "dql",
"query": {
"alias": "",
"code": "Result",
"dataSource": "ssh",
"field": "ssh_check",
"fieldFunc": "count",
"fieldType": "float",
"funcList": [],
"groupBy": [
"host"
],
"groupByTime": "",
"namespace": "metric",
"q": "M::`ssh`:(count(`ssh_check`)) BY `host`",
"type": "simple"
},
"uuid": "aada629a-672e-46f9-9503-8fd61065c382"
}
],
"rules": [
{
"conditionLogic": "and",
"conditions": [
{
"alias": "Result",
"operands": [
"90"
],
"operator": ">="
}
],
"status": "critical"
},
{
"conditionLogic": "and",
"conditions": [
{
"alias": "Result",
"operands": [
"0"
],
"operator": ">="
}
],
"status": "error"
}
]
},
"id": null,
"isLocked": false,
"jsonScript": {
"atAccounts": [],
"atNoDataAccounts": [],
"channels": [],
"checkerOpt": {
"infoEvent": false,
"rules": [
{
"conditionLogic": "and",
"conditions": [
{
"alias": "Result",
"operands": [
"90"
],
"operator": ">="
}
],
"status": "critical"
},
{
"conditionLogic": "and",
"conditions": [
{
"alias": "Result",
"operands": [
"0"
],
"operator": ">="
}
],
"status": "error"
}
]
},
"disableCheckEndTime": false,
"every": "1m",
"groupBy": [
"host"
],
"interval": 300,
"message": ">Level:{{status}} \n>Host:{{host}} \n>Content:Host SSH Status {{ Result | to_fixed(2) }}% \n>Suggestion:Check Host SSH Service Status",
"name": "Host {{ host }} SSH Service Exception-Add Alert Policy",
"noDataMessage": "",
"noDataTitle": "",
"recoverNeedPeriodCount": 2,
"targets": [
{
"alias": "Result",
"dql": "M::`ssh`:(count(`ssh_check`)) BY `host`",
"qtype": "dql"
}
],
"title": "Host {{ host }} SSH Service Exception-Add Alert Policy",
"type": "simpleCheck"
},
"monitorName": "default",
"monitorUUID": "monitor_xxxx32",
"refKey": "",
"secret": "",
"status": 0,
"tagInfo": [],
"type": "trigger",
"updateAt": null,
"updator": null,
"uuid": "rul_xxxx32",
"workspaceUUID": "wksp_xxxx32"
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-014A6CF1-E9D8-4EA7-9527-D3C39CC3A94A"
}