The lift submap processing rule uses regular expressions to search for key/value pairs inside a JSON object, then either moves or copies any applicable key/value pairs out of the JSON object and into a higher level of the record.Documentation Index
Fetch the complete documentation index at: https://docs.chronosphere.io/llms.txt
Use this file to discover all available pages before exploring further.
Configuration parameters
Use the parameters in this section to configure the . The Telemetry Pipeline web interface uses the items in the Name column to describe these parameters. Pipeline configuration files use the items in the Key column as YAML keys.| Name | Key | Description | Default |
|---|---|---|---|
| Key | key | Required. The key of the object that contains key/value pairs to move or copy. You can also use record accessor syntax to reference keys nested within another nested object. | none |
| Regex | regex | Required. The regular expression that determines which key/value pairs to move or copy. A value of ^.+$ matches all key/value pairs contained within the specified object. | ^.+$ |
| Regex engine | regexEngine | Required. The engine to parse your regular expression. Accepted values: GNU, Oniguruma, PCRE2, POSIX, TRE. | PCRE2 |
| Levels | levels | Required. How many levels to lift the applicable key/value pairs. For example, the a value of 1 either moves or copies any applicable key/value pairs up one level into the parent object of Key. A value of 3 either moves or copies any applicable key/value pairs up three levels into the great-grandparent object of Key. | 1 |
| Replacement key | keyReplacement | Required. The regular expression that sets the naming pattern for any keys that get moved or copied. A value of %1 preserves the original names of all keys. | %1 |
| Keep original checkbox | keepOrig | If selected, preserves the object specified in Key. If unselected, moves any applicable key/value pairs into a higher level of the record, and then remove the object specified in Key. | Not selected |
| Comment | comment | A custom note or description of the rule’s function. This text is displayed next to the rule’s name in the Actions list in the processing rules interface. | none |
Examples
Using the lift submap rule lets you restructure your telemetry data by pulling key/value pairs out of a nested object and storing them as flat data in a higher level of the record. You can use this rule to simplify deeply nested data and store key/value pairs in more accessible locations.Move key/value pairs
For example, given this sample log data:$user.account, the Regex value id,
the Levels value 1, and the Replacement key value account.%1 returns the
following result:
account object,
moved id up one level into a new key named account.id, and then removed
account and the key/value pairs it originally contained.
Copy key/value pairs
You can also use the Keep original setting to copy key/value pairs out of an object instead of moving them. For example, given this sample log data:$user.account, the Regex value id,
the Levels value 1, the Replacement key value account.%1, and the
Keep original setting enabled returns the following result:
account object,
moved id up one level into a new key named account.id, but did not remove
account and the key/value pairs it originally contained.