To Splunk JSON
This topic describes how to use the function in the Splunk Data Stream Processor.
Description
Formats incoming records to adhere to the Splunk HEC event JSON or the Splunk HEC metric JSON format.
In order to send data to the Splunk platform, you must format your records so that they can be mapped to either the Splunk HEC event JSON or the Splunk HEC metrics JSON schema. See Format event data for Splunk indexes for information on how records are mapped to the HEC event JSON schema. See Format metrics data for Splunk indexes for information on how records are mapped to the HEC metrics JSON schema. Use this function to format incoming records into HEC JSON using those mapping rules. If you want to transform your records into the HEC metrics JSON schema, you must set the kind
field to metric
.
Function Input/Output Schema
- Function Input
- collection<record<R>>
- This function takes in collections of records with schema R.
- Function Output
- collection<record<json>>
- This function outputs records with a single field
json
that contains the HEC JSON string.
Syntax
The required syntax is in bold.
- to_splunk_json
- index=expression<string>
- keep_attributes=<bool>
Required arguments
- index
- Syntax: expression<string>
- Description: An expression to get the desired index field.
- Example in Canvas View: cast(map_get(attributes, "index"), "string")
Optional arguments
- keep_attributes
- Syntax: <boolean>
- Description: If true, the DSP "attributes" map from events is transformed into the HEC event JSON fields object and will be available as index-extracted fields in the Splunk platform. If there is an
index
entry in the attributes map, it is ignored and is not added to the JSONfields
object. - Default: false
- Example in Canvas View: true
Usage
The following is an example of what your records look like after using the to_splunk_json
function. Assume that your data looks something like the following snippet, and you've configured the function with the arguments shown in the first SPL2 example.
Record{ body="Hello World", source_type="mysourcetype", id="id12345", source="mysource", timestamp=1234567890012, host="myhost", attributes={"attr1":"val1", "index":"myindex"}}
The To Splunk JSON
function outputs your records like this:
Record { "json" = '{"event":"Hello World", "sourcetype":"mysourcetype", "host":"myhost", "index": "myindex", "time":"1234567890.012"}' }
If you've configured your function with the arguments shown in the second SPL2 example instead, then the To Splunk JSON
function outputs your records like this:
Record { "json" = '{"event":"Hello World", "sourcetype":"mysourcetype", "host":"myhost", "index": "myindex", "time":"1234567890.012", "fields":{"attr1":"val1"}}'
SPL2 examples
Examples of common use cases follow. The following examples in this section assume that you are in the SPL View.
When working in the SPL View you can write the function by providing the arguments in the exact order shown in each use case.
1. Formats incoming records to the HEC event JSON schema
...| to_splunk_json index=cast(map_get(attributes), "index"), "string") |...;
2. Formats incoming records to the HEC event JSON schema with keep_attributes set to true
...| to_splunk_json index=cast(map_get(attributes), "index"), "string") keep_attributes=true |...;
Time Series Decomposition (beta) | Union |
This documentation applies to the following versions of Splunk® Data Stream Processor: 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
Feedback submitted, thanks!