From af7db914c264515df29f55049b349f9c705898ab Mon Sep 17 00:00:00 2001 From: Aliaksandr Valialkin Date: Thu, 18 Jun 2020 23:54:44 +0300 Subject: [PATCH] `make docs-sync` --- README.md | 20 +++++++++++--------- docs/Cluster-VictoriaMetrics.md | 20 +++++++++++--------- docs/vmalert.md | 4 ++++ 3 files changed, 26 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index a8b18b6fab..12e8d9066d 100644 --- a/README.md +++ b/README.md @@ -225,15 +225,6 @@ Steps to add `vmstorage` node: 3. Gradually restart all the `vminsert` nodes with new `-storageNode` arg containing `:8400`. -### Cluster availability - -* HTTP load balancer must stop routing requests to unavailable `vminsert` and `vmselect` nodes. -* The cluster remains available if at least a single `vmstorage` node exists: - - - `vminsert` re-routes incoming data from unavailable `vmstorage` nodes to healthy `vmstorage` nodes - - `vmselect` continues serving partial responses if at least a single `vmstorage` node is available. - - ### Updating / reconfiguring cluster nodes All the node types - `vminsert`, `vmselect` and `vmstorage` - may be updated via graceful shutdown. @@ -244,6 +235,17 @@ Cluster should remain in working state if at least a single node of each type re the update process. See [cluster availability](#cluster-availability) section for details. +### Cluster availability + +* HTTP load balancer must stop routing requests to unavailable `vminsert` and `vmselect` nodes. +* The cluster remains available if at least a single `vmstorage` node exists: + + - `vminsert` re-routes incoming data from unavailable `vmstorage` nodes to healthy `vmstorage` nodes + - `vmselect` continues serving partial responses if at least a single `vmstorage` node is available. + +Data replication can be used for increasing storage durability. See [these docs](#replication-and-data-safety) for details. + + ### Capacity planning Each instance type - `vminsert`, `vmselect` and `vmstorage` - can run on the most suitable hardware. diff --git a/docs/Cluster-VictoriaMetrics.md b/docs/Cluster-VictoriaMetrics.md index a8b18b6fab..12e8d9066d 100644 --- a/docs/Cluster-VictoriaMetrics.md +++ b/docs/Cluster-VictoriaMetrics.md @@ -225,15 +225,6 @@ Steps to add `vmstorage` node: 3. Gradually restart all the `vminsert` nodes with new `-storageNode` arg containing `:8400`. -### Cluster availability - -* HTTP load balancer must stop routing requests to unavailable `vminsert` and `vmselect` nodes. -* The cluster remains available if at least a single `vmstorage` node exists: - - - `vminsert` re-routes incoming data from unavailable `vmstorage` nodes to healthy `vmstorage` nodes - - `vmselect` continues serving partial responses if at least a single `vmstorage` node is available. - - ### Updating / reconfiguring cluster nodes All the node types - `vminsert`, `vmselect` and `vmstorage` - may be updated via graceful shutdown. @@ -244,6 +235,17 @@ Cluster should remain in working state if at least a single node of each type re the update process. See [cluster availability](#cluster-availability) section for details. +### Cluster availability + +* HTTP load balancer must stop routing requests to unavailable `vminsert` and `vmselect` nodes. +* The cluster remains available if at least a single `vmstorage` node exists: + + - `vminsert` re-routes incoming data from unavailable `vmstorage` nodes to healthy `vmstorage` nodes + - `vmselect` continues serving partial responses if at least a single `vmstorage` node is available. + +Data replication can be used for increasing storage durability. See [these docs](#replication-and-data-safety) for details. + + ### Capacity planning Each instance type - `vminsert`, `vmselect` and `vmstorage` - can run on the most suitable hardware. diff --git a/docs/vmalert.md b/docs/vmalert.md index a0df4de7bd..be6830791c 100644 --- a/docs/vmalert.md +++ b/docs/vmalert.md @@ -20,6 +20,7 @@ may fail; * by default, rules execution is sequential within one group, but persisting of execution results to remote storage is asynchronous. Hence, user shouldn't rely on recording rules chaining when result of previous recording rule is reused in next one; +* there is no `query` function support in templates yet; * `vmalert` has no UI, just an API for getting groups and rules statuses. ### QuickStart @@ -85,6 +86,9 @@ and to send notifications about firing alerts to [Alertmanager](https://github.c Recording rules allow you to precompute frequently needed or computationally expensive expressions and save their result as a new set of time series. +`vmalert` forbids to define duplicates - rules with the same combination of name, expression and labels +within one group. + ##### Alerting rules The syntax for alerting rule is following: