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
Career Survey
First 500 qualified respondents will receive a $20 gift card! Tell us about your professional Splunk journey.
Get Updates on the Splunk Community!

Thanks for the Memories! Splunk University, .conf25, and our Community

Thank you to everyone in the Splunk Community who joined us for .conf25, which kicked off with our iconic ...

Data Persistence in the OpenTelemetry Collector

This blog post is part of an ongoing series on OpenTelemetry. What happens if the OpenTelemetry collector ...

Introducing Splunk 10.0: Smarter, Faster, and More Powerful Than Ever

Now On Demand Whether you're managing complex deployments or looking to future-proof your data ...