Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
G
gitlab-ce
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
1
Merge Requests
1
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
nexedi
gitlab-ce
Commits
2ca2aee8
Commit
2ca2aee8
authored
Sep 17, 2020
by
Tan Le
Committed by
Mike Jang
Sep 17, 2020
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Add documentation for Audit Log CSV report feature
parent
33a8820a
Changes
3
Hide whitespace changes
Inline
Side-by-side
Showing
3 changed files
with
75 additions
and
5 deletions
+75
-5
doc/administration/audit_events.md
doc/administration/audit_events.md
+74
-1
doc/administration/audit_reports.md
doc/administration/audit_reports.md
+1
-4
doc/administration/img/export_audit_log_v13_4.png
doc/administration/img/export_audit_log_v13_4.png
+0
-0
No files found.
doc/administration/audit_events.md
View file @
2ca2aee8
...
...
@@ -172,4 +172,77 @@ the steps bellow.
```
ruby
Feature
.
enable
(
:repository_push_audit_event
)
```
## Export to CSV **(PREMIUM ONLY)**
>
-
[
Introduced
](
https
:/
/
gitlab
.
com
/
gitlab
-
org
/
gitlab
/-
/issues/
1449
)
in
[
GitLab
Premium
](
https
:/
/
about
.
gitlab
.
com
/
pricing
/
)
13.4
.
>
-
It
'
s
[
deployed
behind
a
feature
flag
](
..
/user/
feature_flags
.
md
),
disabled
by
default
.
>
-
It
'
s
disabled
on
GitLab
.
com
.
>
-
It
'
s
not
recommended
for
production
use
.
>
-
To
use
it
in
GitLab
self
-
managed
instances
,
ask
a
GitLab
administrator
to
[
enable
it
](
#enable-or-disable-audit-log-export-to-csv). **(PREMIUM ONLY)**
CAUTION
:
**
Warning
:**
This
feature
might
not
be
available
to
you
.
Check
the
**
version
history
**
note
above
for
details
.
Export
to
CSV
allows
customers
to
export
the
current
filter
view
of
your
audit
log
as
a
CSV
file
,
which
stores
tabular
data
in
plain
text
.
The
data
provides
a
comprehensive
view
with
respect
to
audit
events
.
To
export
the
Audit
Log
to
CSV
,
navigate
to
**
{
monitor
}
**
**
Admin
Area
>
Monitoring
>
Audit
Log
**
1
.
Click
in
the
field
**
Search
**.
1
.
In
the
dropdown
menu
that
appears
,
select
the
event
type
that
you
want
to
filter
by
.
1
.
Select
the
preferred
date
range
.
1
.
Click
**
Export
as
CSV
**.
!
[
Export
Audit
Log
](
img
/
export_audit_log_v13_4
.
png
)
### Sort
Exported
events
are
always
sorted
by
`ID`
in
ascending
order
.
### Format
Data
is
encoded
with
a
comma
as
the
column
delimiter
,
with
`"`
used
to
quote
fields
if
needed
,
and
newlines
to
separate
rows
.
The
first
row
contains
the
headers
,
which
are
listed
in
the
following
table
along
with
a
description
of
the
values:
|
Column
|
Description
|
|---------|-------------|
|
ID
|
Audit
event
`id`
|
|
Author
ID
|
ID
of
the
author
|
|
Author
Name
|
Full
name
of
the
author
|
|
Entity
ID
|
ID
of
the
scope
|
|
Entity
Type
|
Type
of
the
entity
(
`Project`
/
`Group`
/
`User`
)
|
|
Entity
Path
|
Path
of
the
entity
|
|
Target
ID
|
ID
of
the
target
|
|
Target
Type
|
Type
of
the
target
|
|
Target
Details
|
Details
of
the
target
|
|
Action
|
Description
of
the
action
|
|
IP
Address
|
IP
address
of
the
author
who
performed
the
action
|
|
Created
At
(
UTC
)
|
Formatted
as
`YYYY-MM-DD HH:MM:SS`
|
### Limitation
The
Audit
Log
CSV
file
size
is
limited
to
a
maximum
of
`15 MB`
.
The
remaining
records
are
truncated
when
this
limit
is
reached
.
### Enable or disable Audit Log Export to CSV
The
Audit
Log
Export
to
CSV
is
under
development
and
not
ready
for
production
use
.
It
is
deployed
behind
a
feature
flag
that
is
**
disabled
by
default
**.
[
GitLab
administrators
with
access
to
the
GitLab
Rails
console
](
..
/administration/
feature_flags
.
md
)
can
enable
it
.
To
enable
it:
```
ruby
Feature.enable(:audit_log_export_csv)
```
To disable it:
```
ruby
Feature.disable(:audit_log_export_csv)
```
doc/administration/audit_reports.md
View file @
2ca2aee8
...
...
@@ -9,7 +9,7 @@ description: 'Learn how to create evidence artifacts typically requested by a 3r
GitLab can help owners and administrators respond to auditors by generating
comprehensive reports. These
**Audit Reports**
vary in scope, depending on the
need
:
need
s.
## Use cases
...
...
@@ -27,6 +27,3 @@ need:
-
`https://docs.gitlab.com/ee/administration/audit_events.html`
-
`https://docs.gitlab.com/ee/administration/logs.html`
We plan on making Audit Events
[
downloadable as a CSV
](
https://gitlab.com/gitlab-org/gitlab/-/issues/1449
)
in the near future.
doc/administration/img/export_audit_log_v13_4.png
0 → 100644
View file @
2ca2aee8
125 KB
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment