Improve dbengine docs for streaming setups #9177
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Manage this branch in SquashTest this branch here: https://joelhansdbengine-tweaks-hmi6z.squash.io |
database/engine/README.md
Outdated
| mode** that supports changing the data collection update frequency (`update_every`) **without losing** the previously | ||
| stored metrics. | ||
| The Database Engine works like a traditional database. It dedicates a certain amount of RAM to data caching and | ||
| indexing, while and the rest of the data resides compressed on disk. Unlike other [database modes](/database/README.md), |
There was a problem hiding this comment.
database modes -> memory modes
There was a problem hiding this comment.
Fixed both of these (and the rest of yours, @zack-shoylev)!
database/engine/README.md
Outdated
| The Database Engine works like a traditional database. It dedicates a certain amount of RAM to data caching and | ||
| indexing, while and the rest of the data resides compressed on disk. Unlike other [database modes](/database/README.md), | ||
| the amount of historical metrics stored is based on the amount of disk space you allocate and the effective compression | ||
| ratio, not a fixed number of history entries. |
There was a problem hiding this comment.
fixed number of metrics collected.
| When the disk quota is exceeded the oldest values are removed from the DB engine at real time, by automatically deleting | ||
| the oldest datafile and journalfile pair. Any corresponding pages residing in the Page Cache will also be invalidated | ||
| and removed. The DB engine logic will try to maintain between 10 and 20 file pairs at any point in time. | ||
| The Agent allocates resources for each instance separately using the `dbengine disk space` setting. If `dbengine disk |
There was a problem hiding this comment.
i would copy that to the calculator also
database/engine/README.md
Outdated
| location is `/var/cache/netdata/dbengine/*`). The higher numbered filenames contain more recent metric data. The user | ||
| can safely delete some pairs of files when Netdata is stopped to manually free up some space. | ||
|
|
||
| _Users should_ **back up** _their `./dbengine` folders if they consider this data to be important._ |
There was a problem hiding this comment.
let's add a link to exporters as well as an alternative
zack-shoylev
approved these changes
May 28, 2020
mfundul
approved these changes
May 29, 2020
Saruspete
pushed a commit
to Saruspete/netdata
that referenced
this pull request
Jun 17, 2020
* Refactor dbengine and add streaming section * Tweaks and copyediting * Fixes for Zack and Markos
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Fixes part of #9106. The other work is at netdata/learn#159.
I came into the dbengine doc to make a few tweaks around multiple instances and streaming configs, but ended up doing a bit more refactoring. The primary goal here is to help users understand that in streaming setups, the dbengine uses separate instances for each node, despite sharing the same
page cache sizeanddbengine disk spacesettings.Component Name
agent/database
Test Plan
Additional Information