Skip to content
This repository

Splunk app for archive management, including HDFS support.

README.md

Shuttl - Archiving for Splunk

Splunk is the premier technology for gaining Operational Intelligence on Machine Data. Since it can handle large volume of data at a fast rate, often times users will only want to analyze recent data, and data that is beyond a certain range is archived.

Splunk provides hooks for allowing the administrator to designate archiving policies and actions. However, the actions are entirely implemented by the administrator of the system.

Shuttl provides a full-lifecycle solution for data in Splunk.

It can:

  • Manage the transfer of data from Splunk to an archive system
  • Enable an administrator to inventory/search the archive
  • Allow an administrator to selectively restore archived data into "thawed"
  • Remove archived data from thawed

Shuttl support on the following systems back-end systems for storage:

  • Attached storage
  • HDFS
  • S3 and S3n
  • Amazon Glacier

License

Shuttl is licensed under the Apache License 2.0. Details can be found in the LICENSE file.

Shuttl is an unsupported community open source project and therefore is subject to being incomplete and containing bugs.

The Apache License only applies to Shuttl and no other Splunk software is implied.

Splunk, in using the Apache License, does not provide any warranties or indemnification, and does not accept any liabilities with the use of Shuttl.

We are now accepting contributions from individuals and companies to our Splunk open source projects.

Prerequisites

Splunk

Currently the Splunk version used is 5.0.1. Shuttl has support for Splunk Clustering.

You can download it Splunk. And see the Splunk documentation for instructions on installing and more.

Java

  • Java JDK 6

Hadoop (optional)

This is needed if you are using HDFS. Currently the Hadoop version used is 1.1.1

You can download it from one of the mirror sites. And see the Hadoop documentation for instructions on installing and more.

Development

Eclipse Users

You'll need to build once, before you can use Eclipse This .eclipse.templates directory contains templates for generating Eclipse files to configure Eclipse for shuttl development.

Coding Conventions

The Shuttl code base is to follow the standard java conventions except for using braces for all for-loops, if-statements etc. We try to not use braces to avoid too much indentation. We rely on having tests to catch any mistake done by forgetting braces, when having more than one line after an if-statement or for-loop.

The standard java conventions can be found here: http://java.sun.com/docs/codeconv/html/CodeConvTOC.doc.html

Getting Started

Ensure that:

  • JAVA_HOME environment variable is defined correctly
  • Make sure that you can run ssh localhost without having to enter a password
  • Make sure you have a tgz package of Splunk in the directory put-splunk-tgz-here (not needed if you are using your own Splunk instance, see below)

Build shuttl:

$ ./buildit.sh

Run the tests:

$ ./testit.sh

How to Setup Passphraseless SSH

Here's how you setup passphraseless ssh: http://hadoop.apache.org/common/docs/current/single_node_setup.html#Setup+passphraseless

Test configuration

Create a file called build.properties

Copy the contents from default.properties to build.properties and edit the values you want to change

Installing the app

Here's how to install the Shuttl app in your Splunk instance. Shuttl comes with some pre-configured values that you might need to modify.

Install

  1. Build the app by running ant dist
  2. Extract the build/shuttl.tgz in your $SPLUNK_HOME/etc/apps/
  3. While Splunk is not running, configure Shuttl and Splunk as mentioned below
  4. Start Splunk up, and enable the Shuttl App via the Manager
  5. If the index is getting data, and calling the archiver, then you should see the data in HDFS

Shuttl Configuration (new)

There are three configuration files that you might care about. One for archiving, one for Splunk and one for the Shuttl server. They all live in the shuttl/conf directory. All the values are populated with default values to serve as an example.

In addition to these configuration files, there are property files for the backends. These live in shuttl/conf/backend directory. These need to be configured as well depending on the backendName you choose.

archiver.xml:

  • localArchiverDir: A local path (or an uri with file:/ schema) where shuttl's archiver's temporary transfer data, locks, metadata, etc. is stored.
  • backendName: The of the backend you want to use. Currently supports: local, hdfs, s3, s3n and glacier.
  • archivePath: The absolute path in the archive where your files will be stored. Required for all backends.
  • clusterName: Unique name for your Splunk cluster. Use the default if you don't care to name your cluster for each Shuttl installation. Note, this is only a Shuttl concept for a group of Splunk indexers that should be treated as a cluster. Splunk does not have this notion.
  • serverName: This is the Splunk Server Name. Check Splunk Manager for that server to populate this value. Must be unique per Shuttl installation.
  • archiveFormats: The formats to archive the data as. The current available formats are SPLUNK_BUCKET, CSV and SPLUNK_BUCKET_TGZ. You can configure Shuttl to archive your data as all formats at the same time, which you can use for different use cases.
  • Warning: The old archiverRootURI is deprecated. It will still work for right now, but we recommend that you use the new configuration with property files instead.

server.xml:

  • httpHost: The host name of the machine. (usually localhost)
  • httpPort: The port for the shuttl server. (usually 9090)

splunk.xml:

  • host: The host name for the splunk instance where Shuttl is installed. Should be localhost
  • port: The management port for the splunk server. (Splunk defaults to 8089)
  • username: Splunk username
  • password: Splunk password

backend/hdfs.properties (required for hdfs.):

  • hadoop.host: The host name to the hdfs name node.
  • hadoop.port: The port to the hdfs name node.

backend/amazon.properties (required for s3, s3n or glacier)

  • aws.id: Your Amazon Web Services ID
  • aws.secret: Your Amazon Web Services secret
  • s3.bucket: Bucket name for storage in s3
  • glacier.vault: The vault name for storage in glacier.
  • glacier.endpoint: The server endpoint to where the data will be stored. (i.e. https://glacier.us-east-1.amazonaws.com/)
  • Note: The glacier backend currently uses both glacier and s3, so s3.bucket is still required when using glacier. This is also the reason why archivePath is always required.

Note, the directory that the data will be archived to is [archivePath]/archive_data/[clusterName]/[serverName]/[indexName]

Splunk Index Configuration

In addition, you need to configure Splunk to call the archiver script (setting the coldToFrozenScript and/or warmToColdScript) for each index that is being archived. You can do this by creating an indexes.conf file in $SPLUNK_HOME/etc/apps/shuttl/local with the appropriate config stanzas. An example is as follows:

[mytest]
homePath = $SPLUNK_DB/mytest/db
coldPath = $SPLUNK_DB/mytest/colddb
thawedPath = $SPLUNK_DB/mytest/thaweddb
rotatePeriodInSecs = 10
frozenTimePeriodInSecs = 120
maxWarmDBCount = 1
warmToColdScript = $SPLUNK_HOME/etc/apps/shuttl/bin/warmToColdScript.sh
coldToFrozenScript = $SPLUNK_HOME/etc/apps/shuttl/bin/coldToFrozenScript.sh

WARNING: the settings rotatePeriodInSecs, frozenTimePeriodInSecs, maxWarmDBCount are there only for testing to verify that data can be successfully transfered by inducing rapid bucket rolling. Don't use in production. See Set a retirement and archiving policy and Indexes.conf documentation to suit your test and deployment needs. Expected usage in production is that maxDataSize correspond to a HDFS block or larger (splunk default is 750mb), and maxHotIdleSecs should be set to 86400 for buckets approximately 24hrs worth of data.

Other developer notes

Specifying which Hadoop version to run tests with

In your build.properties, set the property hadoop.version to the version you want to run

Now run:

$ `ant clean-all`
$ `ant test-all`
Something went wrong with that request. Please try again.