Skip to content

Commit d5062e2

Browse files
committed
advice audit log retention according to docs
1 parent 3976e07 commit d5062e2

File tree

5 files changed

+10
-5
lines changed

5 files changed

+10
-5
lines changed

cli/testdata/coder_server_--help.golden

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -710,7 +710,9 @@ that data type.
710710

711711
--audit-logs-retention duration, $CODER_AUDIT_LOGS_RETENTION (default: 0)
712712
How long audit log entries are retained. Set to 0 to use the global
713-
retention value, or to disable if global is also 0.
713+
retention value, or to disable if global is also 0. We advise keeping
714+
audit logs for at least a year, and in accordance with your compliance
715+
requirements.
714716

715717
--connection-logs-retention duration, $CODER_CONNECTION_LOGS_RETENTION (default: 0)
716718
How long connection log entries are retained. Set to 0 to use the

cli/testdata/server-config.yaml.golden

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -754,7 +754,8 @@ retention:
754754
# (default: 0, type: duration)
755755
global: 0s
756756
# How long audit log entries are retained. Set to 0 to use the global retention
757-
# value, or to disable if global is also 0.
757+
# value, or to disable if global is also 0. We advise keeping audit logs for at
758+
# least a year, and in accordance with your compliance requirements.
758759
# (default: 0, type: duration)
759760
audit_logs: 0s
760761
# How long connection log entries are retained. Set to 0 to use the global

codersdk/deployment.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3405,7 +3405,7 @@ Write out the current server config as YAML to stdout.`,
34053405
},
34063406
{
34073407
Name: "Audit Logs Retention",
3408-
Description: "How long audit log entries are retained. Set to 0 to use the global retention value, or to disable if global is also 0.",
3408+
Description: "How long audit log entries are retained. Set to 0 to use the global retention value, or to disable if global is also 0. We advise keeping audit logs for at least a year, and in accordance with your compliance requirements.",
34093409
Flag: "audit-logs-retention",
34103410
Env: "CODER_AUDIT_LOGS_RETENTION",
34113411
Value: &c.Retention.AuditLogs,

docs/reference/cli/server.md

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

enterprise/cli/testdata/coder_server_--help.golden

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -711,7 +711,9 @@ that data type.
711711

712712
--audit-logs-retention duration, $CODER_AUDIT_LOGS_RETENTION (default: 0)
713713
How long audit log entries are retained. Set to 0 to use the global
714-
retention value, or to disable if global is also 0.
714+
retention value, or to disable if global is also 0. We advise keeping
715+
audit logs for at least a year, and in accordance with your compliance
716+
requirements.
715717

716718
--connection-logs-retention duration, $CODER_CONNECTION_LOGS_RETENTION (default: 0)
717719
How long connection log entries are retained. Set to 0 to use the

0 commit comments

Comments
 (0)