On October 30, 2022, all 1.2.x versions of the Splunk Data Stream Processor will reach its end of support date. See the Splunk Software Support Policy for details. For information about upgrading to a supported version, see the Upgrade the Splunk Data Stream Processor topic.
Key_by
This topic describes how to use the function in the Splunk Data Stream Processor.
Description
Groups a stream of records by one or more field(s) and returns a grouped stream. Because Key_by outputs a GroupedBy stream, this function must be used in conjunction with Merge Events. This function does not show metrics in the UI.
Syntax
- key_by
- keys=<fields>
Function Input/Output Schema
- Function Input
collection<record<R>>- This function takes in collections of records with schema R.
- Function Output
GroupedStream<record<K>, record<V>>- This function outputs records with schema V, grouped on schema K.
Required arguments
- keys
- Syntax: <fields>
- Description: The names of the fields to group records.
- Example in Canvas View: source, host
SPL2 example
Examples of common use cases follow. The following examples assume that you are in the SPL View.
When working in the SPL View, you can write the function by using the syntax shown in each use case.
1. Group records by source
...| key_by keys=source |...
2. Group records by source and host
...| key_by keys=[source, host] |...
Last modified on 09 February, 2022
| Into | Lookup |
This documentation applies to the following versions of Splunk® Data Stream Processor: 1.1.0, 1.2.0, 1.2.1-patch02, 1.2.1, 1.2.2-patch02, 1.2.4, 1.2.5, 1.3.0, 1.3.1, 1.4.0, 1.4.1, 1.4.2, 1.4.3, 1.4.4, 1.4.5, 1.4.6
Download manual
Feedback submitted, thanks!