diff options
| author | GitLab Bot <gitlab-bot@gitlab.com> | 2023-09-20 14:18:08 +0300 |
|---|---|---|
| committer | GitLab Bot <gitlab-bot@gitlab.com> | 2023-09-20 14:18:08 +0300 |
| commit | 5afcbe03ead9ada87621888a31a62652b10a7e4f (patch) | |
| tree | 9918b67a0d0f0bafa6542e839a8be37adf73102d /tooling/audit_events/docs/templates/audit_event_types.md.erb | |
| parent | c97c0201564848c1f53226fe19d71fdcc472f7d0 (diff) | |
Add latest changes from gitlab-org/gitlab@16-4-stable-eev16.4.0-rc42
Diffstat (limited to 'tooling/audit_events/docs/templates/audit_event_types.md.erb')
| -rw-r--r-- | tooling/audit_events/docs/templates/audit_event_types.md.erb | 18 |
1 files changed, 12 insertions, 6 deletions
diff --git a/tooling/audit_events/docs/templates/audit_event_types.md.erb b/tooling/audit_events/docs/templates/audit_event_types.md.erb index 9376b3c4fcd..429d341f9a6 100644 --- a/tooling/audit_events/docs/templates/audit_event_types.md.erb +++ b/tooling/audit_events/docs/templates/audit_event_types.md.erb @@ -17,18 +17,24 @@ info: "See the Technical Writers assigned to Development Guidelines: https://abo Please do not edit this file directly. To update this file, run: bundle exec rake gitlab:audit_event_types:compile_docs + + To make changes to the output of the rake task, + edit `tooling/audit_events/docs/templates/audit_event_types.md.erb`. ---> -# Audit event types **(ULTIMATE)** +# Audit event types **(PREMIUM ALL)** Audit event types are used to [filter streamed audit events](index.md#update-event-filters). -Every audit event is associated with an event type. The association with the event type can mean that an audit event is: +Every audit event is associated with an event type. Audit event types can allow audit events to be: + +- Saved to the database. Available in the Premium and Ultimate tier. You can retrieve audit events associated with these + types by using the audit events dashboard or the [audit events API](../../api/audit_events.md). +- Streamed to external destinations. Available in the Ultimate tier. You can stream audit events associated with these + types [to external destinations](../index.md) if a destination is set. -- Saved to database. Audit events associated with these types are retrievable by using the audit events dashboard or the [audit events API](../../api/audit_events.md). -- Streamed. Audit events associated with these types are [streamed to external destinations](../index.md) if a - destination is set. -- Not streamed. Audit events associated with these types are not streamed to external destinations even if a destination is set. +Some audit event types don't allow saving audit events to the database. Other audit event types don't allow streaming +audit events to external destinations. ## Available audit event types |