'Pretty Prints' an XML 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 XML, the unmodified input value is stored in the output field. If no field is specified the @rawstring will be formatted.
Function Traits: FieldComputationFunction, Transformation
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
as | string | optional | The name of the field to store the output in. | |
field[a] | string | required | @rawstring | The name of the field to format. |
step | number | optional | 2 | The indentation in number of characters. |
strict | boolean | optional | false | If set to true only valid XML input produce a value in the output field. By default invalid XML is copied to the output field unmodified. |
width | number | optional | 80 | The width (in number of characters) to fit the output input. |
The parameter name for field can be omitted; the following forms are equivalent:
xml:prettyPrint("@rawstring")and:
xml:prettyPrint(field="@rawstring")xml:prettyPrint() Examples
Format XML in the @rawstring field after filtering the data.
#type=SOAP
| account=123
| xml:prettyPrint()Format XML in the field field payload to a max line length of 100 and indent by 4 spaces.
formattedXml := xml:prettyPrint(field=payload, step=4, width=100)
Only copy valid XML to the output field by setting
strict=true. Here
the field formattedXml will not be created for
events with invalid XML in message.
formattedXml := xml:prettyPrint(field=message, strict=true)