From 166456f3406014bff48268b23ebabcdfdd1a8782 Mon Sep 17 00:00:00 2001 From: Aliaksandr Valialkin Date: Wed, 21 Jun 2023 21:43:44 -0700 Subject: [PATCH] docs/VictoriaLogs/README.md: add `Upgrading` section --- docs/VictoriaLogs/README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/docs/VictoriaLogs/README.md b/docs/VictoriaLogs/README.md index b588b2bfd2..230ea70c82 100644 --- a/docs/VictoriaLogs/README.md +++ b/docs/VictoriaLogs/README.md @@ -37,6 +37,21 @@ vmagent (see [these docs](https://docs.victoriametrics.com/vmagent.html#how-to-c VictoriaLogs emits own logs to stdout. It is recommended investigating these logs during troubleshooting. +## Upgrading + +It is safe upgrading VictoriaLogs to new versions unless [release notes](https://github.com/VictoriaMetrics/VictoriaMetrics/releases) say otherwise. +It is safe skipping multiple versions during the upgrade unless [release notes](https://github.com/VictoriaMetrics/VictoriaMetrics/releases) say otherwise. +It is recommended performing regular upgrades to the latest version, since it may contain important bug fixes, performance optimizations or new features. + +It is also safe downgrading to older versions unless [release notes](https://github.com/VictoriaMetrics/VictoriaMetrics/releases) say otherwise. + +The following steps must be performed during the upgrade / downgrade procedure: + +* Send `SIGINT` signal to VictoriaLogs process in order to gracefully stop it. + See [how to send signals to processes](https://stackoverflow.com/questions/33239959/send-signal-to-process-from-command-line). +* Wait until the process stops. This can take a few seconds. +* Start the upgraded VictoriaMetrics. + ## Retention By default VictoriaLogs stores log entries with timestamps in the time range `[now-7d, now]`, while dropping logs outside the given time range.