json:prettyPrint() Query Function

Pretty Prints a JSON field. This can be an expensive operation and you should usually do this after filtering your data—at the end of your query. This will prevent data that will be filtered out from being formatted. If the field does not contain valid JSON, the unmodified input value is stored in the output field. If no field is specified the @rawstring will be formatted.

Parameters

Name

Type

Required

Default

Description

field

string

No

@rawstring

The name of the field to format.

step

number

No

2

The indentation in number of characters, minimum 2 spaces.

strict

boolean

No

false

If set to true only valid JSON input produce a value in the output field. By default invalid JSON is copied to the output field unmodified.

as

string

No

The name of the field to store the output in.

The implied parameter is field.

Examples

Format JSON in the @rawstring field after filtering the data.

humio
#type=json | account=123 | json:prettyPrint()

Only copy valid JSON to the output field by setting strict=true Here the field formattedJson will not be created for events with invalid JSON in message.

humio
formattedJson := json:prettyPrint(field=message, strict=true)