icon/x Created with Sketch.

Splunk Cookie Policy

We use our own and third-party cookies to provide you with a great online experience. We also use these cookies to improve our products and services, support our marketing campaigns, and advertise to you on our website and other websites. Some cookies may continue to collect information after you have left our website. Learn more (including how to update your settings) here.
Accept Cookie Policy

We are working on something new...

A Fresh New Splunkbase
We are designing a New Splunkbase to improve search and discoverability of apps. Check out our new and improved features like Categories and Collections. New Splunkbase is currently in preview mode, as it is under active development. We welcome you to navigate New Splunkbase and give us feedback.

Accept License Agreements

This app is provided by a third party and your right to use the app is in accordance with the license provided by that third-party licensor. Splunk is not responsible for any third-party apps and does not provide any warranty or support. If you have any questions, complaints or claims with respect to this app, please contact the licensor directly.

Thank You

Downloading Splunk App for Jenkins
SHA256 checksum (splunk-app-for-jenkins_204.tgz) 5fceab8bc2005735f9339ac60111af6c9c12efc0b216a1f47dfd2ae144205b2e SHA256 checksum (splunk-app-for-jenkins_203.tgz) 6146d492d393fe6d8bfd31fe26cadbf99283bceb8fa4d19ca2531751a2034242 SHA256 checksum (splunk-app-for-jenkins_202.tgz) c8e0f67ba59a20022e1a168e0c69e844593c7222d79e1b18ce5197551c71bd80
To install your download
For instructions specific to your download, click the Details tab after closing this window.

Flag As Inappropriate

splunk

Splunk App for Jenkins

Splunk Labs
This app is NOT supported by Splunk. Please read about what that means for you here.
Overview
Details
Splunk App for Jenkins provides deep insights into your Jenkins master and slave infrastructure, job and build details such as console logs, status, artifacts, and an incredibly efficient way to analyze test results. The app provides out-of-the-box dashboards and search capabilities to enable organizations to run a high performing Jenkins cluster and bring operational intelligence into the software development life cycle.

Splunk App for Jenkins

Splunk App for Jenkins provides deep insights into your Jenkins master and slave infrastructure, job and build details such as console logs, status, artifacts, and an incredibly efficient way to analyze test results. The app provides out-of-the-box dashboards and search capabilities to enable organizations to run a high performing Jenkins cluster and bring operational intelligence into the software development life cycle.

Key Features

  • Different Personas: Enables two modes for different personas. The app nav bar toggles between user mode and admin mode.

  • Admin Feature - Overview: View build status trends and be able to drill down and get details information about any build.
    alt text

  • Admin Feature - Audit Trail: Audit trail feature allows you to see who has logged into your Jenkins system and done any activity like starting/aborting/changing jobs. You can also see what configs have been changed by some user and can view the config xml directly in Splunk. This feature is particularly useful for organization with security and compliance use cases.
    alt text

  • Admin Feature - Jenkins Health: Splunk Jenkins Apps captures Jenkins internal JVM information as well as keys metrics like queue size, executors and slaves stats, Jenkins master logs, and Jenkins slave stats. All this information is captured in real-time, allowing you to quickly discover hard to find issues and fix them before they become a bottleneck for development teams. No more ssh-ing into Jenkins systems to find issues.
    alt text
    alt text
    alt text
    alt text

  • Admin Feature - Jenkins Nodes: Analyze all activity on a particular node. View builds executed on a node, view real-time slave logs, build activity across all slaves, and check connection history to find out unstable Jenkins nodes. This feature is extremely helpful in identifying problematic components in a Jenkins cluster and optimizing your team's throughput.
    alt text
    View the details of one node: Build History, Connection History, Node Log.
    alt text
    alt text

  • Admin Feature - Custom Panel: Build and edit custom dashboards to display a customized view to show all my jenkins job status.
    alt text

  • User Feature - Build Analysis: Easily find any Jenkins build using a variety of easy to use filters. View build summary or drill down to see build status trends, build time and queue time analysis, tests pass/fail trends, test runtime distribution, and console logs couple with Splunk's powerful search interface.
    alt text
    alt text

  • User Feature - Test Analysis: If you are a test engineer and spend countless hours looking at test results in Jenkins, you will love this feature. Test Results shows all the failing tests with stack traces, flags regression failures, groups test failures by errors, captures Jenkin's environment variables, and provides nifty filters to find tests with long run times, particular errors, testsuites, etc.
    alt text

  • User Feature - Job Insights: Display the job status, such as job stage duration, job stage status, stage duration by build number, test status by build and job history.
    alt text
    alt text

