Skip to main content

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.

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. "Enterprise settings" in drop-down menu for profile photo on GitHub Enterprise Server

  2. In the enterprise account sidebar, click Settings. Settings tab in the enterprise account sidebar

  3. Under " Settings", click Audit log. Audit log tab in the enterprise account sidebar

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

    Screenshot of the "Audit Data Retention" tab

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

    Screenshot of the dropdown menu for audit log retention settings

  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 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 "Monitoring storage."

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. "Enterprise settings" in drop-down menu for profile photo on GitHub Enterprise Server

  2. In the enterprise account sidebar, click Settings. Settings tab in the enterprise account sidebar

  3. Under " Settings", click Audit log. Audit log tab in the enterprise account sidebar

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

    Screenshot of the "Audit Data Retention" tab

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

    Screenshot of the checkbox to enable Git events in the audit log

  6. Click Save.