topic Re: where is the custom command documentation? in Splunk Search

where is the custom command documentation?

MonkeyK — Fri, 03 Jan 2020 14:51:21 GMT

Lots of custom commands come with Splunk. 31 in the search app alone.

I often see all of those commands and wonder if there is anything that I could be using. Since I am not an admin on the system, I can't just look at the code to find out.

Is there a place that documents what these commands do and what sort of arguments they expect?

Re: where is the custom command documentation?

richgalloway — Fri, 03 Jan 2020 15:33:19 GMT

All of the commands shipped with the Search & Reporting app are documented in the Search Reference Manual (https://docs.splunk.com/Documentation/Splunk/8.0.1/SearchReference/WhatsInThisManual).

Where are you getting the count of custom commands?

Re: where is the custom command documentation?

MonkeyK — Tue, 07 Jan 2020 16:06:07 GMT

"Settings|Advanced Search"
"Search Commands"
lists the number of commands that are showing.

some of these are clearly common search commands (head, diff). Others I see no documentation on how to use.
For example:
https://docs.splunk.com/Special:SplunkSearch/docs?q=arulespy
https://docs.splunk.com/Special:SplunkSearch/docs?q=createrss
https://docs.splunk.com/Special:SplunkSearch/docs?q=mocknodegraph

Re: where is the custom command documentation?

richgalloway — Thu, 09 Jan 2020 11:58:50 GMT

I don't recognize any of those commands. I suspect they either came with an app or were produced locally. In the case of the former, consult the app docs or the developer; for the latter case, check with the owner.

Re: where is the custom command documentation?

MonkeyK — Thu, 16 Jan 2020 01:56:40 GMT

Well. In the custom commands listing that I described how to find, these commands are listed as part of the search app with an owner of "no owner"

I consulted the app documentation as shown by the links above.

I guess that's why I asked the question that I did.

Re: where is the custom command documentation?

richgalloway — Fri, 17 Jan 2020 13:54:24 GMT

That a command is found in the Search app does not necessarily mean it came with that app. It's easy to add commands and other knowledge objects to the standard apps.

Have you tried looking in the command's script file to see if there are comments or if you can see what the code does?

Re: where is the custom command documentation?

MonkeyK — Tue, 04 Feb 2020 18:01:34 GMT

Where in the UI do I find the command's script file? Where do I see the command ownership info?