Search input

Stack

Use the search input to load the results of an Elasticsearch search request into the execution context when the watch is triggered. See Search Input Attributes for all of the supported attributes.

In the search input’s request object, you specify:

• The indices you want to search
• The search type
• The search request body

The search request body supports the full Elasticsearch Query DSL—it’s the same as the body of an Elasticsearch _search request.

For example, the following input retrieves all event documents from the logs index:

"input" : {
  "search" : {
    "request" : {
      "indices" : [ "logs" ],
      "body" : {
        "query" : { "match_all" : {}}
      }
    }
  }
}
		

You can use date math and wildcards when specifying indices. For example, the following input loads the latest VIXZ quote from today’s daily quotes index:

{
  "input" : {
    "search" : {
      "request" : {
        "indices" : [ "<stock-quotes-{now/d}>" ],
        "body" : {
          "size" : 1,
          "sort" : {
            "timestamp" : { "order" : "desc"}
          },
          "query" : {
            "term" : { "symbol" : "vix"}
          }
        }
      }
    }
  }
}
		

You can specify which fields in the search response you want to load into the watch payload with the extract attribute. This is useful when a search generates a large response and you are only interested in particular fields.

For example, the following input loads only the total number of hits into the watch payload:

"input": {
    "search": {
      "request": {
        "indices": [ ".watcher-history*" ]
      },
      "extract": [ "hits.total.value" ]
    }
  },
		

The search input supports search templates. For example, the following snippet references the indexed template called my_template and passes a value of 23 to fill in the template’s value parameter:

{
  "input" : {
    "search" : {
      "request" : {
        "indices" : [ "logs" ],
        "template" : {
          "id" : "my_template",
          "params" : {
            "value" : 23
          }
        }
      }
    }
  }
  ...
}
		

The search input is often used in conjunction with the script condition. For example, the following snippet adds a condition to check if the search returned more than five hits:

{
  "input" : {
    "search" : {
      "request" : {
        "indices" : [ "logs" ],
        "body" : {
          "query" : { "match_all" : {} }
        }
      }
    }
  },
  "condition" : {
    "compare" : { "ctx.payload.hits.total" : { "gt" : 5 }}
  }
  ...
}
		

Conditions, transforms, and actions can access the search results through the watch execution context. For example:

• To load all of the search hits into an email body, use ctx.payload.hits.
• To reference the total number of hits, use ctx.payload.hits.total.
• To access a particular hit, use its zero-based array index. For example, to get the third hit, use ctx.payload.hits.hits.2.
• To get a field value from a particular hit, use ctx.payload.hits.hits.<index>.fields.<fieldname>. For example, to get the message field from the first hit, use ctx.payload.hits.hits.0.fields.message.