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:
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.
github_sourceis 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.
github_webhooksis 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.
github_collectdis the macro used for all collectd metrics sent from Github Enterprise Server. Please update accordingly.
Out of the box, there are a few categories of dashboards available:
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.
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".
Workflow Analyticstab by @rajbos in https://github.com/splunk/github_app_for_splunk/pull/30
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.
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.