VictoriaMetrics/deployment/docker/README.md

Docker compose environment for VictoriaMetrics

Docker compose environment for VictoriaMetrics includes VictoriaMetrics components, Alertmanager and Grafana.

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 the repo.

To spin-up environment with VictoriaMetrics components run one of the following commands:

make docker-single-up  # start single server VictoriaMetrics 
 or
make docker-cluster-up # start cluster VictoriaMetrics 

To shut down the docker-compose environment run one the following commands:

make docker-single-down # shutdown single server VictoriaMetrics 
 or
make docker-cluster-down # shutdown cluster VictoriaMetrics 

Optionally, environment with VictoriaMetrics Grafana datasource can be started with the following commands:

make docker-single-vm-datasource-up    # start single server
make docker-single-vm-datasource-down  # shut down single server

make docker-cluster-vm-datasource-up   # start cluster
make docker-cluster-vm-datasource-down # shutdown cluster

VictoriaMetrics single server

VictoriaMetrics will be accessible on the following ports:

• --graphiteListenAddr=:2003
• --opentsdbListenAddr=:4242
• --httpListenAddr=:8428

The communication scheme between components is the following:

• vmagent sends scraped metrics to single server VictoriaMetrics;
• grafana is configured with datasource pointing to single server VictoriaMetrics;
• vmalert is configured to query single server VictoriaMetrics and send alerts state and recording rules back to it;
• alertmanager is configured to receive notifications from vmalert.

To access Grafana use link http://localhost:3000.

To access vmui use link http://localhost:8428/vmui.

To access vmalert use link http://localhost:8428/vmalert.

VictoriaMetrics cluster

VictoriaMetrics cluster environment consists of vminsert, vmstorage and vmselect components. vminsert has exposed port :8480, access to vmselect components goes through vmauth on port :8427, and the rest of components are available only inside the environment.

The communication scheme between components is the following:

• vmagent sends scraped metrics to vminsert;
• vminsert forwards data to vmstorage;
• vmselects are connected to vmstorage for querying data;
• vmauth balances incoming read requests among vmselects;
• grafana is configured with datasource pointing to vmauth;
• vmalert is configured to query vmselects via vmauth and send alerts state and recording rules to vminsert;
• alertmanager is configured to receive notifications from vmalert.

To access Grafana use link http://localhost:3000.

To access vmui use link http://localhost:8427/select/0/prometheus/vmui/.

To access vmalert use link http://localhost:8427/select/0/prometheus/vmalert/.

vmagent

vmagent is used for scraping and pushing time series to VictoriaMetrics instance. It accepts Prometheus-compatible configuration prometheus.yml with listed targets for scraping.

Web interface link.

vmauth

vmauth acts as a balancer to spread the load across vmselect's. Grafana and vmalert use vmauth for read queries. vmauth config is available here

vmalert

vmalert evaluates alerting rules alerts.yml to track VictoriaMetrics health state. It is connected with AlertManager for firing alerts, and with VictoriaMetrics for executing queries and storing alert's state.

Web interface link.

alertmanager

AlertManager accepts notifications from vmalert and fires alerts. All notifications are blackholed according to alertmanager.yml config.

Web interface link.

Grafana

To access service open following link.

Default credential:

• login - admin
• password - admin

Grafana is provisioned by default with following entities:

• VictoriaMetrics datasource
• VictoriaMetrics - cluster datasource
• VictoriaMetrics overview dashboard
• VictoriaMetrics - cluster dashboard
• VictoriaMetrics - vmagent dashboard
• VictoriaMetrics - vmalert dashboard

Remember to pick VictoriaMetrics - cluster datasource when viewing VictoriaMetrics - cluster dashboard.

If environment was started via docker-single-vm-datasource-up or docker-cluster-vm-datasource-up, then Grafana will have VictoriaMetrics Grafana datasource installed by default.

Alerts

See below a list of recommended alerting rules for various VictoriaMetrics components for running in production. Some of the alerting rules thresholds are just recommendations and could require an adjustment. The list of alerting rules is the following:

• alerts-health.yml: alerting rules related to all VictoriaMetrics components for tracking their "health" state;
• alerts.yml: alerting rules related to single-server VictoriaMetrics installation;
• alerts-cluster.yml: alerting rules related to cluster version of VictoriaMetrics;
• alerts-vmagent.yml: alerting rules related to vmagent component;
• alerts-vmalert.yml: alerting rules related to vmalert component;

Please, also see how to monitor VictoriaMetrics installations.

VictoriaLogs server

VictoriaLogs will be accessible on the following port: --httpListenAddr=:9428

Fluent Bit is used to send logs to VictoriaLogs instance. Fluent Bit is configured to send logs from running containers to VictoriaLogs instance. Additionally, it is configured to listen for syslog logs on port 5140 and send them to VictoriaLogs instance.

To access VictoriaLogs UI use link http://localhost:9428/select/vmui/.

Please, also see how to monitor VictoriaLogs installations.