Configuring the audit log for your enterprise

You can configure settings for your enterprise's audit log.

Who can use this feature?

Enterprise owners can configure the audit log.

In this article

About audit log configuration

You can configure a retention period for audit log data and see index storage details.

After you configure a retention period, you can enable or disable Git-related events from appearing in the audit log.

Configuring a retention period for audit log data

You can configure a retention period for audit log data for your GitHub Enterprise Server instance. Data that exceeds the period you configure will be permanently removed from disk.

  1. In the top-right corner of GitHub Enterprise Server, click your profile photo, then click Enterprise settings.

    Screenshot of the drop-down menu that appears when you click the profile photo on GitHub Enterprise Server. The "Enterprise settings" option is highlighted in a dark orange outline.

  2. On the left side of the page, in the enterprise account sidebar, click Settings.

  3. Under " Settings", click Audit log.

  4. Under "Audit log", click Audit Data Retention.

  5. Under "Configure audit log retention settings", select the dropdown menu and click a retention period.

  6. Click Save.

Managing Git events in the audit log

You can enable or disable Git-related events, such as git.clone and git.push, from appearing in your audit log. For a list of the Git events are logged, see Audit log events for your enterprise.

If you do enable Git events, due to the large number of Git events that are logged, we recommend monitoring your instance's file storage and reviewing your related alert configurations. For more information, see Recommended alert thresholds.

Before you can enable Git events in the audit log, you must configure a retention period for audit log data other than "infinite." For more information, see Configuring a retention period for audit log data.

Note

Git events are not included in search results.

  1. In the top-right corner of GitHub Enterprise Server, click your profile photo, then click Enterprise settings.

    Screenshot of the drop-down menu that appears when you click the profile photo on GitHub Enterprise Server. The "Enterprise settings" option is highlighted in a dark orange outline.

  2. On the left side of the page, in the enterprise account sidebar, click Settings.

  3. Under " Settings", click Audit log.

  4. Under "Audit log", click Audit Data Retention.

  5. Under "Git event opt-in", select or deselect Enable git events in the audit-log.

    Note

    The retention policy must be set to something other than infinite for this option to display.

    Screenshot of the audit log. The checkbox to enable Git events in the audit log is highlighted with an orange outline.

  6. Click Save.