Installation

Step 1. Splunk App Installation

Install on a single instance
1. Download the add-on from Splunkbase.
2. From the Splunk Web home screen, click the gear icon next to Apps.
3. Click Install app from file.
4. Locate the downloaded file and click Upload.
5. Restart Splunk
http://docs.splunk.com/Documentation/AddOns/latest/Overview/Singleserverinstall

Install on a search head cluster
Use Splunk Web to deploy it on search headers or use deployer to install it in a search header cluster.
http://docs.splunk.com/Documentation/AddOns/latest/Overview/Distributedinstall

Install on a indexer cluster
copy indexes.conf and props.conf from this App's default folder to $SPLUNK_HOME/etc/master-apps/_cluster/local/ on cluster master, then run "splunk apply cluster-bundle"
http://docs.splunk.com/Documentation/Splunk/6.5.3/Indexer/Updatepeerconfigurations

Step 2. Splunk Jenkins Plugin Installation and Configuration

Splunk App gets all its data from Splunk's plugin for Jenkins.
The Jenkins plugin can be downloaded directly in the Jenkins update center.

Detailed plugin configuration guide can be found here
https://wiki.jenkins-ci.org/display/JENKINS/Splunk+Plugin+for+Jenkins

Configuration for Splunk ITSI Module for Continuous Delivery

Step 1. Define lifecyle_id for your Jenkins data

The Splunk ITSI Module for Continuous Delivery uses the lifecycle_id field to identify which lifecycle is attached to which event. Extraction of the lifecycle_id field depends on each user scenario and user system data capabilities. Some ideas on how to extract lifecycle_id:
1. Lifecycle from release in project management data collector (JIRA)
EVAL-lifecycle_id = fields.fixVersion Example: "Buttercup 1.5"
2. Lifecycle from release in build system (Bamboo, Jenkins)
REPORT-lifecycle_id = lifecycle_id_from_release Example: "Buttercup 1.5"
3. Lifecycle from feature
EVAL-lifecyle_id = branch Example: "feature/foo"
3. Lifecycle from build/test plan, build/test job:
EVAL-lifecyle_id = build_job_plan Example: "UI_TEST_PLAN"
4. Lifecycle from a specific time range
REPORT-lifecycle_id = lifecycle_id_from_timerange Example: "Plan A from 10-01-2016 to 12-31-2016"

Step 2. Check permissions in metadata/default.meta

Make sure you configure configure permissions for prop, transforms, eventtypes, tags,etc. properly.
If you don't care about permission on this app at all, suggested metadata:
[]
export = system

Release Notes

Version 2.0.4
March 11, 2020

Fixed a security related issue by validating user input content in custom panel and app configuration page.

Version 2.0.3
Jan. 14, 2020

This version is compatible with Splunk 8.0, and it is Python 2 and Python 3 compatible.
We also included some fixes for customer reported issue.

Known issue:
When installed on Splunk 7.3 with non-english locale, the dashboard UI will be blank. This is an issue in Splunk web and it is fixed in 8.0 version. If you have a non-english locale with splunk 7.x, please replace the locale part in the url with "en-us", for example, change "zh-cn" to "en-us".

Version 2.0.2
July 26, 2019

Fixed the incompatible issue with Windows.


Subscribe Share

Are you a developer?

As a Splunkbase app developer, you will have access to all Splunk development resources and receive a 10GB license to build an app that will help solve use cases for customers all over the world. Splunkbase has 1000+ apps from Splunk, our partners and our community. Find an app for most any data source and user need, or simply create your own with help from our developer portal.

Follow Us:
Splunk, Splunk>,Turn Data Into Doing, Data-to-Everything, and D2E are trademarks or registered trademarks of Splunk Inc. in the United States and other countries. All other brand names,product names,or trademarks belong to their respective owners.