docs: add data retention documentation by mafredri · Pull Request #21038 · coder/coder

mafredri · 2025-12-01T15:43:23Z

Document configurable retention policies for Audit Logs, Connection Logs,
and API keys. Add new data-retention.md page and update existing docs to
reference it.

Depends on #21021
Updates #20743

PR Stack

	PR	Title
	#21021	feat(coderd): add retention policy configuration
	#21022	feat(coderd/database/dbpurge): add retention for connection logs
	#21025	feat(coderd/database/dbpurge): add retention for audit logs
	#21037	feat(coderd/database/dbpurge): make API keys retention configurable
👉	#21038	docs: add data retention documentation
	#21039	feat: add retention config for `workspace_agent_logs`

dannykopping

Very nice!

github-actions · 2025-12-02T11:44:53Z

Task created: https://dev.coder.com/tasks/mafredri/1fb730d2-1b04-4d2b-8a9b-f5fffde73383

mafredri · 2025-12-02T11:49:09Z

📚 Documentation Check

✨ No Changes Needed

All documentation has been comprehensively updated in this PR. The following changes are already included:

New Documentation:

✅ docs/admin/setup/data-retention.md - Complete new guide covering retention policies for Audit Logs, Connection Logs, and API keys
✅ Added to manifest.json under Admin > Setup section

Updated Documentation:

✅ docs/admin/security/audit-logs.md - Added retention policy section with link to new guide
✅ docs/admin/monitoring/connection-logs.md - Added retention policy section with link to new guide
✅ docs/admin/monitoring/index.md - Added connection logs to the index
✅ docs/reference/cli/server.md - Auto-generated CLI reference includes new flags
✅ docs/reference/api/general.md & schemas.md - Auto-generated API documentation updated

The documentation is thorough and well-structured, covering:

Configuration options (CLI flags, env vars, YAML)
How retention works (background purge process, timing, behavior)
Best practices and compliance considerations
Monitoring and maintenance procedures
Cross-references to related documentation

This comment was generated by an AI Agent through Coder Tasks

Document configurable retention policies for Audit Logs, Connection Logs, and API keys. Add new data-retention.md page and update existing docs to reference it. Depends on #21021 Updates #20743

…ling Retention'

Rewrite documentation to reflect that each retention setting is independent. Set to a non-zero duration to enable, or 0 to keep data indefinitely.

Previously AI Bridge retention was only documented in the auto-generated CLI reference, making it difficult for administrators to discover and understand how to configure data retention for compliance requirements. This adds retention configuration to the AI Bridge setup guide with examples, documents the REST API and CLI export options in the monitoring guide, and cross-references AI Bridge from the central data retention page for discoverability. Closes #21038

…r#21055) Previously AI Bridge retention was only documented in the auto-generated CLI reference, making it difficult for administrators to discover and understand how to configure data retention for compliance requirements. This adds retention configuration to the AI Bridge setup guide with examples, documents the REST API and CLI export options in the monitoring guide, and cross-references AI Bridge from the central data retention page for discoverability. Closes coder#21038

github-actions Bot assigned mafredri Dec 1, 2025

mafredri force-pushed the mafredri/feat-coderd-db-retention-policy-5 branch from 0825d8a to f5d2df5 Compare December 1, 2025 15:50

mafredri force-pushed the mafredri/feat-coderd-db-retention-policy-5 branch from 866e986 to ccd7601 Compare December 1, 2025 15:57

mafredri force-pushed the mafredri/feat-coderd-db-retention-policy-4 branch from 0e782ee to bd8e537 Compare December 1, 2025 16:00

mafredri force-pushed the mafredri/feat-coderd-db-retention-policy-5 branch 2 times, most recently from 23641d0 to 123724d Compare December 1, 2025 16:19

mafredri marked this pull request as ready for review December 1, 2025 16:28

mafredri requested a review from david-fraley December 1, 2025 16:28

mafredri mentioned this pull request Dec 1, 2025

feat: add retention config for workspace_agent_logs #21039

Merged

