• Add a new streaming destination
  • Top-level group streaming destinations
  • Instance streaming destinations
  • Google Cloud Logging streaming
• List streaming destinations
  • For top-level group streaming destinations
  • For instance streaming destinations
  • Google Cloud Logging streaming
• Update streaming destinations
  • Top-level group streaming destinations
  • Instance streaming destinations
  • Google Cloud Logging streaming
• Delete streaming destinations
  • Top-level group streaming destinations
  • Instance streaming destinations
  • Google Cloud Logging streaming
• Verify event authenticity
  • Top-level group streaming destinations
  • Instance streaming destinations
• Event type filters
• Override default content type header
• Payload schema
  • JSON payload schema

Audit event streaming

Users can set a streaming destination for a top-level group or instance to receive all audit events about the group, subgroups, and projects as structured JSON.

Top-level group owners and instance administrators can manage their audit logs in third-party systems. Any service that can receive structured JSON data can be used as the streaming destination.

Each streaming destination can have up to 20 custom HTTP headers included with each streamed event.

Add a new streaming destination

Add a new streaming destination to top-level groups or an entire instance.

Top-level group streaming destinations

Prerequisites:

• Owner role for a top-level group.

To add streaming destinations to a top-level group:

1. On the left sidebar, at the top, select Search GitLab () to find your group.
2. Select Secure > Audit events.
3. On the main area, select Streams tab.
4. Select Add streaming destination and select HTTP endpoint to show the section for adding destinations.
5. Enter the destination URL to add.
6. Optional. Locate the Custom HTTP headers table.
7. Ignore the Active checkbox because it isn’t functional. To track progress on adding functionality to the Active checkbox, see issue 367509.
8. Select Add header to create a new name and value pair. Enter as many name and value pairs as required. You can add up to 20 headers per streaming destination.
9. After all headers have been filled out, select Add to add the new streaming destination.

Instance streaming destinations

Prerequisites:

• Administrator access on the instance.

To add a streaming destination for an instance:

1. On the left sidebar, expand the top-most chevron ().
2. Select Admin Area.
3. On the left sidebar, select Monitoring > Audit Events.
4. On the main area, select Streams tab.
5. Select Add streaming destination and select HTTP endpoint to show the section for adding destinations.
6. Enter the destination URL to add.
7. Optional. To add custom HTTP headers, select Add header to create a new name and value pair, and input their values. Repeat this step for as many name and value pairs are required. You can add up to 20 headers per streaming destination.
8. Ignore the Active checkbox because it isn’t functional. To track progress on adding functionality to the Active checkbox, see issue 367509.
9. Select Add header to create a new name and value pair. Repeat this step for as many name and value pairs are required. You can add up to 20 headers per streaming destination.
10. After all headers have been filled out, select Add to add the new streaming destination.

Google Cloud Logging streaming

Prerequisites:

• Owner role for a top-level group.

To add Google Cloud Logging streaming destinations to a top-level group:

1. On the left sidebar, at the top, select Search GitLab () to find your group.
2. Select Secure > Audit events.
3. On the main area, select Streams tab.
4. Select Add streaming destination and select Google Cloud Logging to show the section for adding destinations.
5. Enter the Google project ID, Google client email, log ID, and Google private key to add.
6. Select Add to add the new streaming destination.

List streaming destinations

List new streaming destinations for top-level groups or an entire instance.

For top-level group streaming destinations

Prerequisites:

• Owner role for a group.

To list the streaming destinations for a top-level group:

1. On the left sidebar, at the top, select Search GitLab () to find your group.
2. Select Secure > Audit events.
3. On the main area, select Streams tab.
4. Select the stream URL to expand it and see all the custom HTTP headers.

For instance streaming destinations

Prerequisites:

• Administrator access on the instance.

To list the streaming destinations for an instance:

1. On the left sidebar, expand the top-most chevron ().
2. Select Admin Area.
3. On the left sidebar, select Monitoring > Audit Events.
4. On the main area, select Streams tab.

Google Cloud Logging streaming

Prerequisites:

• Owner role for a top-level group.

To list Google Cloud Logging streaming destinations for a top-level group:

1. On the left sidebar, at the top, select Search GitLab () to find your group.
2. Select Secure > Audit events.
3. On the main area, select Streams tab.
4. Select the Google Cloud Logging stream to expand and see all the fields.

Update streaming destinations

Update streaming destinations for a top-level group or an entire instance.

Top-level group streaming destinations

Prerequisites:

• Owner role for a group.

To update a streaming destination’s custom HTTP headers:

1. On the left sidebar, at the top, select Search GitLab () to find your group.
2. Select Secure > Audit events.
3. On the main area, select Streams tab.
4. Select the stream URL to expand.
5. Locate the Custom HTTP headers table.
6. Locate the header that you wish to update.
7. Ignore the Active checkbox because it isn’t functional. To track progress on adding functionality to the Active checkbox, see issue 367509.
8. Select Add header to create a new name and value pair. Enter as many name and value pairs as required. You can add up to 20 headers per streaming destination.
9. Select Save to update the streaming destination.

Instance streaming destinations

Prerequisites:

• Administrator access on the instance.

To update the streaming destinations for an instance:

1. On the left sidebar, expand the top-most chevron ().
2. Select Secure > Audit events.
3. On the main area, select the Streams tab.
4. To the right of the item, select Edit ().
5. Locate the Custom HTTP headers table.
6. Locate the header that you wish to update.
7. Ignore the Active checkbox because it isn’t functional. To track progress on adding functionality to the Active checkbox, see issue 367509.
8. Select Add header to create a new name and value pair. Enter as many name and value pairs as required. You can add up to 20 headers per streaming destination.
9. Select Save to update the streaming destination.

