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

Flag As Inappropriate

splunk

Github Modular Input

This app has been archived. Learn more about app archiving.
This app is NOT supported by Splunk. Please read about what that means for you here.
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


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.