From 9aa6b631603622244867b0e23a7b6269e98bfe7a Mon Sep 17 00:00:00 2001 From: Aliaksandr Valialkin Date: Mon, 13 Mar 2023 00:23:40 -0700 Subject: [PATCH] docs/Single-server-VictoriaMetrics.md: clarify that the cache directory can be removed manually when VictoriaMetrics is stopped --- docs/README.md | 9 ++++++++- docs/Single-server-VictoriaMetrics.md | 9 ++++++++- 2 files changed, 16 insertions(+), 2 deletions(-) diff --git a/docs/README.md b/docs/README.md index 9bddf58d78..0708b8aac8 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1900,7 +1900,14 @@ are added to all the metrics before sending them to the remote storage: ## Cache removal -VictoriaMetrics uses various internal caches. These caches are stored to `<-storageDataPath>/cache` directory during graceful shutdown (e.g. when VictoriaMetrics is stopped by sending `SIGINT` signal). The caches are read on the next VictoriaMetrics startup. Sometimes it is needed to remove such caches on the next startup. This can be performed by placing `reset_cache_on_startup` file inside the `<-storageDataPath>/cache` directory before the restart of VictoriaMetrics. See [this issue](https://github.com/VictoriaMetrics/VictoriaMetrics/issues/1447) for details. +VictoriaMetrics uses various internal caches. These caches are stored to `<-storageDataPath>/cache` directory during graceful shutdown +(e.g. when VictoriaMetrics is stopped by sending `SIGINT` signal). The caches are read on the next VictoriaMetrics startup. +Sometimes it is needed to remove such caches on the next startup. This can be done in the following ways: + +- By manually removing the `<-storageDataPath>/cache` directory when VictoriaMetrics is stopped. +- By placing `reset_cache_on_startup` file inside the `<-storageDataPath>/cache` directory before the restart of VictoriaMetrics. + In this case VictoriaMetrics will automatically remove all the caches on the next start. + See [this issue](https://github.com/VictoriaMetrics/VictoriaMetrics/issues/1447) for details. ## Cache tuning diff --git a/docs/Single-server-VictoriaMetrics.md b/docs/Single-server-VictoriaMetrics.md index 4d03489d03..2ec27014c4 100644 --- a/docs/Single-server-VictoriaMetrics.md +++ b/docs/Single-server-VictoriaMetrics.md @@ -1903,7 +1903,14 @@ are added to all the metrics before sending them to the remote storage: ## Cache removal -VictoriaMetrics uses various internal caches. These caches are stored to `<-storageDataPath>/cache` directory during graceful shutdown (e.g. when VictoriaMetrics is stopped by sending `SIGINT` signal). The caches are read on the next VictoriaMetrics startup. Sometimes it is needed to remove such caches on the next startup. This can be performed by placing `reset_cache_on_startup` file inside the `<-storageDataPath>/cache` directory before the restart of VictoriaMetrics. See [this issue](https://github.com/VictoriaMetrics/VictoriaMetrics/issues/1447) for details. +VictoriaMetrics uses various internal caches. These caches are stored to `<-storageDataPath>/cache` directory during graceful shutdown +(e.g. when VictoriaMetrics is stopped by sending `SIGINT` signal). The caches are read on the next VictoriaMetrics startup. +Sometimes it is needed to remove such caches on the next startup. This can be done in the following ways: + +- By manually removing the `<-storageDataPath>/cache` directory when VictoriaMetrics is stopped. +- By placing `reset_cache_on_startup` file inside the `<-storageDataPath>/cache` directory before the restart of VictoriaMetrics. + In this case VictoriaMetrics will automatically remove all the caches on the next start. + See [this issue](https://github.com/VictoriaMetrics/VictoriaMetrics/issues/1447) for details. ## Cache tuning