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.
Log4Shell Vulnerability: Information and guidance for you. Get resources.

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 App for Splunk
SHA256 checksum (github-app-for-splunk_120.tgz) 845fe2049079b2f33c44ac2cb73896aa285fc6fdbb63944d2c2726d9b23895d6 SHA256 checksum (github-app-for-splunk_112.tgz) 0a4bc3657e0680f4ab73df43a7b9260c822d385cb941fa167c4af3ccee26e32a SHA256 checksum (github-app-for-splunk_111.tgz) a2ae03b73c13144b470c903394f087ba0aaede0cdb53c326e3b31853d980e76a SHA256 checksum (github-app-for-splunk_102.tgz) 9a953a2bcc275f5436dfa6dbb779ab138c188127bbba10bcb79b9e6d304288b9
To install your download
For instructions specific to your download, click the Details tab after closing this window.

Flag As Inappropriate

splunk

GitHub App for Splunk

Splunk Cloud
Splunk Labs
Overview
Details
The Github App for Splunk is a collection of out of the box dashboards and Splunk knowledge objects designed to give Github Admins and platform owners immediate visibility into Github.

This App is designed to work across multiple Github data sources however not all all required. You may choose to only collect a certain set of data and the parts of this app that utilize that set will function, while those that use other data sources will not function correctly, so please only use the Dashboards that relate to the data you are collecting.

The Github App for Splunk is designed to work with the following data sources:

* Github Audit Log Monitoring Add-On For Splunk: Audit logs from Github Enterprise Cloud.
* Github.com Webhooks: A select set of webhook events like Push, PullRequest, and Repo.
* Github Enterprise Server Syslog Forwarder: Audit and Application logs from Github Enterprise Server.
* Github Enterprise Collectd monitoring: Performance and Infrastructure metrics from Github Enterprise Server.

Github App for Splunk

The Github App for Splunk is a collection of out of the box dashboards and Splunk knowledge objects designed to give Github Admins and platform owners immediate visibility into Github.

This App is designed to work across multiple Github data sources however not all all required. You may choose to only collect a certain set of data and the parts of this app that utilize that set will function, while those that use other data sources will not function correctly, so please only use the Dashboards that relate to the data you are collecting.

The Github App for Splunk is designed to work with the following data sources:

Dashboard Instructions

Installation

For Splunk Cloud, refer to Install apps in your Splunk Cloud deployment. For non-Splunk Cloud deployments, refer to the standard methods for Splunk Add-on installs as documented for a Single Server Install or a Distributed Environment Install.

This app should be installed on both your search head tier as well as your indexer tier.

Configuration

  1. The Github App for Splunk uses macros so that index and sourcetype names don't need to be updated in each dashboard panel. You'll need to update the macros to account for your selected indexes.
  2. The macro github_source is the macro for all audit log events, whether from Github Enterprise Cloud or Server. The predefined maco includes examples of BOTH. Update to account for your specific needs.
  3. The macro github_webhooks is the macro used for all webhook events. Since it is assuming a single index for all webhook events, that is the predefined example, but update as needed.
  4. Finally, the macro github_collectd is the macro used for all collectd metrics sent from Github Enterprise Server. Please update accordingly.

Dashboard Usage

Out of the box, there are a few categories of dashboards available:

  1. Enterprise Server Monitor - A set of dashboards to monitor GitHub Enterprise Server infrastructure metrics.
  2. Audit - A set of dashboards that report on Audit logs events from both GitHub Enterprise Cloud and GitHub Enterprise Server.
  3. Add-On Monitoring - Listed on the Dashboards page is a dashboard called Integration Monitoring that is used to keep an eye on how the Github Audit Log Monitoring Add-On for Splunk is working. This is only useful if you are using that Add-On and also requires access to Splunk _internal logs.

Support

Support for Github App for Splunk is run through Github Issues. Please open a new issue for any support issues or for feature requests. You may also open a Pull Request if you'd like to contribute additional dashboards, eventtypes for webhooks, or enhancements you may have.

Release Notes

Version 1.2.0
March 21, 2022

Major Additions for GitHub Workflows

This update includes some quality of life enhancements, but the big changes are around GitHub Workflows. There are two new Dashboards that show Workflow runs and even let you drill down to get specific details about the Workflow like trends for that workflow, triggers, and even Workflow Logs (if you are using the Splunk GitHub Workflow Log Forwarder Action). To see these in action, use the "Developer Insights" drop down and check out "Workflow Analysis". Because of this, the previously existing "Workflow Analytics" has been renamed "Workflow Overview".

What's Changed

New Contributors

Version 1.1.2
Jan. 31, 2022

What's Changed

New Contributors

Full Changelog: https://github.com/splunk/github_app_for_splunk/compare/v1.1.0...v1.1.2

Version 1.1.1
Jan. 12, 2022

What's Changed

New Contributors

Full Changelog: https://github.com/splunk/github_app_for_splunk/compare/v1.1.0...v1.1.1

Version 1.0.2
July 26, 2021

Minor updates to address a few items:

Update dashboards to include version declaration in the root nodes. This is required for JQuery updates on Splunk Cloud
New sourcetype github_audit for use by GitHub Audit Log Streaming
New EventTypes for GitHub Issues and Project webhooks
Fix order of dashboards in the GitHub Enterprise Server navigation dropdown.


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.