topic Re: Do you have normal documentation? in Training + Certification Discussions

Do you have normal documentation?

snikolaev — Thu, 26 Jul 2018 12:22:54 GMT

Do you have normal documentation? For example I want to know how splunk.Intersplunk.readResults must work, what it return and
etc.? I found http://docs.splunk.com/DocumentationStatic/PythonSDK/1.6.0/index.html, but its about splunklib. Its didn't resolve my problems. I found so many manuals and no one usefull.

Re: Do you have normal documentation?

richgalloway — Thu, 26 Jul 2018 13:14:37 GMT

What do you mean by "normal documentation"?

Many of us believe Splunk has better documentation than a lot of vendors. Sometimes, however, it can be hard to find what you are looking for. Google often works well in that case. See http://docs.splunk.com/Documentation/Splunk/7.1.2/Search/Writeasearchcommand for information about readResults ().

If you find Splunk's documentation lacking, submit feedback at the bottom of an on-line doc page. The Splunk documentation team is great about following up on feedback to make the docs better.

Re: Do you have normal documentation?

snikolaev — Mon, 30 Jul 2018 10:02:39 GMT

I want to apologize for using word "normal", this is not first time my mistake in english. I mean more classical/formal documetation.

Re: Do you have normal documentation?

richgalloway — Mon, 30 Jul 2018 10:38:45 GMT

"Normal" is a fine word to use, but its meaning can change depending on one's point of reference.

All of Splunk's on-line documentation at docs.splunk.com can be downloaded in PDF form. That's probably the closest they have to formal documents.

Re: Do you have normal documentation?

niketn — Tue, 31 Jul 2018 04:26:20 GMT

Besides Splunk Docs you can also refer to dev.splunk.com in case you want to try out working examples:

1) How to create custom search commands using Splunk SDK for Python
2) How to display search results using the Splunk SDK for Python

You should also refer to .Conf 2017 presentation on Extending SPL with Custom Search Commands and the Splunk SDK for Python

And also, Splunk Blogs Series building-custom-search-commands-in-python