Ready to get started?

Download a free trial of the Splunk Driver to get started:

 Download Now

Learn more:

Splunk Icon Splunk JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with Splunk data including Datamodels, Datasets, SearchJobs, and more!

Connect to Splunk Data in JRuby



Create a simple JRuby app with access to live Splunk data.

JRuby is a high-performance, stable, fully threaded Java implementation of the Ruby programming language. The CData JDBC Driver for Splunk makes it easy to integrate connectivity to live Splunk data in JRuby. This article shows how to create a simple JRuby app that connects to Splunk data, executes a query, and displays the results.

Configure a JDBC Connection to Splunk Data

Before creating the app, note the installation location for the JAR file for the JDBC Driver (typically C:\Program Files\CData\CData JDBC Driver for Splunk\lib).

JRuby natively supports JDBC, so you can easily connect to Splunk and execute SQL queries. Initialize the JDBC connection with the getConnection function of the java.sql.DriverManager class.

To authenticate requests, set the User, Password, and URL properties to valid Splunk credentials. The port on which the requests are made to Splunk is port 8089.

The data provider uses plain-text authentication by default, since the data provider attempts to negotiate TLS/SSL with the server.

If you need to manually configure TLS/SSL, see Getting Started -> Advanced Settings in the data provider help documentation.

Built-in Connection String Designer

For assistance in constructing the JDBC URL, use the connection string designer built into the Splunk JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

java -jar cdata.jdbc.splunk.jar

Fill in the connection properties and copy the connection string to the clipboard.

Below is a typical JDBC connection string for Splunk:

jdbc:splunk:user=MyUserName;password=MyPassword;URL=MyURL;InitiateOAuth=GETANDREFRESH

Create a JRuby App with Connectivity to Splunk Data

Create a new Ruby file (for example: SplunkSelect.rb) and open it in a text editor. Copy the following code into your file:

require 'java' require 'rubygems' require 'C:/Program Files/CData/CData JDBC Driver for Splunk 2018/lib/cdata.jdbc.splunk.jar' url = "jdbc:splunk:user=MyUserName;password=MyPassword;URL=MyURL;InitiateOAuth=GETANDREFRESH" conn = java.sql.DriverManager.getConnection(url) stmt = conn.createStatement rs = stmt.executeQuery("SELECT Name, Owner FROM DataModels") while (rs.next) do puts rs.getString(1) + ' ' + rs.getString(2) end

With the file completed, you are ready to display your Splunk data with JRuby. To do so, simply run your file from the command line:

jruby -S SplunkSelect.rb

Writing SQL-92 queries to Splunk allows you to quickly and easily incorporate Splunk data into your own JRuby applications. Download a free trial today!