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 Github Modular Input
MD5 checksum (github-modular-input_100.tgz) 19aba0f4fe1357330aa4c569cf4cb9ae
To install your download
For instructions specific to your download, click the Details tab after closing this window.

Flag As Inappropriate

Github Modular Input

Overview
Details
The Github Modular Input uses the Github REST API to pull commit information into Splunk in a convenient JSON format. This data can be used to analyze productivity patterns and can be correlated with data from build servers and production log data to quickly identify the cause of production changes and provide visibility into the entire application delivery cycle.

This app is based on an example from the Splunk Javascript SDK and there is a great blog post by the original author describing its implementation at http://blogs.splunk.com/2014/09/17/new-support-for-authoring-modular-inputs-in-node-js/ .

Install

In general there are two methods for installing apps into Splunk:

  1. Copy this whole github-modinput folder to $SPLUNK_HOME/etc/apps.
  2. Restart Splunk

or

  1. From the App dropdown menu in your Splunk interface, click on "Find More Apps"
  2. Search for "Github Modular Input" and follow the instructions to install.

Adding an input

  1. From Splunk Home, click the Settings menu. Under Data, click Data inputs, and find Github Commits, the input you just added. Click Add new on that row.
  2. Click Add new and fill in:
    • name (whatever name you want to give this input)
    • owner (the owner of the Github repository, this is a Github username or org name)
    • repository (the name of the Github repository)
    • (optional) token if using a private repository and/or to avoid Github's API limits. To get a Github API token visit the Github settings page and make sure the repo and public_repo scopes are selected.
  3. Save your input, and navigate back to Splunk Home.
  4. Do a search for sourcetype=github_commits and you should see some commits indexed, if your repository has a large number of commits indexing them may take a few moments.

Documentation

There is loads of documentation for Splunk, modular inputs, and the Splunk Javascript SDK so please refer to the following links to learn what these tools are, how they work and how you can build your own!

Release Notes

Version 1.0.0
Feb. 2, 2015

Initial Release

17
Installs
340
Downloads
Share Subscribe LOGIN TO DOWNLOAD

Subscribe Share

Splunk Certification Program

Splunk's App Certification program uses a specific set of criteria to evaluate the level of quality, usability and security your app offers to its users. In addition, we evaluate the documentation and support you offer to your app's users.

Are you a developer?

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

Follow Us:
© 2005-2017 Splunk Inc. All rights reserved.
Splunk®, Splunk>®, Listen to Your Data®, The Engine for Machine Data®, Hunk®, Splunk Cloud™, Splunk Light™, SPL™ and Splunk MINT™ are trademarks and 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.