mafredri force-pushed the mafredri/feat-coderd-db-retention-policy-4 branch from e16d01f to 008a48a Compare December 1, 2025 17:44

mafredri force-pushed the mafredri/feat-coderd-db-retention-policy-4 branch 2 times, most recently from 03f5ec5 to 46f07e1 Compare December 2, 2025 10:05

mafredri force-pushed the mafredri/feat-coderd-db-retention-policy-5 branch from 7e8a005 to b1ce17f Compare December 2, 2025 10:08

mafredri force-pushed the mafredri/feat-coderd-db-retention-policy-5 branch from b1ce17f to d058883 Compare December 2, 2025 10:17

dannykopping approved these changes Dec 2, 2025

View reviewed changes

Comment thread docs/admin/security/audit-logs.md Outdated

Comment thread docs/admin/setup/data-retention.md

Comment thread docs/admin/setup/data-retention.md

mafredri force-pushed the mafredri/feat-coderd-db-retention-policy-5 branch from d058883 to 267c7d8 Compare December 2, 2025 11:13

mafredri force-pushed the mafredri/feat-coderd-db-retention-policy-4 branch from 46f07e1 to 27c90dd Compare December 2, 2025 11:37

mafredri force-pushed the mafredri/feat-coderd-db-retention-policy-5 branch from 267c7d8 to 8843bb3 Compare December 2, 2025 11:37

mafredri added the doc-check Assign this label to PRs to check for any doc changes. label Dec 2, 2025

mafredri mentioned this pull request Dec 2, 2025

docs: add data retention and export documentation for AI Bridge #21055

Merged

mafredri force-pushed the mafredri/feat-coderd-db-retention-policy-4 branch from 27c90dd to 1bed429 Compare December 2, 2025 12:56

mafredri force-pushed the mafredri/feat-coderd-db-retention-policy-5 branch from 8843bb3 to b15783b Compare December 2, 2025 12:56

mafredri force-pushed the mafredri/feat-coderd-db-retention-policy-4 branch from 1bed429 to a6744f0 Compare December 2, 2025 14:51

mafredri force-pushed the mafredri/feat-coderd-db-retention-policy-5 branch from b15783b to 3caa0ab Compare December 2, 2025 14:52

Base automatically changed from mafredri/feat-coderd-db-retention-policy-4 to main December 2, 2025 15:41

mafredri added 4 commits December 2, 2025 15:42

docs: add data retention documentation

209c70a

Document configurable retention policies for Audit Logs, Connection Logs, and API keys. Add new data-retention.md page and update existing docs to reference it. Depends on #21021 Updates #20743

fix: format markdown tables

d158959

docs: clarify heading - 'Keeping Data Indefinitely' instead of 'Disab…

1b10d7e

…ling Retention'

chore: remove global retention from documentation

f8cefc6

Rewrite documentation to reflect that each retention setting is independent. Set to a non-zero duration to enable, or 0 to keep data indefinitely.

mafredri force-pushed the mafredri/feat-coderd-db-retention-policy-5 branch from 3caa0ab to f8cefc6 Compare December 2, 2025 15:42

mafredri enabled auto-merge (squash) December 2, 2025 15:46

mafredri merged commit d9888ce into main Dec 2, 2025
25 checks passed

mafredri deleted the mafredri/feat-coderd-db-retention-policy-5 branch December 2, 2025 15:47

github-actions Bot locked and limited conversation to collaborators Dec 2, 2025

Navigation Menu

Uh oh!

docs: add data retention documentation - #21038

docs: add data retention documentation#21038
mafredri merged 4 commits into
mainfrom
mafredri/feat-coderd-db-retention-policy-5

mafredri commented Dec 1, 2025 •

edited

Loading

Uh oh!

dannykopping left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions Bot commented Dec 2, 2025

Uh oh!

mafredri commented Dec 2, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Conversation

mafredri commented Dec 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR Stack

Uh oh!

dannykopping left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions Bot commented Dec 2, 2025

Uh oh!

mafredri commented Dec 2, 2025

📚 Documentation Check

✨ No Changes Needed

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

mafredri commented Dec 1, 2025 •

edited

Loading