Google Cloud Logging streaming

Prerequisites:

• Owner role for a top-level group.

To update Google Cloud Logging streaming destinations to a top-level group:

1. On the left sidebar, at the top, select Search GitLab () to find your group.
2. Select Secure > Audit events.
3. On the main area, select Streams tab.
4. Select the Google Cloud Logging stream to expand.
5. Enter the Google project ID, Google client email, and log ID to update.
6. Select Add a new private key and enter a Google private key to update the private key.
7. Select Save to update the streaming destination.

Delete streaming destinations

Delete streaming destinations for a top-level group or an entire instance. When the last destination is successfully deleted, streaming is disabled for the group or the instance.

Top-level group streaming destinations

Prerequisites:

• Owner role for a group.

To delete a streaming destination:

1. On the left sidebar, at the top, select Search GitLab () to find your group.
2. Select Secure > Audit events.
3. On the main area, select the Streams tab.
4. Select the stream URL to expand.
5. Select Delete destination.
6. Confirm by selecting Delete destination in the modal.

To delete only the custom HTTP headers for a streaming destination:

1. On the left sidebar, at the top, select Search GitLab () to find your group.
2. Select Secure > Audit events.
3. On the main area, select the Streams tab.
4. Select the stream URL to expand.
5. Locate the Custom HTTP headers table.
6. Locate the header that you wish to remove.
7. To the right of the header, select Delete ().
8. Select Save to update the streaming destination.

Instance streaming destinations

Prerequisites:

• Administrator access on the instance.

To delete the streaming destinations for an instance:

1. On the left sidebar, expand the top-most chevron ().
2. Select Admin Area.
3. On the left sidebar, select Monitoring > Audit Events.
4. On the main area, select the Streams tab.
5. Select the stream URL to expand.
6. Select Delete destination.
7. Confirm by selecting Delete destination in the modal.

To delete only the custom HTTP headers for a streaming destination:

1. On the left sidebar, expand the top-most chevron ().
2. Select Admin Area.
3. On the left sidebar, select Monitoring > Audit Events.
4. On the main area, select the Streams tab.
5. To the right of the item, Edit ().
6. Locate the Custom HTTP headers table.
7. Locate the header that you wish to remove.
8. To the right of the header, select Delete ().
9. Select Save to update the streaming destination.

Google Cloud Logging streaming

Prerequisites:

• Owner role for a top-level group.

To delete Google Cloud Logging streaming destinations to a top-level group:

1. On the left sidebar, at the top, select Search GitLab () to find your group.
2. Select Secure > Audit events.
3. On the main area, select the Streams tab.
4. Select the Google Cloud Logging stream to expand.
5. Select Delete destination.
6. Confirm by selecting Delete destination in the modal.

Verify event authenticity

Each streaming destination has a unique verification token (verificationToken) that can be used to verify the authenticity of the event. This token is either specified by the Owner or generated automatically when the event destination is created and cannot be changed.

Each streamed event contains the verification token in the X-Gitlab-Event-Streaming-Token HTTP header that can be verified against the destination’s value when listing streaming destinations.

Top-level group streaming destinations

Prerequisites:

• Owner role for a group.

To list streaming destinations and see the verification tokens:

1. On the left sidebar, at the top, select Search GitLab () to find your group.
2. Select Secure > Audit events.
3. On the main area, select the Streams.
4. Select the stream URL to expand.
5. Locate the Verification token input.

Instance streaming destinations

Prerequisites:

• Administrator access on the instance.

To list streaming destinations for an instance and see the verification tokens:

1. On the left sidebar, expand the top-most chevron ().
2. Select Admin Area.
3. On the left sidebar, select Monitoring > Audit Events.
4. On the main area, select the Streams.
5. View the verification token on the right side of each item.

Event type filters

When this feature is enabled for a group, you can permit users to filter streamed audit events per destination. If the feature is enabled with no filters, the destination receives all audit events.

A streaming destination that has an event type filter set has a filtered () label.

To update a streaming destination’s event filters:

1. On the left sidebar, at the top, select Search GitLab () to find your group.
2. Select Secure > Audit events.
3. On the main area, select the Streams tab.
4. Select the stream URL to expand.
5. Locate the Filter by audit event type dropdown.
6. Select the dropdown list and select or clear the required event types.
7. Select Save to update the event filters.

Override default content type header

By default, streaming destinations use a content-type header of application/x-www-form-urlencoded. However, you might want to set the content-type header to something else. For example ,application/json.

To override the content-type header default value for either a top-level group streaming destination or an instance streaming destination, use either the GitLab UI or using the GraphQL API.

Payload schema

Streamed audit events have a predictable schema in the body of the response.

JSON payload schema

{
  "properties": {
    "id": {
      "type": "string"
    },
    "author_id": {
      "type": "integer"
    },
    "author_name": {
      "type": "string"
    },
    "details": {},
    "ip_address": {
      "type": "string"
    },
    "entity_id": {
      "type": "integer"
    },
    "entity_path": {
      "type": "string"
    },
    "entity_type": {
      "type": "string"
    },
    "event_type": {
      "type": "string"
    },
    "target_id": {
      "type": "integer"
    },
    "target_type": {
      "type": "string"
    },
    "target_details": {
      "type": "string"
    },
  },
  "type": "object"
}