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

Readme envvars (#332)

Browse Source 
* add details about env vars config

* add env var to table of contents

* remove unnecessary words
This commit is contained in:
Edouard Hur 2020-02-25 21:41:34 +01:00 committed by GitHub
parent 6739c2749d
commit 1f0007d0b1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -73,6 +73,7 @@ Cluster version is available [here](https://github.com/VictoriaMetrics/VictoriaM
### Table of contents ### Table of contents
- [How to start VictoriaMetrics](#how-to-start-victoriametrics) - [How to start VictoriaMetrics](#how-to-start-victoriametrics)
- [Environment variables](#environment-variables)
- [Prometheus setup](#prometheus-setup) - [Prometheus setup](#prometheus-setup)
- [Grafana setup](#grafana-setup) - [Grafana setup](#grafana-setup)
- [How to upgrade VictoriaMetrics?](#how-to-upgrade-victoriametrics) - [How to upgrade VictoriaMetrics?](#how-to-upgrade-victoriametrics)
@ -137,12 +138,15 @@ The following command-line flags are used the most:
Pass `-help` to see all the available flags with description and default values. Pass `-help` to see all the available flags with description and default values.
Default flag values may be read from environment variables if `-envflag.enable` command-line flag is set.
Substitute dots with underscores in env var names. Alternative syntax can be used for setting repeatable flags:
`-arg=foo -arg=bar` can be written as `-arg=foo,bar`. See [this feature request](https://github.com/VictoriaMetrics/VictoriaMetrics/issues/311) for more details.
It is recommended setting up [monitoring](#monitoring) for VictoriaMetrics. It is recommended setting up [monitoring](#monitoring) for VictoriaMetrics.
#### Environment variables
Each flag values can be set thru environment variables by following these rules:
* The `-envflag.enable` flag must be set
* Each `.` in flag names must be substituted by `_` (for example `-insert.maxQueueDuration <duration>` will translate to `insert_maxQueueDuration=<duration>`)
* For repeating flags, an alternative syntax can be used by joining the different values into one using `,` as separator (for example `-storageNode <nodeA> -storageNode <nodeB>` will translate to `storageNode=<nodeA>,<nodeB>`)
### Prometheus setup ### Prometheus setup