Skip to content

Restores Watcher execute watch request examples #4754

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jul 2, 2025
+308 −0
Merged

Restores Watcher execute watch request examples #4754

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f53fd4f
Restore Watcher execute watch request examples
kosabogi Jul 2, 2025
65f65fa
Merge branch 'main' into restore-execute-watch-examples
kosabogi Jul 2, 2025
4086262
Merge branch 'main' into restore-execute-watch-examples
kosabogi Jul 2, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
64 changes: 64 additions & 0 deletions specification/watcher/execute_watch/examples/request/WatcherExecuteRequestExample2.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
summary: Run a watch with multiple action modes
method_request: POST _watcher/watch/my_watch/_execute
description: >
Run `POST _watcher/watch/my_watch/_execute` and set a different mode for each action.
# type: request
value: |-
{
"action_modes" : {
"action1" : "force_simulate",
"action2" : "skip"
}
}
alternatives:
- language: Python
code: |-
resp = client.watcher.execute_watch(
id="my_watch",
action_modes={
"action1": "force_simulate",
"action2": "skip"
},
)
- language: JavaScript
code: |-
const response = await client.watcher.executeWatch({
id: "my_watch",
action_modes: {
action1: "force_simulate",
action2: "skip",
},
});
- language: Ruby
code: |-
response = client.watcher.execute_watch(
id: "my_watch",
body: {
"action_modes": {
"action1": "force_simulate",
"action2": "skip"
}
}
)
- language: PHP
code: |-
$resp = $client->watcher()->executeWatch([
"id" => "my_watch",
"body" => [
"action_modes" => [
"action1" => "force_simulate",
"action2" => "skip",
],
],
]);
- language: curl
code:
'curl -X POST -H "Authorization: ApiKey $ELASTIC_API_KEY" -H "Content-Type: application/json" -d
''{"action_modes":{"action1":"force_simulate","action2":"skip"}}''
"$ELASTICSEARCH_URL/_watcher/watch/my_watch/_execute"'
- language: Java
code: |
client.watcher().executeWatch(e -> e
.actionModes(Map.of("action1", ActionExecutionMode.ForceSimulate,"action2", ActionExecutionMode.Skip))
.id("my_watch")
);
244 changes: 244 additions & 0 deletions specification/watcher/execute_watch/examples/request/WatcherExecuteRequestExample3.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,244 @@
summary: Run a watch inline
method_request: POST _watcher/watch/_execute
description: >
Run `POST _watcher/watch/_execute` to run a watch inline. All other settings for this API still apply when inlining a watch. In
this example, while the inline watch defines a compare condition, during the execution this condition will be ignored.
# type: request
value: |-
{
"watch" : {
"trigger" : { "schedule" : { "interval" : "10s" } },
"input" : {
"search" : {
"request" : {
"indices" : [ "logs" ],
"body" : {
"query" : {
"match" : { "message": "error" }
}
}
}
}
},
"condition" : {
"compare" : { "ctx.payload.hits.total" : { "gt" : 0 }}
},
"actions" : {
"log_error" : {
"logging" : {
"text" : "Found {{ctx.payload.hits.total}} errors in the logs"
}
}
}
}
}
alternatives:
- language: Python
code: |-
resp = client.watcher.execute_watch(
watch={
"trigger": {
"schedule": {
"interval": "10s"
}
},
"input": {
"search": {
"request": {
"indices": [
"logs"
],
"body": {
"query": {
"match": {
"message": "error"
}
}
}
}
}
},
"condition": {
"compare": {
"ctx.payload.hits.total": {
"gt": 0
}
}
},
"actions": {
"log_error": {
"logging": {
"text": "Found {{ctx.payload.hits.total}} errors in the logs"
}
}
}
},
)
- language: JavaScript
code: |-
const response = await client.watcher.executeWatch({
watch: {
trigger: {
schedule: {
interval: "10s",
},
},
input: {
search: {
request: {
indices: ["logs"],
body: {
query: {
match: {
message: "error",
},
},
},
},
},
},
condition: {
compare: {
"ctx.payload.hits.total": {
gt: 0,
},
},
},
actions: {
log_error: {
logging: {
text: "Found {{ctx.payload.hits.total}} errors in the logs",
},
},
},
},
});
- language: Ruby
code: |-
response = client.watcher.execute_watch(
body: {
"watch": {
"trigger": {
"schedule": {
"interval": "10s"
}
},
"input": {
"search": {
"request": {
"indices": [
"logs"
],
"body": {
"query": {
"match": {
"message": "error"
}
}
}
}
}
},
"condition": {
"compare": {
"ctx.payload.hits.total": {
"gt": 0
}
}
},
"actions": {
"log_error": {
"logging": {
"text": "Found {{ctx.payload.hits.total}} errors in the logs"
}
}
}
}
}
)
- language: PHP
code: |-
$resp = $client->watcher()->executeWatch([
"body" => [
"watch" => [
"trigger" => [
"schedule" => [
"interval" => "10s",
],
],
"input" => [
"search" => [
"request" => [
"indices" => array(
"logs",
),
"body" => [
"query" => [
"match" => [
"message" => "error",
],
],
],
],
],
],
"condition" => [
"compare" => [
"ctx.payload.hits.total" => [
"gt" => 0,
],
],
],
"actions" => [
"log_error" => [
"logging" => [
"text" => "Found {{ctx.payload.hits.total}} errors in the logs",
],
],
],
],
],
]);
- language: curl
code:
"curl -X POST -H \"Authorization: ApiKey $ELASTIC_API_KEY\" -H \"Content-Type: application/json\" -d
'{\"watch\":{\"trigger\":{\"schedule\":{\"interval\":\"10s\"}},\"input\":{\"search\":{\"request\":{\"indices\":[\"logs\"],\"b\
ody\":{\"query\":{\"match\":{\"message\":\"error\"}}}}}},\"condition\":{\"compare\":{\"ctx.payload.hits.total\":{\"gt\":0}}},\
\"actions\":{\"log_error\":{\"logging\":{\"text\":\"Found {{ctx.payload.hits.total}} errors in the logs\"}}}}}'
\"$ELASTICSEARCH_URL/_watcher/watch/_execute\""
- language: Java
code: |
client.watcher().executeWatch(e -> e
.watch(w -> w
.actions("log_error", a -> a
.logging(l -> l
.text("Found {{ctx.payload.hits.total}} errors in the logs")
)
)
.condition(c -> c
.compare(NamedValue.of("ctx.payload.hits.total",Pair.of(ConditionOp.Gt,FieldValue.of(0))))
)
.input(i -> i
.search(s -> s
.request(r -> r
.body(b -> b
.query(q -> q
.match(m -> m
.field("message")
.query(FieldValue.of("error"))
)
)
)
.indices("logs")
)
)
)
.trigger(t -> t
.schedule(sc -> sc
.interval(in -> in
.time("10s")
)
)
)
)
);