IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« Numeric field formatters License Management »
Elastic Docs ›Kibana Guide [7.10] ›Stack Management ›Field management

Scripted fields

edit

Scripted fields

edit

Scripted fields compute data on the fly from the data in your Elasticsearch indices. The data is shown on the Discover tab as part of the document data, and you can use scripted fields in your visualizations. You query scripted fields with the Kibana query language, and can filter them using the filter bar. The scripted field values are computed at query time, so they aren’t indexed and cannot be searched using the Kibana default query language.

Computing data on the fly with scripted fields can be very resource intensive and can have a direct impact on Kibana performance. Keep in mind that there’s no built-in validation of a scripted field. If your scripts are buggy, you’ll get exceptions whenever you try to view the dynamically generated data.

When you define a scripted field in Kibana, you have a choice of the Lucene expressions or the Painless scripting language.

You can reference any single value numeric field in your expressions, for example:

doc['field_name'].value

For more information on scripted fields and additional examples, refer to Using Painless in Kibana scripted fields

Create a scripted field

edit
  1. Open the main menu, then click Stack Management > Index Patterns.
  2. Select the index pattern you want to add a scripted field to.
  3. Go to the Scripted fields tab for the index pattern, then click Add scripted field.
  4. Enter a name for the scripted field.
  5. Enter the expression that you want to use to compute a value on the fly from your index data.
  6. Click Create field.

For more information about scripted fields in Elasticsearch, see Scripting.

Update a scripted field

edit
  1. Click the Scripted fields tab for the index pattern.
  2. Click the Edit button for the scripted field you want to change.
  3. Make your changes, then click Save field.

Built-in validation is unsupported for scripted fields. If your scripts are buggy, you’ll get exceptions whenever you try to view the dynamically generated data.

Delete a scripted field

edit
  1. Click the Scripted fields tab for the index pattern.
  2. Click Delete for the scripted field you want to remove.
  3. Click Delete on the confirmation window.
« Numeric field formatters License Management »