Skip to content

Commit

Permalink
Split database overview and configuration reference (netdata#19077)
Browse files Browse the repository at this point in the history
Co-authored-by: ilyam8 <[email protected]>
  • Loading branch information
Ancairon and ilyam8 authored Nov 25, 2024
1 parent 3ec78e4 commit f3ac2fe
Show file tree
Hide file tree
Showing 14 changed files with 181 additions and 170 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ beyond stored historical metrics, you'll see this message:

![image](https://user-images.githubusercontent.com/70198089/225851033-43b95164-a651-48f2-8915-6aac9739ed93.png)

At any time, [configure the internal TSDB's storage capacity](/src/database/README.md) to expand your
At any time, [configure the internal TSDB's storage capacity](/src/database/CONFIGURATION.md) to expand your
depth of historical metrics.

### Timezone selector
Expand Down
2 changes: 1 addition & 1 deletion docs/deployment-guides/deployment-strategies.md
Original file line number Diff line number Diff line change
Expand Up @@ -193,7 +193,7 @@ We also suggest that you:

For increased security, user management and access to our latest features, tools and troubleshooting solutions.

2. [Change how long Netdata stores metrics](/src/database/README.md#modes)
2. [Change how long Netdata stores metrics](/src/database/CONFIGURATION.md#tiers)

To control Netdata's memory use, when you have a lot of ephemeral metrics.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ changes reflected in those visualizations due to the way Netdata Cloud proxies m

### Increase the long-term metrics retention period

Read our doc on [increasing long-term metrics storage](/src/database/README.md#tiers) for details.
Read our doc on [increasing long-term metrics storage](/src/database/CONFIGURATION.md#tiers) for details.

## Modify alerts and notifications

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,8 @@ The following table summarizes the effect of each optimization on the CPU, RAM a
| [Use streaming and replication](#use-streaming-and-replication) | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
| [Disable unneeded plugins or collectors](#disable-unneeded-plugins-or-collectors) | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
| [Reduce data collection frequency](#reduce-collection-frequency) | :heavy_check_mark: | | :heavy_check_mark: |
| [Change how long Netdata stores metrics](/src/database/README.md#tiers) | | :heavy_check_mark: | :heavy_check_mark: |
| [Use a different metric storage database](/src/database/README.md) | | :heavy_check_mark: | :heavy_check_mark: |
| [Change how long Netdata stores metrics](/src/database/CONFIGURATION.md#tiers) | | :heavy_check_mark: | :heavy_check_mark: |
| [Use a different metric storage database](/src/database/CONFIGURATION.md) | | :heavy_check_mark: | :heavy_check_mark: |
| [Disable machine learning](#disable-machine-learning) | :heavy_check_mark: | | |
| [Use a reverse proxy](#run-netdata-behind-a-proxy) | :heavy_check_mark: | | |
| [Disable/lower gzip compression for the Agent dashboard](#disablelower-gzip-compression-for-the-dashboard) | :heavy_check_mark: | | |
Expand Down Expand Up @@ -72,8 +72,8 @@ The memory footprint of Netdata is mainly influenced by the number of metrics co
To estimate and control memory consumption, you can (either one or a combination of the following actions):

1. [Disable unneeded plugins or collectors](#disable-unneeded-plugins-or-collectors)
2. [Change how long Netdata stores metrics](/src/database/README.md#tiers)
3. [Use a different metric storage database](/src/database/README.md).
2. [Change how long Netdata stores metrics](/src/database/CONFIGURATION.md#tiers)
3. [Use a different metric storage database](/src/database/CONFIGURATION.md#modes).

### Disk footprint and I/O

Expand All @@ -90,11 +90,11 @@ To optimize your disk footprint in any aspect described below, you can:

To configure retention, you can:

1. [Change how long Netdata stores metrics](/src/database/README.md#tiers).
1. [Change how long Netdata stores metrics](/src/database/CONFIGURATION.md#tiers).

To control disk I/O:

1. [Use a different metric storage database](/src/database/README.md),
1. [Use a different metric storage database](/src/database/CONFIGURATION.md),

Minimize deployment impact on the production system by optimizing disk footprint:

Expand Down Expand Up @@ -123,7 +123,7 @@ in `stream.conf`). On the child nodes you should add to `netdata.conf` the follo

### Use memory mode ram for the child nodes

See [using a different metric storage database](/src/database/README.md).
See [using a different metric storage database](/src/database/README.md#modes).

## Disable unneeded plugins or collectors

Expand Down Expand Up @@ -211,11 +211,11 @@ update_every: 10
## Lower memory usage for metrics retention

See how
to [change how long Netdata stores metrics](/src/database/README.md#tiers).
to [change how long Netdata stores metrics](/src/database/CONFIGURATION.md#tiers).

## Use a different metric storage database

Consider [using a different metric storage database](/src/database/README.md)
Consider [using a different metric storage database](/src/database/README.md#modes)
when running Netdata on IoT devices, and for children in a parent-child set up based
on [streaming and replication](/docs/observability-centralization-points/README.md).

Expand Down

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ gantt
**Configuring dbengine mode and retention**:

- Enable dbengine mode: The dbengine mode is already the default, so no configuration change is necessary. For reference, the dbengine mode can be configured by setting `[db].mode` to `dbengine` in `netdata.conf`.
- Adjust retention (optional): see [Change how long Netdata stores metrics](/src/database/README.md#tiers).
- Adjust retention (optional): see [Change how long Netdata stores metrics](/src/database/CONFIGURATION.md#tiers).

## `ram`

Expand Down
Loading

0 comments on commit f3ac2fe

Please sign in to comment.