ウォッチの作成または更新（Create or update watch）

ウォッチAPIの作成または更新

新しいウォッチをWatcherに登録するか、既存のウォッチを更新します。

リクエスト

PUT _watcher/watch/<watch_id>

前提条件

• このAPIを使用するには、manage_watcherクラスター権限が必要です。詳細については、セキュリティ権限を参照してください。

説明

ウォッチが登録されると、ウォッチを表す新しいドキュメントが.watchesインデックスに追加され、そのトリガーは関連するトリガーエンジンに即座に登録されます。通常、scheduleトリガーの場合、スケジューラーがトリガーエンジンです。

KibanaまたはこのAPIを使用してウォッチを作成する必要があります。ElasticsearchインデックスAPIを使用して.watchesインデックスに直接ウォッチを追加しないでください。Elasticsearchのセキュリティ機能が有効になっている場合、.watchesインデックスに対してwrite権限をユーザーに与えないでください。

ウォッチを追加する際に、その初期のアクティブ状態を定義することもできます。activeパラメータを設定することでそれを行います。

セキュリティ統合

Elasticsearchのセキュリティ機能が有効になっている場合、ウォッチは、ウォッチを保存したユーザーが権限を持つインデックスでのみインデックスまたは検索できます。ユーザーがaインデックスを読み取ることができるが、bインデックスを読み取ることができない場合、ウォッチが実行されるときも同様のことが適用されます。

パスパラメータ

• <watch_id>
• （必須、文字列）ウォッチの識別子。

クエリパラメータ

• active
• （オプション、Boolean）ウォッチがデフォルトでアクティブか非アクティブかを定義します。デフォルト値はtrueで、これはウォッチがデフォルトでアクティブであることを意味します。

リクエストボディ

ウォッチには以下のフィールドがあります：

例

以下の例は、my-watch IDを持つウォッチを追加し、次の特性を持ちます：

• ウォッチスケジュールは毎分トリガーされます。
• ウォッチ検索入力は、過去5分間に発生した404 HTTPレスポンスを探します。
• ウォッチ条件は、検索ヒットが見つかったかどうかを確認します。
• 見つかった場合、ウォッチアクションは管理者にメールを送信します。

Python

resp = client.watcher.put_watch(
   id="my-watch",
   trigger={
   "schedule": {
   "cron": "0 0/1 * * * ?"
   }
   },
   input={
   "search": {
   "request": {
   "indices": [
   "logstash*"
   ],
   "body": {
   "query": {
   "bool": {
   "must": {
   "match": {
   "response": 404
   }
   },
   "filter": {
   "range": {
   "@timestamp": {
   "from": "{{ctx.trigger.scheduled_time}}||-5m",
   "to": "{{ctx.trigger.triggered_time}}"
   }
   }
   }
   }
   }
   }
   }
   }
   },
   condition={
   "compare": {
   "ctx.payload.hits.total": {
   "gt": 0
   }
   }
   },
   actions={
   "email_admin": {
   "email": {
   "to": "[email protected]",
   "subject": "404 recently encountered"
   }
   }
   },
)
print(resp)

Js

const response = await client.watcher.putWatch({
  id: "my-watch",
  trigger: {
   schedule: {
   cron: "0 0/1 * * * ?",
   },
  },
  input: {
   search: {
   request: {
   indices: ["logstash*"],
   body: {
   query: {
   bool: {
   must: {
   match: {
   response: 404,
   },
   },
   filter: {
   range: {
   "@timestamp": {
   from: "{{ctx.trigger.scheduled_time}}||-5m",
   to: "{{ctx.trigger.triggered_time}}",
   },
   },
   },
   },
   },
   },
   },
   },
  },
  condition: {
   compare: {
   "ctx.payload.hits.total": {
   gt: 0,
   },
   },
  },
  actions: {
   email_admin: {
   email: {
   to: "[email protected]",
   subject: "404 recently encountered",
   },
   },
  },
});
console.log(response);

コンソール

PUT _watcher/watch/my-watch
{
  "trigger" : {
   "schedule" : { "cron" : "0 0/1 * * * ?" }
  },
  "input" : {
   "search" : {
   "request" : {
   "indices" : [
   "logstash*"
   ],
   "body" : {
   "query" : {
   "bool" : {
   "must" : {
   "match": {
   "response": 404
   }
   },
   "filter" : {
   "range": {
   "@timestamp": {
   "from": "{{ctx.trigger.scheduled_time}}||-5m",
   "to": "{{ctx.trigger.triggered_time}}"
   }
   }
   }
   }
   }
   }
   }
   }
  },
  "condition" : {
   "compare" : { "ctx.payload.hits.total" : { "gt" : 0 }}
  },
  "actions" : {
   "email_admin" : {
   "email" : {
   "to" : "[email protected]",
   "subject" : "404 recently encountered"
   }
   }
  }
}

ウォッチを追加する際に、その初期のアクティブ状態を定義することもできます。activeパラメータを設定することでそれを行います。以下のコマンドはウォッチを追加し、デフォルトで非アクティブに設定します。

Js

PUT _watcher/watch/my-watch?active=false

activeパラメータを省略すると、ウォッチはデフォルトでアクティブになります。