Skip to content

Commit

Permalink
[DOCS] Correctly read total hits inside watcher config (#50614)
Browse files Browse the repository at this point in the history
With #35848, users can now retrieve total hits as an integer when the `rest_total_hits_as_int` query parameter is `true`. This is the default value.

This updates several snippet examples in the Watcher docs that used a workaround to get a total hits integer.
  • Loading branch information
Florian Kelbert authored and jrodewig committed Jan 16, 2020
1 parent 6b86b86 commit 1433b84
Showing 1 changed file with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions x-pack/docs/en/watcher/actions.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -69,14 +69,14 @@ PUT _watcher/watch/error_logs_alert
}
},
"condition" : {
"compare" : { "ctx.payload.hits.total.value" : { "gt" : 5 }}
"compare" : { "ctx.payload.hits.total" : { "gt" : 5 }}
},
"actions" : {
"email_administrator" : {
"throttle_period": "15m", <1>
"email" : { <2>
"to" : "sys.admino@host.domain",
"subject" : "Encountered {{ctx.payload.hits.total.value}} errors",
"subject" : "Encountered {{ctx.payload.hits.total}} errors",
"body" : "Too many error in the system, see attached data",
"attachments" : {
"attached_data" : {
Expand Down Expand Up @@ -119,14 +119,14 @@ PUT _watcher/watch/log_event_watch
}
},
"condition" : {
"compare" : { "ctx.payload.hits.total.value" : { "gt" : 5 }}
"compare" : { "ctx.payload.hits.total" : { "gt" : 5 }}
},
"throttle_period" : "15m", <1>
"actions" : {
"email_administrator" : {
"email" : {
"to" : "sys.admino@host.domain",
"subject" : "Encountered {{ctx.payload.hits.total.value}} errors",
"subject" : "Encountered {{ctx.payload.hits.total}} errors",
"body" : "Too many error in the system, see attached data",
"attachments" : {
"attached_data" : {
Expand All @@ -144,7 +144,7 @@ PUT _watcher/watch/log_event_watch
"host" : "pager.service.domain",
"port" : 1234,
"path" : "/{{watch_id}}",
"body" : "Encountered {{ctx.payload.hits.total.value}} errors"
"body" : "Encountered {{ctx.payload.hits.total}} errors"
}
}
}
Expand Down Expand Up @@ -265,13 +265,13 @@ PUT _watcher/watch/log_event_watch
}
},
"condition" : {
"compare" : { "ctx.payload.hits.total.value" : { "gt" : 0 } }
"compare" : { "ctx.payload.hits.total" : { "gt" : 0 } }
},
"actions" : {
"email_administrator" : {
"email" : {
"to" : "sys.admino@host.domain",
"subject" : "Encountered {{ctx.payload.hits.total.value}} errors",
"subject" : "Encountered {{ctx.payload.hits.total}} errors",
"body" : "Too many error in the system, see attached data",
"attachments" : {
"attached_data" : {
Expand All @@ -285,14 +285,14 @@ PUT _watcher/watch/log_event_watch
},
"notify_pager" : {
"condition": { <1>
"compare" : { "ctx.payload.hits.total.value" : { "gt" : 5 } }
"compare" : { "ctx.payload.hits.total" : { "gt" : 5 } }
},
"webhook" : {
"method" : "POST",
"host" : "pager.service.domain",
"port" : 1234,
"path" : "/{{watch_id}}",
"body" : "Encountered {{ctx.payload.hits.total.value}} errors"
"body" : "Encountered {{ctx.payload.hits.total}} errors"
}
}
}
Expand Down

0 comments on commit 1433b84

Please sign in to comment.