Splunk Dev

What's the advantage of using __GETINFO__ in custom search scripts?

Lowell
Super Champion

I've written a few custom searches scripts and some of them have used getinfo, and other have not. (Probably based on whichever example I was starting from.)

Can anyone give some insight into what the advantages/disadvantages to using the getinfo feature in custom search scripts? (Possibly some examples where one would be preferable over the other?)

The Custom search commands docs do explain a little bit, but I was hoping for some additional use cases or examples.

Does splunk recommend that newly written scripts use this feature?

0 Karma
1 Solution

gkanapathy
Splunk Employee
Splunk Employee

Seems mostly not that useful, as you have to provide a commands.conf entry for your script to set supports_getinfo anyway. I guess it's handy if you think you might update the script to change its settings and save yourself updating the conf file, but honestly, it seems like it's easier to just set the values in the commands.conf file.

The biggest advantage is just that you can stop the search early if the arguments to your script aren't good, but while nice, that's not really that major an advantage. There's some unlikely cases where you script might use different settings dynamically, but that seems like a real stretch.

View solution in original post

0 Karma

gkanapathy
Splunk Employee
Splunk Employee

Seems mostly not that useful, as you have to provide a commands.conf entry for your script to set supports_getinfo anyway. I guess it's handy if you think you might update the script to change its settings and save yourself updating the conf file, but honestly, it seems like it's easier to just set the values in the commands.conf file.

The biggest advantage is just that you can stop the search early if the arguments to your script aren't good, but while nice, that's not really that major an advantage. There's some unlikely cases where you script might use different settings dynamically, but that seems like a real stretch.

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!

Introduction to Splunk AI

How are you using AI in Splunk? Whether you see AI as a threat or opportunity, AI is here to stay. Lucky for ...

Splunk + ThousandEyes: Correlate frontend, app, and network data to troubleshoot ...

Are you tired of troubleshooting delays caused by siloed frontend, application, and network data? We've got a ...

Maximizing the Value of Splunk ES 8.x

Splunk Enterprise Security (ES) continues to be a leader in the Gartner Magic Quadrant, reflecting its pivotal ...