collectd is a service that runs on your GitHub Enterprise Server instance to gather and provide metrics about the system's performance. Common metrics that
collectd gathers includes CPU utilization, memory and disk consumption, network interface traffic and errors, and a system's overall load. You can also forward the data to another
collectd server. For more information see the collectd wiki.
Your instance uses metrics from
collectd to display graphs in the Management Console's monitor dashboard. For more information, see "Accessing the monitor dashboard."
You can review a list of the metrics that
collectd gathers on your GitHub Enterprise Server instance. For more information, see "collectd metrics for GitHub Enterprise Server."
If you haven't already set up an external
collectd server, you will need to do so before enabling
collectd forwarding on your GitHub Enterprise Server instance. Your
collectd server must be running
collectd version 5.x or higher.
- Log into your
- Create or edit the
collectdconfiguration file to load the network plugin and populate the server and port directives with the proper values. On most distributions, this is located at
An example collectd.conf to run a
Listen "0.0.0.0" "25826"
collectd forwarding is disabled on GitHub Enterprise. Follow the steps below to enable and configure
From an administrative account on GitHub Enterprise Server, in the upper-right corner of any page, click .
If you're not already on the "Site admin" page, in the upper-left corner, click Site admin.
In the " Site admin" sidebar, click Management Console.
Below the log forwarding settings, select Enable collectd forwarding.
In the Server address field, type the address of the
collectdserver to which you'd like to forward GitHub Enterprise appliance statistics.
In the Port field, type the port used to connect to the
collectdserver. (Defaults to 25826)
In the Cryptographic setup dropdown menu, select the security level of communications with the
collectdserver. (None, signed packets, or encrypted packets.)
Under the "Settings" sidebar, click Save settings.
Note: Saving settings in the Management Console restarts system services, which could result in user-visible downtime.
Wait for the configuration run to complete.
The command-line tool
ghe-export-graphs will export the data that
collectd stores in RRD databases. This command turns the data into XML and exports it into a single tarball (
Its primary use is to provide the GitHub Enterprise Support team with data about a VM's performance, without the need for downloading a full Support Bundle. It shouldn't be included in your regular backup exports and there is no import counterpart. If you contact us through GitHub Enterprise Support, we may ask for this data to assist with troubleshooting.
ssh -p 122 admin@[hostname] -- 'ghe-export-graphs' && scp -P 122 admin@[hostname]:~/graphs.tar.gz .
GitHub Enterprise ships with
collectd version 5.x.
collectd 5.x is not backwards compatible with the 4.x release series. Your central
collectd server needs to be at least version 5.x to accept data sent from your GitHub Enterprise Server instance.
For help with further questions or issues, visit GitHub Enterprise Support.