Splunk Search

How can you add help to a custom search command?

Marinus
Communicator

How can you add help to a custom search command?

Tags (1)
1 Solution

bwooden
Splunk Employee
Splunk Employee

To create a search-assistant or type-ahead...

I sneak a look at the searchbnf.conf.spec.

Then I create (or append) $SPLUNK_HOME/etc/system/local/searchbnf.conf (often leveraging the searchbnf.conf.example as a guide).

View solution in original post

bwooden
Splunk Employee
Splunk Employee

To create a search-assistant or type-ahead...

I sneak a look at the searchbnf.conf.spec.

Then I create (or append) $SPLUNK_HOME/etc/system/local/searchbnf.conf (often leveraging the searchbnf.conf.example as a guide).

carasso
Splunk Employee
Splunk Employee

If your custom search command is in an app, you should also put the searchbnf.conf in the app as well.

0 Karma

aovsiannikov
Explorer

Is it possible to auto generate searchbnf.conf from command class docstring? Are there any util for this?

0 Karma

Marinus
Communicator

When you enter a command in the search interface it gives you online help for the command, including examples. I'd like to do the same for a custom command.

0 Karma

hbazan
Path Finder

What do you mean by "help", do you want to explain what's in the results? we've used a csv input table for something like that, and then a join, so each file has a new column with the appropriate explanation of each value.

0 Karma
Get Updates on the Splunk Community!

See just what you’ve been missing | Observability tracks at Splunk University

Looking to sharpen your observability skills so you can better understand how to collect and analyze data from ...

Weezer at .conf25? Say it ain’t so!

Hello Splunkers, The countdown to .conf25 is on-and we've just turned up the volume! We're thrilled to ...

How SC4S Makes Suricata Logs Ingestion Simple

Network security monitoring has become increasingly critical for organizations of all sizes. Splunk has ...