github-mirrors/VictoriaMetrics
1
0
Fork 0
mirror of https://github.com/VictoriaMetrics/VictoriaMetrics.git synced 2025-03-11 15:34:56 +00:00
Code Issues Projects Releases Packages Wiki Activity

vmalert: adjust topologies docs in README (#1893)

Browse source 
Commit changes images width and order in topologies section
for better readability.

Signed-off-by: hagen1778 <roman@victoriametrics.com>
This commit is contained in:
Roman Khavronenko 2021-12-02 10:27:46 +02:00 committed by Aliaksandr Valialkin
parent 60a83fefbc
commit fc4e59ec1d
No known key found for this signature in database
GPG key ID: A72BEC6CD3D0DED1
2 changed files with 54 additions and 46 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

50
app/vmalert/README.md
View file

@ -256,7 +256,8 @@ you have recording rules or want to store [alerts state](#alerts-state-on-restar
#### Single-node VictoriaMetrics #### Single-node VictoriaMetrics
<img alt="vmalert single" src="vmalert_single.png"> The simplest configuration where one single-node VM server is used for
rules execution, storing recording rules results and alerts state.
`vmalert` configuration flags: `vmalert` configuration flags:
``` ```
@ -267,12 +268,16 @@ you have recording rules or want to store [alerts state](#alerts-state-on-restar
-notifier.url=http://alertmanager:9093 # AlertManager addr to send alerts when they trigger -notifier.url=http://alertmanager:9093 # AlertManager addr to send alerts when they trigger
``` ```
The simplest configuration where one single-node VM server is used for <img alt="vmalert single" width="500" src="vmalert_single.png">
rules execution, storing recording rules results and alerts state.
#### Cluster VictoriaMetrics #### Cluster VictoriaMetrics
<img alt="vmalert cluster" src="vmalert_cluster.png"> In [cluster mode](https://docs.victoriametrics.com/Cluster-VictoriaMetrics.html)
VictoriaMetrics has separate components for writing and reading path:
`vminsert` and `vmselect` components respectively. `vmselect` is used for executing rules expressions
and `vminsert` is used to persist recording rules results and alerts state.
Cluster mode could have multiple `vminsert` and `vmselect` components.
`vmalert` configuration flags: `vmalert` configuration flags:
``` ```
@ -283,18 +288,18 @@ rules execution, storing recording rules results and alerts state.
-notifier.url=http://alertmanager:9093 # AlertManager addr to send alerts when they trigger -notifier.url=http://alertmanager:9093 # AlertManager addr to send alerts when they trigger
``` ```
In [cluster mode](https://docs.victoriametrics.com/Cluster-VictoriaMetrics.html) <img alt="vmalert cluster" src="vmalert_cluster.png">
VictoriaMetrics has separate components for writing and reading path:
`vminsert` and `vmselect` components respectively. `vmselect` is used for executing rules expressions In case when you want to spread the load on these components - add balancers before them and configure
and `vminsert` is used to persist recording rules results and alerts state.
Cluster mode could have multiple `vminsert` and `vmselect` components. In case when you want
to spread the load on these components - add balancers before them and configure
`vmalert` with balancer's addresses. Please, see more about VM's cluster architecture `vmalert` with balancer's addresses. Please, see more about VM's cluster architecture
[here](https://docs.victoriametrics.com/Cluster-VictoriaMetrics.html#architecture-overview). [here](https://docs.victoriametrics.com/Cluster-VictoriaMetrics.html#architecture-overview).
#### vmalert high availability #### HA vmalert
<img alt="vmalert ha" src="vmalert_ha.png"> For HA user can run multiple identically configured `vmalert` instances.
It means all of them will execute the same rules, write state and results to
the same destinations, and send alert notifications to multiple configured
Alertmanagers.
`vmalert` configuration flags: `vmalert` configuration flags:
``` ```
@ -306,10 +311,7 @@ to spread the load on these components - add balancers before them and configure
-notifier.url=http://alertmanagerN:9093 # The same alert will be sent to all configured notifiers -notifier.url=http://alertmanagerN:9093 # The same alert will be sent to all configured notifiers
``` ```
For HA user can run multiple identically configured `vmalert` instances. <img alt="vmalert ha" width="800px" src="vmalert_ha.png">
It means all of them will execute the same rules, write state and results to
the same destinations, and send alert notifications to multiple configured
Alertmanagers.
To avoid recording rules results and alerts state duplication in VictoriaMetrics server To avoid recording rules results and alerts state duplication in VictoriaMetrics server
don't forget to configure [deduplication](https://docs.victoriametrics.com/Single-server-VictoriaMetrics.html#deduplication). don't forget to configure [deduplication](https://docs.victoriametrics.com/Single-server-VictoriaMetrics.html#deduplication).
@ -323,9 +325,15 @@ for Alertmanagers for better reliability.
This example uses single-node VM server for the sake of simplicity. This example uses single-node VM server for the sake of simplicity.
Check how to replace it with [cluster VictoriaMetrics](#cluster-victoriametrics) if needed. Check how to replace it with [cluster VictoriaMetrics](#cluster-victoriametrics) if needed.
#### Downsampling and aggregation via vmalert #### Downsampling and aggregation via vmalert
<img alt="vmalert multi cluster" src="vmalert_multicluster.png"> Example shows how to build a topology where `vmalert` will process data from one cluster
and write results into another. Such clusters may be called as "hot" (low retention,
high-speed disks, used for operative monitoring) and "cold" (long term retention,
slower/cheaper disks, low resolution data). With help of `vmalert`, user can setup
recording rules to process raw data from "hot" cluster (by applying additional transformations
or reducing resolution) and push results to "cold" cluster.
`vmalert` configuration flags: `vmalert` configuration flags:
``` ```
@ -334,17 +342,13 @@ Check how to replace it with [cluster VictoriaMetrics](#cluster-victoriametrics)
-remoteWrite.url=http://aggregated-cluster-vminsert:8480/insert/0/prometheuss # vminsert addr to persist recording rules results -remoteWrite.url=http://aggregated-cluster-vminsert:8480/insert/0/prometheuss # vminsert addr to persist recording rules results
``` ```
Example shows how to build a topology where `vmalert` will process data from one cluster <img alt="vmalert multi cluster" src="vmalert_multicluster.png">
and write results into another. Such clusters may be called as "hot" (low retention,
high-speed disks, used for operative monitoring) and "cold" (long term retention,
slower/cheaper disks, low resolution data). With help of `vmalert`, user can setup
recording rules to process raw data from "hot" cluster (by applying additional transformations
or reducing resolution) and push results to "cold" cluster.
Please note, [replay](#rules-backfilling) feature may be used for transforming historical data. Please note, [replay](#rules-backfilling) feature may be used for transforming historical data.
Flags `-remoteRead.url` and `-notifier.url` are omitted since we assume only recording rules are used. Flags `-remoteRead.url` and `-notifier.url` are omitted since we assume only recording rules are used.
### Web ### Web
`vmalert` runs a web-server (`-httpListenAddr`) for serving metrics and alerts endpoints: `vmalert` runs a web-server (`-httpListenAddr`) for serving metrics and alerts endpoints:

50
docs/vmalert.md
View file

@ -260,7 +260,8 @@ you have recording rules or want to store [alerts state](#alerts-state-on-restar
#### Single-node VictoriaMetrics #### Single-node VictoriaMetrics
<img alt="vmalert single" src="vmalert_single.png"> The simplest configuration where one single-node VM server is used for
rules execution, storing recording rules results and alerts state.
`vmalert` configuration flags: `vmalert` configuration flags:
``` ```
@ -271,12 +272,16 @@ you have recording rules or want to store [alerts state](#alerts-state-on-restar
-notifier.url=http://alertmanager:9093 # AlertManager addr to send alerts when they trigger -notifier.url=http://alertmanager:9093 # AlertManager addr to send alerts when they trigger
``` ```
The simplest configuration where one single-node VM server is used for <img alt="vmalert single" width="500" src="vmalert_single.png">
rules execution, storing recording rules results and alerts state.
#### Cluster VictoriaMetrics #### Cluster VictoriaMetrics
<img alt="vmalert cluster" src="vmalert_cluster.png"> In [cluster mode](https://docs.victoriametrics.com/Cluster-VictoriaMetrics.html)
VictoriaMetrics has separate components for writing and reading path:
`vminsert` and `vmselect` components respectively. `vmselect` is used for executing rules expressions
and `vminsert` is used to persist recording rules results and alerts state.
Cluster mode could have multiple `vminsert` and `vmselect` components.
`vmalert` configuration flags: `vmalert` configuration flags:
``` ```
@ -287,18 +292,18 @@ rules execution, storing recording rules results and alerts state.
-notifier.url=http://alertmanager:9093 # AlertManager addr to send alerts when they trigger -notifier.url=http://alertmanager:9093 # AlertManager addr to send alerts when they trigger
``` ```
In [cluster mode](https://docs.victoriametrics.com/Cluster-VictoriaMetrics.html) <img alt="vmalert cluster" src="vmalert_cluster.png">
VictoriaMetrics has separate components for writing and reading path:
`vminsert` and `vmselect` components respectively. `vmselect` is used for executing rules expressions In case when you want to spread the load on these components - add balancers before them and configure
and `vminsert` is used to persist recording rules results and alerts state.
Cluster mode could have multiple `vminsert` and `vmselect` components. In case when you want
to spread the load on these components - add balancers before them and configure
`vmalert` with balancer's addresses. Please, see more about VM's cluster architecture `vmalert` with balancer's addresses. Please, see more about VM's cluster architecture
[here](https://docs.victoriametrics.com/Cluster-VictoriaMetrics.html#architecture-overview). [here](https://docs.victoriametrics.com/Cluster-VictoriaMetrics.html#architecture-overview).
#### vmalert high availability #### HA vmalert
<img alt="vmalert ha" src="vmalert_ha.png"> For HA user can run multiple identically configured `vmalert` instances.
It means all of them will execute the same rules, write state and results to
the same destinations, and send alert notifications to multiple configured
Alertmanagers.
`vmalert` configuration flags: `vmalert` configuration flags:
``` ```
@ -310,10 +315,7 @@ to spread the load on these components - add balancers before them and configure
-notifier.url=http://alertmanagerN:9093 # The same alert will be sent to all configured notifiers -notifier.url=http://alertmanagerN:9093 # The same alert will be sent to all configured notifiers
``` ```
For HA user can run multiple identically configured `vmalert` instances. <img alt="vmalert ha" width="800px" src="vmalert_ha.png">
It means all of them will execute the same rules, write state and results to
the same destinations, and send alert notifications to multiple configured
Alertmanagers.
To avoid recording rules results and alerts state duplication in VictoriaMetrics server To avoid recording rules results and alerts state duplication in VictoriaMetrics server
don't forget to configure [deduplication](https://docs.victoriametrics.com/Single-server-VictoriaMetrics.html#deduplication). don't forget to configure [deduplication](https://docs.victoriametrics.com/Single-server-VictoriaMetrics.html#deduplication).
@ -327,9 +329,15 @@ for Alertmanagers for better reliability.
This example uses single-node VM server for the sake of simplicity. This example uses single-node VM server for the sake of simplicity.
Check how to replace it with [cluster VictoriaMetrics](#cluster-victoriametrics) if needed. Check how to replace it with [cluster VictoriaMetrics](#cluster-victoriametrics) if needed.
#### Downsampling and aggregation via vmalert #### Downsampling and aggregation via vmalert
<img alt="vmalert multi cluster" src="vmalert_multicluster.png"> Example shows how to build a topology where `vmalert` will process data from one cluster
and write results into another. Such clusters may be called as "hot" (low retention,
high-speed disks, used for operative monitoring) and "cold" (long term retention,
slower/cheaper disks, low resolution data). With help of `vmalert`, user can setup
recording rules to process raw data from "hot" cluster (by applying additional transformations
or reducing resolution) and push results to "cold" cluster.
`vmalert` configuration flags: `vmalert` configuration flags:
``` ```
@ -338,17 +346,13 @@ Check how to replace it with [cluster VictoriaMetrics](#cluster-victoriametrics)
-remoteWrite.url=http://aggregated-cluster-vminsert:8480/insert/0/prometheuss # vminsert addr to persist recording rules results -remoteWrite.url=http://aggregated-cluster-vminsert:8480/insert/0/prometheuss # vminsert addr to persist recording rules results
``` ```
Example shows how to build a topology where `vmalert` will process data from one cluster <img alt="vmalert multi cluster" src="vmalert_multicluster.png">
and write results into another. Such clusters may be called as "hot" (low retention,
high-speed disks, used for operative monitoring) and "cold" (long term retention,
slower/cheaper disks, low resolution data). With help of `vmalert`, user can setup
recording rules to process raw data from "hot" cluster (by applying additional transformations
or reducing resolution) and push results to "cold" cluster.
Please note, [replay](#rules-backfilling) feature may be used for transforming historical data. Please note, [replay](#rules-backfilling) feature may be used for transforming historical data.
Flags `-remoteRead.url` and `-notifier.url` are omitted since we assume only recording rules are used. Flags `-remoteRead.url` and `-notifier.url` are omitted since we assume only recording rules are used.
### Web ### Web
`vmalert` runs a web-server (`-httpListenAddr`) for serving metrics and alerts endpoints: `vmalert` runs a web-server (`-httpListenAddr`) for serving metrics and alerts endpoints: