Splunk® Data Stream Processor

Function Reference

Acrobat logo Download manual as PDF


Acrobat logo Download topic as PDF

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 20 April, 2021
PREVIOUS
Into
  NEXT
Lookup

This documentation applies to the following versions of Splunk® Data Stream Processor: 1.1.0, 1.2.0, 1.2.1


Was this documentation topic helpful?

You must be logged into splunk.com in order to post comments. Log in now.

Please try to keep this discussion focused on the content covered in this documentation topic. If you have a more general question about Splunk functionality or are experiencing a difficulty with Splunk, consider posting a question to Splunkbase Answers.

0 out of 1000 Characters