Configuration parameters

Lisa Vaysman

This article describes the parameters that can be configured for ADM services via ADCM. To read about the configuring process, refer to the relevant articles for online and offline installation.

NOTE
Some of the parameters become visible in the ADCM UI after the Show advanced flag being set.

Grafana

Parameter Description Default value

Grafana data path

Path to the Grafana data storage on the host where Grafana is deployed. If changed, the changes apply only after performing the Uninstall and then Install service actions

/opt/adm/grafana/data

Grafana provisioning path

Path to the Grafana provisioning files on the host where Grafana is deployed. If changed, the changes apply only after performing the Uninstall and then Install service actions

/opt/adm/grafana/provisioning

Grafana port

HTTP port for the Grafana web interface

3000

Admin username

Grafana administrator username used to log in to the Grafana web interface

admin

Admin password

Password for the Grafana administrator. ADCM uses it to automatically create credentials (a system user and its API token) for dashboard synchronization

 — 

VictoriaMetrics

Replication Settings
Parameter Description Default value

Replication Factor

Number of the hosts with the VictoriaMetrics Storage component used for replicating each metric.

For details on replication factor calculations depending on the hosts number, see Add components (online installation) or Add components (offline installation)

2

Deduplication Interval

The deduplication interval that, when configured correctly, prevents the overlapping of duplicate metric points, which can result in a sawtooth pattern on your Grafana dashboards.

It is recommended to keep the default value (1ms) to ensure stable cluster replication out of the box. You can change this value to match the scrape interval of your metrics source, if necessary.

Large deduplication intervals (e.g. 1m or higher) increase memory consumption on hosts with the VictoriaMetrics Storage and VictoriaMetrics Select components installed, as the system must buffer more data to compare and deduplicate incoming metrics.

Format value using ms (milliseconds), s (seconds), m (minutes), or h (hours). Example: 1ms. Combined values are not supported (e.g. 1s500ms is invalid). Entering an invalid value will result in the VictoriaMetrics service failing to run

1ms
Storage Settings
Parameter Description Default value

Retention Period

Metrics retention period. Metrics older than this value are automatically deleted from the storage.

The minimum retention period supported by VictoriaMetrics is 1 day (1d) or 24 hours (24h).

Indefinite retention is not supported by VictoriaMetrics. To retain data long-term, specify an arbitrarily high duration, such as 100 years (100y).

Format value using d (days), w (weeks), M (months), or y (years). Combined values are also supported. Examples: 7d, 2w, 1M, 1y, 1M2w.

If you reduce the retention period, data older than the new limit is not deleted instantly upon service restart. VictoriaMetrics removes expired metrics gradually in the background

1M

Storage Data Path

Path to the VictoriaMetrics Storage data on the host where the VictoriaMetrics Storage component is deployed.

If changed, the changes apply only after restarting the VictoriaMetrics Storage component. See the VictoriaMetrics service actions

To change the storage location without losing metrics history, stop the VictoriaMetrics Storage component and copy the data directory to the new location (e.g. using rsync). Then, update this parameter in ADCM and start the VictoriaMetrics Storage component. VictoriaMetrics will automatically recognize and load the historical data from the new path

/opt/adm/vmstorage/data
Ports Configuration
Parameter Description Default value

vminsert HTTP Port

HTTP port used by the VictoriaMetrics Insert component to accept incoming metrics from agents like vmagent or Prometheus via the Prometheus-compatible remote_write protocol

8480

vmselect HTTP Port

HTTP port used by the VictoriaMetrics Select component to accept PromQL queries from visualization tools like Grafana

8481

vmstorage HTTP Port

HTTP port used by the VictoriaMetrics Storage component to handle health checks and self-monitoring metrics requests

8482

vmstorage vminsert RPC Port

TCP port used by the VictoriaMetrics Storage component to receive incoming metrics data from the VictoriaMetrics Insert component via an internal RPC protocol

8400

vmstorage vmselect RPC Port

TCP port used by the VictoriaMetrics Storage component to accept data read requests from the VictoriaMetrics Select component via an internal RPC protocol

8401
Security settings
Parameter Description Default value

pprof_authkey

The authentication key used to restrict access to the built-in Go profiler (/debug/pprof/) endpoints on the VictoriaMetrics Insert, VictoriaMetrics Select, and VictoriaMetrics Storage components.

ADCM always stores this key encrypted with Ansible Vault, so the ADCM UI displays it as a string starting with $ANSIBLE_VAULT;1.1;AES256. You can manage the key as follows:

  • Authentication. To authenticate requests to the profiler, pass the decrypted key as an HTTP Authorization header or as an authKey query parameter. The query parameter takes priority.

    URL template:

    http://<host>:<port>/debug/pprof/?authKey=<decrypted_key>

    Example: http://10.92.40.169:8482/debug/pprof/?authKey=xLUPib7YKNQuz0l6X9TrbncF

    Where:

    • <host> is the host address where the corresponding VictoriaMetrics component is deployed.

    • <port> is a port number of the corresponding VictoriaMetrics component (see Ports Configuration).

    • <decrypted_key> is the plaintext value of the key. To find it, log in to the host via SSH and run ps aux | grep pprofAuthKey.

  • Changing the key. Enter any plaintext string to use as the new authentication key. It will be encrypted by ADCM automatically.

     
    Leaving the key value empty disables authentication, making the profiling endpoints publicly accessible without a password.

 — 
Found a mistake? Seleсt text and press Ctrl+Enter to report it