blob: 429d341f9a6345f097fde5761a81b78e953a8958 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
|
<% all_audit_event_types = Gitlab::Audit::Type::Definition.definitions.map(&:last) %>
<% def boolean_to_docs(boolean) %>
<% if boolean %>
<% "**{check-circle}** Yes" %>
<% else %>
<% "**{dotted-circle}** No" %>
<% end %>
<% end %>
---
stage: Govern
group: Compliance
info: "See the Technical Writers assigned to Development Guidelines: https://about.gitlab.com/handbook/product/ux/technical-writing/#assignments-to-development-guidelines"
---
<!---
This documentation is auto generated by a Rake task.
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 **(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. 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.
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
| Name | Description | Saved to database | Streamed | Feature category | Introduced in |
|:-----|:------------|:------------------|:---------|:-----------------|:--------------|
<% all_audit_event_types.each do |event_type| %>| <%= "[`#{event_type.name}`](#{event_type.introduced_by_mr})" %> | <%= event_type.description %> | <%= boolean_to_docs(event_type.saved_to_database) %> | <%= boolean_to_docs(event_type.streamed) %> | <%= "`#{event_type.feature_category}`" %> | GitLab <%= "[#{event_type.milestone}](#{event_type.introduced_by_issue})" %> |
<% end %>
|
