Kiu/VictoriaMetrics
Kiu/VictoriaMetrics
1
0
Fork 0
mirror of https://github.com/VictoriaMetrics/VictoriaMetrics.git synced 2024-11-23 20:37:12 +01:00
Code Issues Actions 8 Packages Projects Releases Wiki Activity

deployment: update the README (#3447)

Browse Source 
Signed-off-by: hagen1778 <roman@victoriametrics.com>

Signed-off-by: hagen1778 <roman@victoriametrics.com>
This commit is contained in:
Roman Khavronenko 2022-12-06 07:05:31 +01:00 committed by GitHub
parent 718d1d90b6
commit 71f0bbbe39
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 25 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

48
deployment/docker/README.md
View File

@ -5,14 +5,14 @@ Docker compose environment for VictoriaMetrics includes VictoriaMetrics componen
and [Grafana](https://grafana.com/). and [Grafana](https://grafana.com/).
For starting the docker-compose environment ensure you have docker installed and running and access to the Internet. For starting the docker-compose environment ensure you have docker installed and running and access to the Internet.
All commands should be executed from the root directory of this repo. **All commands should be executed from the root directory of [the repo](https://github.com/VictoriaMetrics/VictoriaMetrics).**
To spin-up environment for single server VictoriaMetrics run the following command: To spin-up environment for single server VictoriaMetrics run the following command:
``` ```
make docker-single-up make docker-single-up
``` ```
To shutdown the docker compose environment for single server run the following command: To shut down the docker-compose environment for single server run the following command:
``` ```
make docker-single-down make docker-single-down
``` ```
@ -36,51 +36,49 @@ VictoriaMetrics will be accessible on the following ports:
* `--httpListenAddr=:8428` * `--httpListenAddr=:8428`
The communication scheme between components is the following: The communication scheme between components is the following:
* [vmagent](#vmagent) sends scraped metrics to VictoriaMetrics; * [vmagent](#vmagent) sends scraped metrics to `single server VictoriaMetrics`;
* [grafana](#grafana) is configured with datasource pointing to VictoriaMetrics; * [grafana](#grafana) is configured with datasource pointing to `single server VictoriaMetrics`;
* [vmalert](#vmalert) is configured to query VictoriaMetrics and send alerts state * [vmalert](#vmalert) is configured to query `single server VictoriaMetrics` and send alerts state
and recording rules back to it; and recording rules back to it;
* [alertmanager](#alertmanager) is configured to receive notifications from vmalert. * [alertmanager](#alertmanager) is configured to receive notifications from `vmalert`.
To access `vmalert` via `vmselect` To access `vmalert` use link [http://localhost:8428/vmalert](http://localhost:8428/vmalert/).
use link [http://localhost:8428/vmalert](http://localhost:8428/vmalert/).
To access [vmui](https://docs.victoriametrics.com/Single-server-VictoriaMetrics.html#vmui) To access [vmui](https://docs.victoriametrics.com/Single-server-VictoriaMetrics.html#vmui)
use link [http://localhost:8428/vmui](http://localhost:8428/vmui). use link [http://localhost:8428/vmui](http://localhost:8428/vmui).
## VictoriaMetrics cluster ## VictoriaMetrics cluster
VictoriaMetrics cluster environemnt consists of vminsert, vmstorage and vmselect components. vmselect VictoriaMetrics cluster environment consists of `vminsert`, `vmstorage` and `vmselect` components.
has exposed port `:8481`, vminsert has exposed port `:8480` and the rest of components are available `vmselect` has exposed port `:8481`, `vminsert` has exposed port `:8480` and the rest of components
only inside of environment. are available only inside the environment.
The communication scheme between components is the following: The communication scheme between components is the following:
* [vmagent](#vmagent) sends scraped metrics to vminsert; * [vmagent](#vmagent) sends scraped metrics to `vminsert`;
* vminsert forwards data to vmstorage; * `vminsert` forwards data to `vmstorage`;
* vmselect is connected to vmstorage for querying data; * `vmselect` is connected to `vmstorage` for querying data;
* [grafana](#grafana) is configured with datasource pointing to vmselect; * [grafana](#grafana) is configured with datasource pointing to `vmselect`;
* [vmalert](#vmalert) is configured to query vmselect and send alerts state * [vmalert](#vmalert) is configured to query `vmselect` and send alerts state
and recording rules to vminsert; and recording rules to `vminsert`;
* [alertmanager](#alertmanager) is configured to receive notifications from vmalert. * [alertmanager](#alertmanager) is configured to receive notifications from `vmalert`.
To access `vmalert` via `vmselect` To access `vmalert` use link [http://localhost:8481/select/0/prometheus/vmalert](http://localhost:8481/select/0/prometheus/vmalert/).
use link [http://localhost:8481/select/0/prometheus/vmalert](http://localhost:8481/select/0/prometheus/vmalert/).
To access [vmui](https://docs.victoriametrics.com/Single-server-VictoriaMetrics.html#vmui) To access [vmui](https://docs.victoriametrics.com/Single-server-VictoriaMetrics.html#vmui)
use link [http://localhost:8481/select/0/prometheus/vmui](http://localhost:8481/select/0/prometheus/vmui). use link [http://localhost:8481/select/0/prometheus/vmui](http://localhost:8481/select/0/prometheus/vmui).
## vmagent ## vmagent
vmagent is used for scraping and pushing timeseries to vmagent is used for scraping and pushing time series to VictoriaMetrics instance.
VictoriaMetrics instance. It accepts Prometheus-compatible It accepts Prometheus-compatible configuration [prometheus.yml](https://github.com/VictoriaMetrics/VictoriaMetrics/blob/master/deployment/docker/prometheus.yml)
configuration `prometheus.yml` with listed targets for scraping. with listed targets for scraping.
[Web interface link](http://localhost:8429/). [Web interface link](http://localhost:8429/).
## vmalert ## vmalert
vmalert evaluates alerting rules (`alerts.yml`) to track VictoriaMetrics vmalert evaluates alerting rules [alerts.yml(https://github.com/VictoriaMetrics/VictoriaMetrics/blob/master/deployment/docker/alerts.yml)
health state. It is connected with AlertManager for firing alerts, to track VictoriaMetrics health state. It is connected with AlertManager for firing alerts,
and with VictoriaMetrics for executing queries and storing alert's state. and with VictoriaMetrics for executing queries and storing alert's state.
[Web interface link](http://localhost:8880/). [Web interface link](http://localhost:8880/).