docs: Add default database storage path to disk requirements doc by nedi-app[bot] · Pull Request #22865 · netdata/netdata · GitHub
Skip to content

docs: Add default database storage path to disk requirements doc#22865

Merged
Ancairon merged 3 commits into
masterfrom
docs/netdata-database-storage-location
Jul 3, 2026
Merged

docs: Add default database storage path to disk requirements doc#22865
Ancairon merged 3 commits into
masterfrom
docs/netdata-database-storage-location

Conversation

@nedi-app

@nedi-app nedi-app Bot commented Jun 25, 2026

Copy link
Copy Markdown
Contributor

Summary

Add default database storage path to disk requirements doc. Files changed: docs/netdata-agent/sizing-netdata-agents/disk-requirements-and-retention.md.

User Request

Where you store the DB

Prompt (English)

Where Netdata stores its database files on disk

Reason for Change

This change applies the specific user request using repository-truth evidence from the audit execution workspace.


Summary by cubic

Adds a scoped note under the dbengine section clarifying that metrics are stored on disk and that the default path varies by install method/OS/Docker/Kubernetes, with a link to the backup‑and‑restore guide for exact defaults and other data locations. Removes the identity-file claim and any relocation guidance to keep the doc accurate and focused on dbengine.

Written for commit 5f30a01. Summary will update on new commits.

Review in cubic

@nedi-app nedi-app Bot added the nedi-audit PRs created by the nedi-audit pipeline label Jun 25, 2026
@Ancairon

Ancairon commented Jul 3, 2026

Copy link
Copy Markdown
Member

…on of disk-requirements-and-retention.md stating the default on-disk metrics path (/var/cache/netdata) and identity path (/var/lib/netdata), the path-variation caveat, and a cross-link to the backup-and-restore guide.
@nedi-app nedi-app Bot force-pushed the docs/netdata-database-storage-location branch from cb21193 to ae59e42 Compare July 3, 2026 08:05
@nedi-app

nedi-app Bot commented Jul 3, 2026

Copy link
Copy Markdown
Contributor Author

@Ancairon

  • Verified the added note's metrics path (/var/cache/netdata) and identity path (/var/lib/netdata) against the backup-and-restore guide's path table — both paths match exactly, including the identity-file description (claim token and API key)
  • Verified the cross-link to the backup-and-restore guide resolves to a published page that contains the full path list and the backup procedure — the link gives the reader a complete, actionable follow-up
  • The path-variation caveat correctly states that exact paths depend on installation method, operating system, and container platform (Docker/Kubernetes) — this matches the project's install-prefix-dependent path convention and avoids presenting a single default path as universal
  • The note is placed in the dbengine section, the only database mode that persists metrics to disk — the ram mode stores in memory only, so the storage-path note belongs with dbengine and not as a general database-mode statement
  • The :::note admonition matches the document's existing formatting conventions and preserves heading hierarchy and section structure without disruption — the insertion is clean and non-disruptive
  • Developer-facing source docs (src/database/README.md, src/database/CONFIGURATION.md) do not state the on-disk storage paths, and no user-facing page beyond the backup guide previously documented them — the note fills a real coverage gap: a reader on the disk/retention page now learns where the database lives without leaving the page
  • No issues found; the documentation is accurate and complete for its scope.

Ancairon added 2 commits July 3, 2026 17:21
…aims

Drop the mode-independent identity-file claim and the unsupported
"relocate" promise from the note, and move it under the dbengine
heading since it's now dbengine-specific. Point to the backup guide
for the exact default path instead of duplicating it here.
@Ancairon Ancairon marked this pull request as ready for review July 3, 2026 15:03
@Ancairon Ancairon requested a review from kanelatechnical as a code owner July 3, 2026 15:03
@Ancairon Ancairon enabled auto-merge (squash) July 3, 2026 15:03
@sonarqubecloud

sonarqubecloud Bot commented Jul 3, 2026

Copy link
Copy Markdown

@Ancairon Ancairon merged commit 0a9c4db into master Jul 3, 2026
145 of 152 checks passed
@Ancairon Ancairon deleted the docs/netdata-database-storage-location branch July 3, 2026 15:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/docs nedi-audit PRs created by the nedi-audit pipeline

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant