processor-dissect.asciidoc

Dissect strings

dissect

The dissect processor tokenizes incoming strings using defined patterns.

Example

  - dissect:
      tokenizer: "%{key1} %{key2} %{key3|convert_datatype}"
      field: "message"
      target_prefix: "dissect"

For a full example, see Dissect example.

Configuration settings

processors.asciidoc :works-with-fields!:

Name	Required	Default	Description
tokenizer	Yes		Field used to define the dissection pattern. You can provide an optional convert datatype after the key by using a pipe character (|) as a separator to convert the value from string to integer, long, float, double, boolean, or IP.
field	No	message	Event field to tokenize.
target_prefix	No	dissect	Name of the field where the values will be extracted. When an empty string is defined, the processor creates the keys at the root of the event. When the target key already exists in the event, the processor won’t replace it and log an error; you need to either drop or rename the key before using dissect, or enable the overwrite_keys flag.
ignore_failure	No	false	Whether to return an error if the tokenizer fails to match the message field. If true, the processor silently restores the original event, allowing execution of subsequent processors (if any). If false, the processor logs an error, preventing execution of other processors.
overwrite_keys	No	false	Whether to overwrite existing keys. If true, the processor overwrites existing keys in the event. If false, the processor fails if the key already exists.
trim_values	No	none	Enables the trimming of the extracted values. Useful to remove leading and trailing spaces. Possible values are: none: no trimming is performed. left: values are trimmed on the left (leading). right: values are trimmed on the right (trailing). all: values are trimmed for leading and trailing.
trim_chars	No	(" ") to trim space characters	Set of characters to trim from values when trim_values is enabled. To trim multiple characters, set this value to a string containing all characters to trim. For example, trim_chars: " \t" trims spaces and tabs.

For tokenization to be successful, all keys must be found and extracted. If a key cannot be found, an error is logged, and no modification is done on the original event.

Note	A key can contain any characters except reserved suffix or prefix modifiers: /,&, +, # and ?.

See [conditions] for a list of supported conditions.

Dissect example

For this example, imagine that an application generates the following messages:

"321 - App01 - WebServer is starting"
"321 - App01 - WebServer is up and running"
"321 - App01 - WebServer is scaling 2 pods"
"789 - App02 - Database will be restarted in 5 minutes"
"789 - App02 - Database is up and running"
"789 - App02 - Database is refreshing tables"

Use the dissect processor to split each message into three fields, for example, service.pid, service.name, and service.status:

  - dissect:
      tokenizer: '"%{service.pid|integer} - %{service.name} - %{service.status}"'
      field: "message"
      target_prefix: ""

This configuration produces fields like:

"service": {
  "pid": 321,
  "name": "App01",
  "status": "WebServer is up and running"
},

service.name is an ECS {ref}/keyword.html[keyword field], which means that you can use it in {es} for filtering, sorting, and aggregations.

When possible, use ECS-compatible field names. For more information, see the {ecs-ref}/index.html[Elastic Common Schema] documentation.