Splunk Search

Adding documentation to events

rotate
Engager

I have been thinking about about having documentation "attached" to events. For example a short explanation of a function call.

Could lookups be the best way to achieve this, or would something else be better? Is this a silly idea, or feasible?

Tags (2)
0 Karma

somesoni2
Revered Legend

This is non-silly-totally-feasible idea and is been used in Splunk from time (at least) I started working in Splunk. IMO lookups are the best way to achieve this, have some sort of ID/key field in the result and lookup that field to get more detailed information. (one such example could be to have customer ID in the logs and then customer ID and customer Details in lookup).

martin_mueller
SplunkTrust
SplunkTrust

You can find Splunk itself documenting events using lookups in the Common Information Model app at http://apps.splunk.com/app/1621/ - for example there's a lookup documenting HTTP status codes with their English textual representation, that gets added to access logs and can be used for user-friendly charting.

0 Karma
Got questions? Get answers!

Join the Splunk Community Slack to learn, troubleshoot, and make connections with fellow Splunk practitioners in real time!

Meet up IRL or virtually!

Join Splunk User Groups to connect and learn in-person by region or remotely by topic or industry.

Get Updates on the Splunk Community!

Automating Threat Operations and Threat Hunting with Recorded Future

    Automating Threat Operations and Threat Hunting with Recorded Future June 29, 2026 | Register   Is your ...

Keep the Learning Going with the New Best of .conf Hub

Hello Splunkers, With .conf26 getting closer, there’s already a lot of excitement building around this year’s ...

Splunk Community Badges!

  Hey everyone! Ready to earn some serious bragging rights in the community? Along with our existing badges ...