Skip to content

Observability Pipelines: Add indexed fields description to Splunk HEC docs#35214

Draft
Jansen-w wants to merge 2 commits intomasterfrom
Jansen-w/OPA-4706-add-docs-for-indexed-fields
Draft

Observability Pipelines: Add indexed fields description to Splunk HEC docs#35214
Jansen-w wants to merge 2 commits intomasterfrom
Jansen-w/OPA-4706-add-docs-for-indexed-fields

Conversation

@Jansen-w
Copy link
Contributor

What does this PR do? What is the motivation?

Adds a description for the new optional indexed_fields array added to the Splunk HEC destination

Merge instructions

Merge readiness:

  • Ready for merge

AI assistance

No AI used.

@Jansen-w Jansen-w requested a review from maycmlee March 11, 2026 19:27
Copy link
Contributor

@maycmlee maycmlee left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @Jansen-w for opening this PR! Left some suggestions and a request to put the link in the link list at the bottom of the page.

1. Enter the name of the Splunk index you want your data in. This has to be an allowed index for your HEC. See [template syntax][3] if you want to route logs to different indexes based on specific fields in your logs.
1. Select whether the timestamp should be auto-extracted. If set to `true`, Splunk extracts the timestamp from the message with the expected format of `yyyy-mm-dd hh:mm:ss`.
1. Select whether the timestamp should be auto-extracted. If set to `true`, Splunk extracts the timestamp from the message with the expected format of `yyyy-mm-dd hh:mm:ss`.
1. When using JSON encoding, you may populate the indexed fields list with keys of the fields you want extracted as [indexed fields](https://help.splunk.com/en/splunk-enterprise/get-started/get-data-in/9.0/get-data-with-http-event-collector/automate-indexed-field-extractions-with-http-event-collector). This indexes the specified fields at ingest-time in your Splunk HTTP event collector.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this needs to go after the sourcetype step, based on the location of the new fields in the UI.

Also, could you add the link to the link list at the bottom of the page?

[4]: https://help.splunk.com/en/splunk-enterprise/get-started/get-data-in/9.0/get-data-with-http-event-collector/automate-indexed-field-extractions-with-http-event-collector

Suggested change
1. When using JSON encoding, you may populate the indexed fields list with keys of the fields you want extracted as [indexed fields](https://help.splunk.com/en/splunk-enterprise/get-started/get-data-in/9.0/get-data-with-http-event-collector/automate-indexed-field-extractions-with-http-event-collector). This indexes the specified fields at ingest-time in your Splunk HTTP event collector.
1. Select the **Encoding** in the dropdown menu (**JSON** or **Raw**).
- If you selected **JSON**, optionally click **Add Field** to add keys of fields you want extracted as [indexed fields][4]. This indexes the specified fields when the Splunk HTTP Event Collector ingests the logs.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done!

@github-actions
Copy link
Contributor

Preview links (active after the build_preview check completes)

Modified Files

@Jansen-w Jansen-w requested a review from maycmlee March 12, 2026 16:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants