Skip to content

Commit 8ef92f7

Browse files
mafredrimafredri
committed
feat(coderd/database/dbpurge): add retention for workspace agent logs
Replace hardcoded 7-day retention for workspace agent logs with configurable retention from deployment settings. Falls back to global retention when not set, and skips deletion entirely when effective retention is 0. Depends on #21038 Updates #20743
1 parent 7e8a005 commit 8ef92f7

File tree

10 files changed

+2229
-2013
lines changed

10 files changed

+2229
-2013
lines changed

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

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -725,6 +725,11 @@ that data type.
725725
disable (data is kept indefinitely unless individual settings are
726726
configured).
727727

728+
--workspace-agent-logs-retention duration, $CODER_WORKSPACE_AGENT_LOGS_RETENTION (default: 7d)
729+
How long workspace agent logs are retained. Logs from non-latest
730+
workspace builds are deleted after this period to free up storage
731+
space. Set to 0 to disable automatic deletion of workspace agent logs.
732+
728733
TELEMETRY OPTIONS:
729734
Telemetry is critical to our ability to improve Coder. We strip all personal
730735
information before sending data to our servers. Please only disable telemetry

‎cli/testdata/server-config.yaml.golden‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -780,3 +780,8 @@ retention:
780780
# an expired key. Set to 0 to disable automatic deletion of expired keys.
781781
# (default: 7d, type: duration)
782782
api_keys: 168h0m0s
783+
# How long workspace agent logs are retained. Logs from non-latest workspace
784+
# builds are deleted after this period to free up storage space. Set to 0 to
785+
# disable automatic deletion of workspace agent logs.
786+
# (default: 7d, type: duration)
787+
workspace_agent_logs: 168h0m0s

‎coderd/database/dbpurge/dbpurge.go‎

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,7 @@ import (
1818
)
1919

2020
const (
21-
delay = 10 * time.Minute
22-
maxAgentLogAge = 7 * 24 * time.Hour
21+
delay = 10 * time.Minute
2322
// Connection events are now inserted into the `connection_logs` table.
2423
// We'll slowly remove old connection events from the `audit_logs` table,
2524
// but we won't touch the `connection_logs` table.
@@ -67,9 +66,15 @@ func New(ctx context.Context, logger slog.Logger, db database.Store, vals *coder
6766
return nil
6867
}
6968

70-
deleteOldWorkspaceAgentLogsBefore := start.Add(-maxAgentLogAge)
71-
if err := tx.DeleteOldWorkspaceAgentLogs(ctx, deleteOldWorkspaceAgentLogsBefore); err != nil {
72-
return xerrors.Errorf("failed to delete old workspace agent logs: %w", err)
69+
workspaceAgentLogsRetention := vals.Retention.WorkspaceAgentLogs.Value()
70+
if workspaceAgentLogsRetention == 0 {
71+
workspaceAgentLogsRetention = vals.Retention.Global.Value()
72+
}
73+
if workspaceAgentLogsRetention > 0 {
74+
deleteOldWorkspaceAgentLogsBefore := start.Add(-workspaceAgentLogsRetention)
75+
if err := tx.DeleteOldWorkspaceAgentLogs(ctx, deleteOldWorkspaceAgentLogsBefore); err != nil {
76+
return xerrors.Errorf("failed to delete old workspace agent logs: %w", err)
77+
}
7378
}
7479
if err := tx.DeleteOldWorkspaceAgentStats(ctx); err != nil {
7580
return xerrors.Errorf("failed to delete old workspace agent stats: %w", err)

‎coderd/database/dbpurge/dbpurge_test.go‎

Lines changed: 97 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -246,7 +246,11 @@ func TestDeleteOldWorkspaceAgentLogs(t *testing.T) {
246246
// After dbpurge completes, the ticker is reset. Trap this call.
247247

248248
done := awaitDoTick(ctx, t, clk)
249-
closer := dbpurge.New(ctx, logger, db, &codersdk.DeploymentValues{}, clk)
249+
closer := dbpurge.New(ctx, logger, db, &codersdk.DeploymentValues{
250+
Retention: codersdk.RetentionConfig{
251+
WorkspaceAgentLogs: serpent.Duration(7 * 24 * time.Hour),
252+
},
253+
}, clk)
250254
defer closer.Close()
251255
<-done // doTick() has now run.
252256

@@ -392,6 +396,98 @@ func mustCreateAgentLogs(ctx context.Context, t *testing.T, db database.Store, a
392396
require.NotEmpty(t, agentLogs, "agent logs must be present")
393397
}
394398

399+
func TestDeleteOldWorkspaceAgentLogsRetention(t *testing.T) {
400+
t.Parallel()
401+
402+
now := time.Date(2025, 1, 15, 7, 30, 0, 0, time.UTC)
403+
404+
testCases := []struct {
405+
name string
406+
retentionConfig codersdk.RetentionConfig
407+
logsAge time.Duration
408+
expectDeleted bool
409+
}{
410+
{
411+
name: "RetentionEnabled",
412+
retentionConfig: codersdk.RetentionConfig{
413+
WorkspaceAgentLogs: serpent.Duration(7 * 24 * time.Hour), // 7 days
414+
},
415+
logsAge: 8 * 24 * time.Hour, // 8 days ago
416+
expectDeleted: true,
417+
},
418+
{
419+
name: "RetentionDisabled",
420+
retentionConfig: codersdk.RetentionConfig{
421+
WorkspaceAgentLogs: serpent.Duration(0),
422+
},
423+
logsAge: 60 * 24 * time.Hour, // 60 days ago
424+
expectDeleted: false,
425+
},
426+
{
427+
name: "GlobalRetentionFallback",
428+
retentionConfig: codersdk.RetentionConfig{
429+
Global: serpent.Duration(14 * 24 * time.Hour), // 14 days global
430+
WorkspaceAgentLogs: serpent.Duration(0), // Not set, falls back to global
431+
},
432+
logsAge: 15 * 24 * time.Hour, // 15 days ago
433+
expectDeleted: true,
434+
},
435+
{
436+
name: "CustomRetention30Days",
437+
retentionConfig: codersdk.RetentionConfig{
438+
WorkspaceAgentLogs: serpent.Duration(30 * 24 * time.Hour), // 30 days
439+
},
440+
logsAge: 31 * 24 * time.Hour, // 31 days ago
441+
expectDeleted: true,
442+
},
443+
}
444+
445+
for _, tc := range testCases {
446+
t.Run(tc.name, func(t *testing.T) {
447+
t.Parallel()
448+
449+
ctx := testutil.Context(t, testutil.WaitShort)
450+
clk := quartz.NewMock(t)
451+
clk.Set(now).MustWait(ctx)
452+
453+
oldTime := now.Add(-tc.logsAge)
454+
455+
db, _ := dbtestutil.NewDB(t, dbtestutil.WithDumpOnFailure())
456+
logger := slogtest.Make(t, &slogtest.Options{IgnoreErrors: true})
457+
org := dbgen.Organization(t, db, database.Organization{})
458+
user := dbgen.User(t, db, database.User{})
459+
_ = dbgen.OrganizationMember(t, db, database.OrganizationMember{UserID: user.ID, OrganizationID: org.ID})
460+
tv := dbgen.TemplateVersion(t, db, database.TemplateVersion{OrganizationID: org.ID, CreatedBy: user.ID})
461+
tmpl := dbgen.Template(t, db, database.Template{OrganizationID: org.ID, ActiveVersionID: tv.ID, CreatedBy: user.ID})
462+
463+
ws := dbgen.Workspace(t, db, database.WorkspaceTable{Name: "test-ws", OwnerID: user.ID, OrganizationID: org.ID, TemplateID: tmpl.ID})
464+
wb1 := mustCreateWorkspaceBuild(t, db, org, tv, ws.ID, oldTime, 1)
465+
wb2 := mustCreateWorkspaceBuild(t, db, org, tv, ws.ID, oldTime, 2)
466+
agent1 := mustCreateAgent(t, db, wb1)
467+
agent2 := mustCreateAgent(t, db, wb2)
468+
mustCreateAgentLogs(ctx, t, db, agent1, &oldTime, "agent 1 logs")
469+
mustCreateAgentLogs(ctx, t, db, agent2, &oldTime, "agent 2 logs")
470+
471+
// Run the purge.
472+
done := awaitDoTick(ctx, t, clk)
473+
closer := dbpurge.New(ctx, logger, db, &codersdk.DeploymentValues{
474+
Retention: tc.retentionConfig,
475+
}, clk)
476+
defer closer.Close()
477+
testutil.TryReceive(ctx, t, done)
478+
479+
// Verify results.
480+
if tc.expectDeleted {
481+
assertNoWorkspaceAgentLogs(ctx, t, db, agent1.ID)
482+
} else {
483+
assertWorkspaceAgentLogs(ctx, t, db, agent1.ID, "agent 1 logs")
484+
}
485+
// Latest build logs are always retained.
486+
assertWorkspaceAgentLogs(ctx, t, db, agent2.ID, "agent 2 logs")
487+
})
488+
}
489+
}
490+
395491
//nolint:paralleltest // It uses LockIDDBPurge.
396492
func TestDeleteOldProvisionerDaemons(t *testing.T) {
397493
// TODO: must refactor DeleteOldProvisionerDaemons to allow passing in cutoff

‎codersdk/deployment.go‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -834,6 +834,9 @@ type RetentionConfig struct {
834834
// Keys are only deleted if they have been expired for at least this duration.
835835
// Defaults to 7 days to preserve existing behavior.
836836
APIKeys serpent.Duration `json:"api_keys" typescript:",notnull"`
837+
// WorkspaceAgentLogs controls how long workspace agent logs are retained.
838+
// Defaults to 7 days to preserve existing behavior.
839+
WorkspaceAgentLogs serpent.Duration `json:"workspace_agent_logs" typescript:",notnull"`
837840
}
838841

839842
type NotificationsConfig struct {
@@ -3436,6 +3439,17 @@ Write out the current server config as YAML to stdout.`,
34363439
YAML: "api_keys",
34373440
Annotations: serpent.Annotations{}.Mark(annotationFormatDuration, "true"),
34383441
},
3442+
{
3443+
Name: "Workspace Agent Logs Retention",
3444+
Description: "How long workspace agent logs are retained. Logs from non-latest workspace builds are deleted after this period to free up storage space. Set to 0 to disable automatic deletion of workspace agent logs.",
3445+
Flag: "workspace-agent-logs-retention",
3446+
Env: "CODER_WORKSPACE_AGENT_LOGS_RETENTION",
3447+
Value: &c.Retention.WorkspaceAgentLogs,
3448+
Default: "7d",
3449+
Group: &deploymentGroupRetention,
3450+
YAML: "workspace_agent_logs",
3451+
Annotations: serpent.Annotations{}.Mark(annotationFormatDuration, "true"),
3452+
},
34393453
{
34403454
Name: "Enable Authorization Recordings",
34413455
Description: "All api requests will have a header including all authorization calls made during the request. " +

‎docs/admin/setup/data-retention.md‎

Lines changed: 22 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# Data Retention
22

33
Coder supports configurable retention policies that automatically purge old
4-
Audit Logs, Connection Logs, and API keys. These policies help manage database
5-
growth by removing records older than a specified duration.
4+
Audit Logs, Connection Logs, Workspace Agent Logs, and API keys. These policies
5+
help manage database growth by removing records older than a specified duration.
66

77
## Overview
88

@@ -25,12 +25,13 @@ a YAML configuration file.
2525

2626
### Settings
2727

28-
| Setting | CLI Flag | Environment Variable | Default | Description |
29-
|-----------------|-------------------------------|-----------------------------------|------------------|--------------------------------------------------------------------------|
30-
| Global | `--global-retention` | `CODER_GLOBAL_RETENTION` | `0` (disabled) | Default retention for all data types. Individual settings override this. |
31-
| Audit Logs | `--audit-logs-retention` | `CODER_AUDIT_LOGS_RETENTION` | `0` (use global) | How long to retain Audit Log entries. |
32-
| Connection Logs | `--connection-logs-retention` | `CODER_CONNECTION_LOGS_RETENTION` | `0` (use global) | How long to retain Connection Log entries. |
33-
| API Keys | `--api-keys-retention` | `CODER_API_KEYS_RETENTION` | `7d` | How long to retain expired API keys. |
28+
| Setting | CLI Flag | Environment Variable | Default | Description |
29+
|----------------------|------------------------------------|----------------------------------------|------------------|--------------------------------------------------------------------------|
30+
| Global | `--global-retention` | `CODER_GLOBAL_RETENTION` | `0` (disabled) | Default retention for all data types. Individual settings override this. |
31+
| Audit Logs | `--audit-logs-retention` | `CODER_AUDIT_LOGS_RETENTION` | `0` (use global) | How long to retain Audit Log entries. |
32+
| Connection Logs | `--connection-logs-retention` | `CODER_CONNECTION_LOGS_RETENTION` | `0` (use global) | How long to retain Connection Log entries. |
33+
| API Keys | `--api-keys-retention` | `CODER_API_KEYS_RETENTION` | `7d` | How long to retain expired API keys. |
34+
| Workspace Agent Logs | `--workspace-agent-logs-retention` | `CODER_WORKSPACE_AGENT_LOGS_RETENTION` | `7d` | How long to retain workspace agent logs. |
3435

3536
### Duration Format
3637

@@ -68,6 +69,7 @@ retention:
6869
audit_logs: 365d
6970
connection_logs: 0s
7071
api_keys: 7d
72+
workspace_agent_logs: 7d
7173
```
7274
7375
## How Retention Works
@@ -103,6 +105,16 @@ ago. Active keys are never deleted by the retention policy.
103105
Keeping expired keys for a short period allows Coder to return a more helpful
104106
error message when users attempt to use an expired key.
105107

108+
### Workspace Agent Logs Behavior
109+
110+
Workspace agent logs are retained based on the retention period, but **logs from
111+
the latest build of each workspace are always retained** regardless of age. This
112+
ensures you can always debug issues with active workspaces.
113+
114+
Only logs from non-latest workspace builds that are older than the retention
115+
period are deleted. Setting `--workspace-agent-logs-retention=7d` keeps all logs
116+
from the latest build plus logs from previous builds for up to 7 days.
117+
106118
## Best Practices
107119

108120
### Recommended Starting Configuration
@@ -115,6 +127,7 @@ retention:
115127
audit_logs: 365d
116128
connection_logs: 0s # Use global
117129
api_keys: 7d
130+
workspace_agent_logs: 7d
118131
```
119132

120133
### Compliance Considerations
@@ -160,6 +173,7 @@ retention:
160173
audit_logs: 0s
161174
connection_logs: 0s
162175
api_keys: 0s
176+
workspace_agent_logs: 0s
163177
```
164178

165179
There is no way to disable retention for a specific data type while global

0 commit comments

Comments
 (0)