summaryrefslogtreecommitdiffstats
path: root/streaming
diff options
context:
space:
mode:
authorvkalintiris <vasilis@netdata.cloud>2024-01-11 19:38:01 +0200
committerGitHub <noreply@github.com>2024-01-11 19:38:01 +0200
commit2165279a87314fb74e8c4de735231a78de73aa54 (patch)
treef8f7c5b55179ca536f1a84a29da9a5cd0860a3a1 /streaming
parent9d0f8a9034ea26b1f6a83b5e3347964486ddb7f1 (diff)
Delete memory mode "map" and "save". (#16604)
* Delete memory modes "map" and "save". * Remove unmaintained exporting tests * Remove references of map/save modes in docs. * Remove more references to map/save from docs.
Diffstat (limited to 'streaming')
-rw-r--r--streaming/README.md15
1 files changed, 6 insertions, 9 deletions
diff --git a/streaming/README.md b/streaming/README.md
index 03de090e02..153286e5fb 100644
--- a/streaming/README.md
+++ b/streaming/README.md
@@ -52,8 +52,8 @@ node**. This file is automatically generated by Netdata the first time it is sta
|-----------------------------------------------|----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `enabled` | `no` | Whether this API KEY enabled or disabled. |
| [`allow from`](#allow-from) | `*` | A space-separated list of [Netdata simple patterns](https://github.com/netdata/netdata/blob/master/libnetdata/simple_pattern/README.md) matching the IPs of nodes that will stream metrics using this API key. [Read more &rarr;](#allow-from) |
-| `default history` | `3600` | The default amount of child metrics history to retain when using the `save`, `map`, or `ram` memory modes. |
-| [`default memory mode`](#default-memory-mode) | `ram` | The [database](https://github.com/netdata/netdata/blob/master/database/README.md) to use for all nodes using this `API_KEY`. Valid settings are `dbengine`, `map`, `save`, `ram`, or `none`. [Read more &rarr;](#default-memory-mode) |
+| `default history` | `3600` | The default amount of child metrics history to retain when using the `ram` memory mode. |
+| [`default memory mode`](#default-memory-mode) | `ram` | The [database](https://github.com/netdata/netdata/blob/master/database/README.md) to use for all nodes using this `API_KEY`. Valid settings are `dbengine`, `ram`, or `none`. [Read more &rarr;](#default-memory-mode) |
| `health enabled by default` | `auto` | Whether alerts and notifications should be enabled for nodes using this `API_KEY`. `auto` enables alerts when the child is connected. `yes` enables alerts always, and `no` disables alerts. |
| `default postpone alarms on connect seconds` | `60` | Postpone alerts and notifications for a period of time after the child connects. |
| `default health log history` | `432000` | History of health log events (in seconds) kept in the database. |
@@ -128,16 +128,13 @@ To allow all IPs starting with `10.*`, except `10.1.2.3`:
#### `default memory mode`
-The [database](https://github.com/netdata/netdata/blob/master/database/README.md) to use for all nodes using this `API_KEY`. Valid settings are `dbengine`, `ram`,
-`save`, `map`, or `none`.
+The [database](https://github.com/netdata/netdata/blob/master/database/README.md) to use for all nodes using this `API_KEY`.
+Valid settings are `dbengine`, `ram`, , or `none`.
- `dbengine`: The default, recommended time-series database (TSDB) for Netdata. Stores recent metrics in memory, then
efficiently spills them to disk for long-term storage.
- `ram`: Stores metrics _only_ in memory, which means metrics are lost when Netdata stops or restarts. Ideal for
streaming configurations that use ephemeral nodes.
-- `save`: Stores metrics in memory, but saves metrics to disk when Netdata stops or restarts, and loads historical
- metrics on start.
-- `map`: Stores metrics in memory-mapped files, like swap, with constant disk write.
- `none`: No database.
When using `default memory mode = dbengine`, the parent node creates a separate instance of the TSDB to store metrics
@@ -149,7 +146,7 @@ cache size` and `dbengine multihost disk space` settings in the `[global]` secti
| Setting | Default | Description |
|--------------------------------------------|-------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `[global]` section | | |
-| `memory mode` | `dbengine` | Determines the [database type](https://github.com/netdata/netdata/blob/master/database/README.md) to be used on that node. Other options settings include `none`, `ram`, `save`, and `map`. `none` disables the database at this host. This also disables alerts and notifications, as those can't run without a database. |
+| `memory mode` | `dbengine` | Determines the [database type](https://github.com/netdata/netdata/blob/master/database/README.md) to be used on that node. Other options settings include `none`, and `ram`. `none` disables the database at this host. This also disables alerts and notifications, as those can't run without a database. |
| `[web]` section | | |
| `mode` | `static-threaded` | Determines the [web server](https://github.com/netdata/netdata/blob/master/web/server/README.md) type. The other option is `none`, which disables the dashboard, API, and registry. |
| `accept a streaming request every seconds` | `0` | Set a limit on how often a parent node accepts streaming requests from child nodes. `0` equals no limit. If this is set, you may see `... too busy to accept new streaming request. Will be allowed in X secs` in Netdata's `error.log`. |
@@ -182,7 +179,7 @@ default `dbengine` as specified by the `API_KEY`, and alerts are disabled.
[MACHINE_GUID]
enabled = yes
- memory mode = save
+ memory mode = ram
health enabled = no
```