Watcher chain payload transform

Watcher chain payload transform

A payload transform that executes an ordered list of configured payload transforms in a chain, where the output of one transform serves as the input of the next transform in the chain. The payload that is accepted by this transform serves as the input of the first transform in the chain and the output of the last transform in the chain is the output of the chain transform as a whole.

You can use chain payload transforms to build more complex transforms out of the other available transforms. For example, you can combine a search payload transform and a script payload transform, as shown in the following snippet:

  1. "transform" : {
  2.   "chain" : [ 
  3.     {
  4.       "search" : {  
  5.         "request": {
  6.           "indices" : [ "logstash-*" ],
  7.           "body" : {
  8.             "size" : 0,
  9.             "query" : {
  10.               "match" : { "priority" : "error" }
  11.             }
  12.           }
  13.         }
  14.       }
  15.     },
  16.     {
  17.       "script" : "return [ 'error_count' : ctx.payload.hits.total ]"  
  18.     }
  19.   ]
  20. }

The chain payload transform definition

The first transform in the chain (in this case, a search payload transform)

The second and final transform in the chain (in this case, a script payload transform)

This example executes a count search on the cluster to look for error events. The search results are then passed to the second script payload transform. The script payload transform extracts the total hit count and assigns it to the error_count field in a newly-generated payload. This new payload is the output of the chain payload transform and replaces the payload in the watch execution context.