From b297fec51541c0324153a93b16ce6a17b040f44e Mon Sep 17 00:00:00 2001 From: Aliaksandr Valialkin Date: Mon, 20 Jan 2020 13:28:14 +0200 Subject: [PATCH] README.md: mention that `delete API` shouldnt be used on a regular basis due to non-zero overhead --- docs/Single-server-VictoriaMetrics.md | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/docs/Single-server-VictoriaMetrics.md b/docs/Single-server-VictoriaMetrics.md index 56b684f0d..8ffbbe077 100644 --- a/docs/Single-server-VictoriaMetrics.md +++ b/docs/Single-server-VictoriaMetrics.md @@ -8,8 +8,10 @@ in [source code](https://github.com/VictoriaMetrics/VictoriaMetrics). Just downl Cluster version is available [here](https://github.com/VictoriaMetrics/VictoriaMetrics/tree/cluster). -## Case studies +## Case studies and talks +* [Adidas](https://github.com/VictoriaMetrics/VictoriaMetrics/wiki/CaseStudies#adidas) +* [COLOPL](https://github.com/VictoriaMetrics/VictoriaMetrics/wiki/CaseStudies#colopl) * [Wix.com](https://github.com/VictoriaMetrics/VictoriaMetrics/wiki/CaseStudies#wixcom) * [Wedos.com](https://github.com/VictoriaMetrics/VictoriaMetrics/wiki/CaseStudies#wedoscom) * [Dreamteam](https://github.com/VictoriaMetrics/VictoriaMetrics/wiki/CaseStudies#dreamteam) @@ -520,6 +522,19 @@ the deleted time series isn't freed instantly - it is freed during subsequent me It is recommended verifying which metrics will be deleted with the call to `http://:8428/api/v1/series?match[]=` before actually deleting the metrics. +The delete API is intended mainly for the following cases: + +- One-off deleting of accidentally written invalid (or undesired) time series. +- One-off deleting of user data due to [GDPR](https://en.wikipedia.org/wiki/General_Data_Protection_Regulation). + +It isn't recommended using delete API for the following cases, since it brings non-zero overhead: + +- Regular cleanups for unneded data. Just prevent writing unneeded data into VictoriaMetrics. +- Reducing disk space usage by deleting unneded time series. This doesn't work as expected, since the deleted + time series occupy disk space until the next merge operation, which can never occur. + +It is better using `-retentionPeriod` command-line flag for efficient pruning of old data. + ### How to export time series? @@ -767,6 +782,7 @@ The most interesting metrics are: ### Backfilling +VictoriaMetrics accepts historical data in arbitrary order of time. Make sure that configured `-retentionPeriod` covers timestamps for the backfilled data. It is recommended disabling query cache with `-search.disableCache` command-line flag when writing