Installation

What are Splunkit usage steps?

swatishs
Explorer

I have been rummaging around for some documentation of how to use Splunkit. Can someone point me to some documentation for the same or please elaborate the steps to do performance testing using Splunkit. I am using Splunk version 7.2.3.

Tags (2)
0 Karma
1 Solution

nickhills
Ultra Champion

From the quickstart guide in the package:

// SplunkIt 3.2 (build 207544)
//
// Copyright(c) 2014 Splunk Inc
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.


SplunkIt Performance Test Kit - QuickStart Guide

NOTE: Please refer to the INSTALL file for detailed steps; this guide is only
      a reference for users already familiar with SplunkIt.

NOTE: This is not a Splunk app (and does not follow typical app installations)


I. SETUP

  (1) splunkit-server

    a.  How to Install:

        * Unzip splunkit-server.zip on the same machine as your Splunk
          instance, outside of the Splunk installation directory
        * Set SPLUNK_HOME and server_host in pyro.properties

    b.  System Requirements:

        * Linux, MacOS, or Windows
        * Python 2.6+
        * TCP ports 8000, 8080, 8081, 8089 opened
        * Minimum 75GB free disk space for splunkit-server
        * Minumum 75GB free disk space for Splunk instance
        * Running Splunk 4.1 - 5.x

  (2) splunkit-user

    a.  How to Install:

        * Unzip splunkit-user.zip on a remote machine
        * Set server_host in pyro.properties; this value must match
          the server_host field in splunkit-server/pyro.properties

    b.  System Requirements:

        * Linux, MacOS, or Windows
        * Python 2.6+
        * Firefox 4 - Firefox 21 (must added to system path)
        * Some X server if using a headless machine, e.g. Xvfb
          (must be running)
        * Network connectivity to splunkit-server / Splunk machine



II. INDEX TEST

  (1) Install splunkit-server on the same machine as the Splunk instance
      (see SETUP above)

  (2) Generate the static data file

    a.  Run in terminal from splunkit-server directory:

        python bin/gendata.py

  (3) Index the generated data

    a.  Run in terminal from splunkit-server directory:

        python bin/indextest.py



III. SEARCH TEST

  (1) Install splunkit-server and splunkit-user, if not done already
      (see SETUP above)

  (2) Start splunkit-user

    a.  Start Xvfb if needed; e.g. "nohup Xvfb :1 &" will run using display :1

    b.  Run in terminal from splunkit-user directory
        (NOTE: set DISPLAY if/as needed):

        export DISPLAY=:1; python bin/searchtest.py

  (3) Start splunkit-server

    a.  Run in terminal from splunkit-server directory:

        python bin/searchtest.py

  (4) Run Search Test

    a.  Test will start automatically when both the user and server start

    b.  Both the server and user will report completion in the terminal

  (5) Verify Results

    a.  From SplunkWeb, view both of the 'SplunkIt Results' dashboards
If my comment helps, please give it a thumbs up!

View solution in original post

0 Karma

nickhills
Ultra Champion

From the quickstart guide in the package:

// SplunkIt 3.2 (build 207544)
//
// Copyright(c) 2014 Splunk Inc
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.


SplunkIt Performance Test Kit - QuickStart Guide

NOTE: Please refer to the INSTALL file for detailed steps; this guide is only
      a reference for users already familiar with SplunkIt.

NOTE: This is not a Splunk app (and does not follow typical app installations)


I. SETUP

  (1) splunkit-server

    a.  How to Install:

        * Unzip splunkit-server.zip on the same machine as your Splunk
          instance, outside of the Splunk installation directory
        * Set SPLUNK_HOME and server_host in pyro.properties

    b.  System Requirements:

        * Linux, MacOS, or Windows
        * Python 2.6+
        * TCP ports 8000, 8080, 8081, 8089 opened
        * Minimum 75GB free disk space for splunkit-server
        * Minumum 75GB free disk space for Splunk instance
        * Running Splunk 4.1 - 5.x

  (2) splunkit-user

    a.  How to Install:

        * Unzip splunkit-user.zip on a remote machine
        * Set server_host in pyro.properties; this value must match
          the server_host field in splunkit-server/pyro.properties

    b.  System Requirements:

        * Linux, MacOS, or Windows
        * Python 2.6+
        * Firefox 4 - Firefox 21 (must added to system path)
        * Some X server if using a headless machine, e.g. Xvfb
          (must be running)
        * Network connectivity to splunkit-server / Splunk machine



II. INDEX TEST

  (1) Install splunkit-server on the same machine as the Splunk instance
      (see SETUP above)

  (2) Generate the static data file

    a.  Run in terminal from splunkit-server directory:

        python bin/gendata.py

  (3) Index the generated data

    a.  Run in terminal from splunkit-server directory:

        python bin/indextest.py



III. SEARCH TEST

  (1) Install splunkit-server and splunkit-user, if not done already
      (see SETUP above)

  (2) Start splunkit-user

    a.  Start Xvfb if needed; e.g. "nohup Xvfb :1 &" will run using display :1

    b.  Run in terminal from splunkit-user directory
        (NOTE: set DISPLAY if/as needed):

        export DISPLAY=:1; python bin/searchtest.py

  (3) Start splunkit-server

    a.  Run in terminal from splunkit-server directory:

        python bin/searchtest.py

  (4) Run Search Test

    a.  Test will start automatically when both the user and server start

    b.  Both the server and user will report completion in the terminal

  (5) Verify Results

    a.  From SplunkWeb, view both of the 'SplunkIt Results' dashboards
If my comment helps, please give it a thumbs up!

View solution in original post

0 Karma
Register for .conf21 Now! Go Vegas or Go Virtual!

How will you .conf21? You decide! Go in-person in Las Vegas, 10/18-10/21, or go online with .conf21 Virtual, 10/19-10/20.