Hardware and software requirements for the Splunk Add-on for GitHub¶
Prerequisites:
GitHub Enterprise Server (GHES) installed on a system with log monitoring/forwarding enabled. Splunk connect for Syslog (SC4S) installed and configured with default settings.
Splunk Add-on for GitHub uses KVStore Service in data collection from GitHub Cloud, so KVStore must be up and running
Splunk admin requirements¶
To install and configure the Splunk Add-on for GitHub, you must be a member of the admin or sc_admin role.
Python requirements¶
This add-on requires Splunk Enterprise 9.3 or later and supports its Python 3.9 and Python 3.13 runtimes. Python 3.7 is no longer supported.
Splunk Enterprise bundles Python internally — the version depends on the Splunk release:
| Splunk Enterprise version | Bundled Python |
|---|---|
| 9.0.x | Python 3.7 (not supported) |
| 9.1.x | Python 3.7 (not supported) |
| 9.2.x | Python 3.7 (not supported) |
| 9.3.x+ | Python 3.9 |
On Splunk Enterprise versions earlier than 9.3, the runtime guard prevents inputs and REST handlers from running under Python 3.7 and produces the following error in $SPLUNK_HOME/var/log/splunk/splunkd.log:
RuntimeError: Splunk Add-on for GitHub requires Python 3.9 or later (running 3.7.x). Upgrade Splunk Enterprise to 9.3 or later.
To resolve this, upgrade Splunk Enterprise to version 9.3 or later.
To verify the Python version check locally before deploying, run the following from the root of the repository:
docker run --rm -v "$(pwd)/package:/app" python:3.7-slim \
python /app/bin/github_audit_input.py
This simulates running the add-on under Python 3.7 and should produce the error above, confirming the guard is working correctly.
Splunk platform requirements¶
Because this add-on runs on the Splunk platform, all of the system requirements apply for the Splunk software that you use to run this add-on.
- For Splunk Enterprise system requirements: see System Requirements in the Splunk Enterprise Installation Manual.
- If you are managing on-premises forwarders to get data into Splunk Cloud, see System Requirements in the Splunk Enterprise Installation Manual, which includes information about forwarders.