Type to search.

Logging action

Stack

The Elastic Stack includes Elastic's core products such as Elasticsearch, Kibana, Logstash, and Beats.

Availability

  • Generally available

    This functionality is generally available and ready for production usage.

Unless stated otherwise on the page, this functionality is available when your Elastic Stack is deployed on Elastic Cloud Hosted, Elastic Cloud Enterprise, Elastic Cloud on Kubernetes, and self-managed environments.

This documentation corresponds to the latest patch available for each minor version. If you're not using the latest patch, check the release notes for changes.

Use the logging action to log text to the standard Elasticsearch logs. See Logging action attributes for the supported attributes.

This action is primarily used during development and for debugging purposes.

You configure logging actions in the actions array. Action-specific attributes are specified using the logging keyword.

The following snippet shows a simple logging action definition:

JavaScript 
"actions" : {
  "log" : {
    "transform" : { ... },
    "logging" : {
      "text" : "executed at {{ctx.execution_time}}"
    }
  }
}
  1. The id of the action.
  2. An optional transform to transform the payload before executing the logging action.
  3. The text to be logged.
Name Required Default Description
text yes - The text that should be logged. Can be static text or include Mustache templates.
category no xpack.watcher.actions.logging The category under which the text will be logged.
level no info The logging level. Valid values are: error, warn, info, debug and trace.