Getting started with the Splunk SDK for Ruby

The Splunk SDK for Ruby is deprecated. For more information, see Deprecation notice.

So you've met the Splunk® SDK for Ruby... now what?

Get it.

Well, get the SDK, Splunk, and any other requirements. That's it.

From here on out, we're assuming you know a little about using Splunk already, have some data indexed, and maybe saved a search or two. But if you're not there yet and need some more Splunk education, we have you covered:

  • If you want a deeper description of Splunk's features, see the Splunk documentation.
  • Try the Tutorial in the Splunk documentation for a step-by-step walkthrough of using Splunk Web with some sample data.
  • Remember, the Splunk SDKs are built as a layer over the Splunk REST API. While you don't need to know the REST API to use this SDK, you might find it useful to read the REST API Overview or browse the Splunk REST API Reference.

Poke it.

Find out what makes the SDK tick: try it out, play with the examples, and run the unit tests.

You can make things easier by saving your login credentials in the .splunkrc file so you don't have to enter your login info each time you run an example. It's up to you.

Code it.

When you're ready to get your hands dirty, check out the Splunk Developer Application Gallery for inspiration.