VictoriaMetrics

https://docs.victoriametrics.com/victoriametrics/
Admin
VictoriaMetrics is a fast, cost-effective, and scalable monitoring solution and time series database...
Tokens:420,010
Snippets:6,960
Trust Score:10
Update:1 month ago
Show doc for...
Tokens:
Raw
### Configure vmagent Kafka topics and brokers via CLI

Source: https://docs.victoriametrics.com/victoriametrics/integrations/kafka/index.html

Example of starting vmagent to consume from multiple Kafka topics with specific broker lists.

```bash
      ./bin/vmagent 
      -kafka.consumer.topic='topic-a' 
      -kafka.consumer.topic.brokers='host1:9092;host2:9092' 
      -kafka.consumer.topic='topic-b' 
      -kafka.consumer.topic.brokers='host3:9092;host4:9092'
```

--------------------------------

### Start vmgateway

Source: https://docs.victoriametrics.com/victoriametrics/vmgateway/index.html

Command to start vmgateway with license, authentication, and read/write URLs.

```bash
      ./bin/vmgateway -licenseFile=/path/to/vm-license -enable.auth -read.url http://localhost:8428 --write.url http://localhost:8428
```

--------------------------------

### Configure Backup Retention Policy

Source: https://docs.victoriametrics.com/victoriametrics/vmbackupmanager/index.html

Example command to start the backup manager with a daily retention policy of 3 backups.

```bash
      export NODE_IP=192.168.0.10
export VMSTORAGE_ENDPOINT=http://127.0.0.1:8428
./vmbackupmanager -dst=gs://vmstorage-data/$NODE_IP -credsFilePath=credentials.json -storageDataPath=/vmstorage-data -snapshot.createURL=$VMSTORAGE_ENDPOINT/snapshot/create
-keepLastDaily=3 -licenseFile=/path/to/vm-license
    
```

--------------------------------

### Configure vmagent cluster with replication

Source: https://docs.victoriametrics.com/victoriametrics/vmagent/index.html

Example commands to start a three-instance cluster where each target is scraped by two instances.

```bash
/path/to/vmagent -promscrape.cluster.membersCount=3 -promscrape.cluster.replicationFactor=2 -promscrape.cluster.memberNum=0 -promscrape.config=/path/to/config.yml ...
/path/to/vmagent -promscrape.cluster.membersCount=3 -promscrape.cluster.replicationFactor=2 -promscrape.cluster.memberNum=1 -promscrape.config=/path/to/config.yml ...
/path/to/vmagent -promscrape.cluster.membersCount=3 -promscrape.cluster.replicationFactor=2 -promscrape.cluster.memberNum=2 -promscrape.config=/path/to/config.yml ...
```

--------------------------------

### Install and Start Windows Service

Source: https://docs.victoriametrics.com/victoriametrics/index.html

PowerShell commands to install the WinSW service configuration and start the VictoriaMetrics service.

```powershell
winsw install VictoriaMetrics.xml
Get-Service VictoriaMetrics | Start-Service
```

--------------------------------

### Install VictoriaMetrics via Snap

Source: https://docs.victoriametrics.com/victoriametrics/changelog/changelog_2020/index.html

Use this command to install a single-node VictoriaMetrics instance on Ubuntu systems.

```bash
snap install victoriametrics
```

--------------------------------

### Start and enable Single Node service

Source: https://docs.victoriametrics.com/victoriametrics/quick-start/index.html

Reload systemd configuration and enable the service to start on boot.

```bash
      sudo systemctl daemon-reload && sudo systemctl enable --now victoriametrics.service
    
```

--------------------------------

### Install VictoriaMetrics-k8s-stack Helm Chart

Source: https://docs.victoriametrics.com/victoriametrics-cloud/how-to-monitor-k8s/index.html

Installs the victoria-metrics-k8s-stack Helm chart using the specified namespace and configuration file. Ensure the namespace matches the one created earlier.

```bash
helm --namespace monitoring install vm vm/victoria-metrics-k8s-stack -f dbaas.yaml -n monitoring
```

--------------------------------

### Configure and Start VictoriaMetrics Gateway

Source: https://docs.victoriametrics.com/victoriametrics/vmgateway/index.html

Commands to set up scrape configurations, start cluster components, define rate limits, and launch the gateway.

```bash
cat << EOF > cluster.yaml
scrape_configs:
  - job_name: cluster
    scrape_interval: 5s
    static_configs:
    - targets: ['127.0.0.1:8481','127.0.0.1:8482','127.0.0.1:8480']
EOF

./bin/victoria-metrics --promscrape.config cluster.yaml

./bin/vmstorage -licenseFile=/path/to/vm-license
./bin/vmselect -licenseFile=/path/to/vm-license -storageNode 127.0.0.1:8401
./bin/vminsert -licenseFile=/path/to/vm-license -storageNode 127.0.0.1:8400

cat << EOF > limit.yaml
limits:
  - type: queries
    value: 100
  - type: rows_inserted
    value: 100000
  - type: new_series
    value: 1000
  - type: active_series
    value: 100000
  - type: queries
    value: 1
    account_id: 15
EOF

./bin/vmgateway -licenseFile=/path/to/vm-license -enable.rateLimit -ratelimit.config limit.yaml -datasource.url http://localhost:8428 -enable.auth -clusterMode -write.url=http://localhost:8480 --read.url=http://localhost:8481
```

--------------------------------

### View vmestimator help

Source: https://docs.victoriametrics.com/victoriametrics/vmestimator

Run this command to display all available configuration options and their default values.

```bash
      Usage of ./bin/vmestimator:
  -cardinalityMetrics.cacheTTL duration
        Duration for caching cardinality metrics response (default 30s)
  -cardinalityMetrics.exposeAt string
        HTTP path for exposing cardinality metrics. If set to the default /metrics, cardinality metrics are merged with regular metrics and exposed together. If set to a different path, only cardinality metrics are exposed at that endpoint. If set to an empty value, cardinality metrics are not exposed via HTTP at all. (default "/metrics")
  -cardinalityMetrics.minCardinality uint
        Minimum cardinality estimate to expose. Estimates below this threshold are suppressed to reduce metric volume and noise. Set to 0 to expose all estimates (default 0).
  -config string
        Path to YAML configuration file. Must be set unless -storageNode is specified. See https://github.com/VictoriaMetrics/vmestimator/blob/main/streams.yaml for config example
  -deduplication.interval duration
        Time window for deduplication. When set, time series already seen within the window are dropped before being forwarded to estimators. Disabled when set to 0.
  -deduplication.maxSize int
        Maximum number of unique time series the deduplicator tracks. Pass-through begins at 80% of this limit so bloom filters never saturate and start producing false positives. Defaults to a value derived from 5 percent of allowed memory. When both -deduplication.maxSizeBytes and -deduplication.maxSize are set, the stricter limit is used.
  -deduplication.maxSizeBytes size
        Memory budget for deduplication bloom filters, e.g. 100MB. Controls how many unique time series can be tracked before the deduplicator gradually switches to pass-through mode. Pass-through starts at 80% of the limit to keep bloom filters well below saturation. Defaults to 5 percent of allowed memory. When both -deduplication.maxSizeBytes and -deduplication.maxSize are set, the stricter limit is used.
        Supports the following optional suffixes for size values: KB, MB, GB, TB, KiB, MiB, GiB, TiB (default 0)
  -enableTCP6
        Whether to enable IPv6 for listening and dialing. By default, only IPv4 TCP and UDP are used
  -envflag.enable
        Whether to enable reading flags from environment variables in addition to the command line. Command line flag values have priority over values from environment vars. Flags are read only from the command line if this flag isn't set. See https://docs.victoriametrics.com/victoriametrics/single-server-victoriametrics/#environment-variables for more details
  -envflag.prefix string
        Prefix for environment variables if -envflag.enable is set
  -filestream.disableFadvise
        Whether to disable fadvise() syscall when reading large data files. The fadvise() syscall prevents from eviction of recently accessed data from OS page cache during background merges and backups. In some rare cases it is better to disable the syscall if it uses too much CPU
  -flagsAuthKey value
        Auth key for /flags endpoint. It must be passed via authKey query arg. It overrides -httpAuth.*
        Flag value can be read from the given file when using -flagsAuthKey=file:///abs/path/to/file or -flagsAuthKey=file://./relative/path/to/file.
        Flag value can be read from the given http/https url when using -flagsAuthKey=http://host/path or -flagsAuthKey=https://host/path
  -fs.maxConcurrency int
        The maximum number of concurrent goroutines to work with files; smaller values may help reducing Go scheduling latency on systems with small number of CPU cores; higher values may help reducing data ingestion latency on systems with high-latency storage such as NFS or Ceph (default 160)
  -http.connTimeout duration
        Incoming connections to -httpListenAddr are closed after the configured timeout. This may help evenly spreading load among a cluster of services behind TCP-level load balancer. Zero value disables closing of incoming connections (default 2m0s)
  -http.disableCORS
        Disable CORS for all origins (*)
  -http.disableKeepAlive
        Whether to disable HTTP keep-alive for incoming connections at -httpListenAddr
  -http.disableResponseCompression
        Disable compression of HTTP responses to save CPU resources. By default, compression is enabled to save network bandwidth
  -http.header.csp string
        Value for 'Content-Security-Policy' header, recommended: "default-src 'self'"
  -http.header.disableServerHostname
        Whether to disable 'X-Server-Hostname' header in HTTP responses
  -http.header.frameOptions string
        Value for 'X-Frame-Options' header
  -http.header.hsts string
        Value for 'Strict-Transport-Security' header, recommended: 'max-age=31536000; includeSubDomains'
  -http.idleConnTimeout duration
        Timeout for incoming idle http connections (default 1m0s)
  -http.maxGracefulShutdownDuration duration
```

--------------------------------

### GET /internal/force_merge

Source: https://docs.victoriametrics.com/victoriametrics/url-examples/index.html

Starts forced compaction.

```APIDOC
## GET /internal/force_merge

### Description
Starts forced compaction.

### Method
GET

### Endpoint
/internal/force_merge

### Parameters
#### Query Parameters
- **partition_prefix** (string) - Optional - Used for matching a subset of partitions
```

--------------------------------

### View vmrestore help options

Source: https://docs.victoriametrics.com/victoriametrics/vmrestore/index.html

Run this command to display all available configuration flags and their descriptions.

```bash
        -concurrency int
     The number of concurrent workers. Higher concurrency may reduce restore duration (default 10)
  -configFilePath string
     Path to file with S3 configs. Configs are loaded from default location if not set.
     See https://docs.aws.amazon.com/general/latest/gr/aws-security-credentials.html
  -configProfile string
     Profile name for S3 configs. If no set, the value of the environment variable will be loaded (AWS_PROFILE or AWS_DEFAULT_PROFILE), or if both not set, DefaultSharedConfigProfile is used
  -credsFilePath string
     Path to file with GCS or S3 credentials. Credentials are loaded from default locations if not set.
     See https://cloud.google.com/iam/docs/creating-managing-service-account-keys and https://docs.aws.amazon.com/general/latest/gr/aws-security-credentials.html
  -customS3Endpoint string
     Custom S3 endpoint for use with S3-compatible storages (e.g. MinIO). S3 is used if not set
  -deleteAllObjectVersions
     Whether to prune previous object versions when deleting an object. By default, when object storage has versioning enabled deleting the file removes only current version. This option forces removal of all previous versions. See: https://docs.victoriametrics.com/victoriametrics/vmbackup/#permanent-deletion-of-objects-in-s3-compatible-storages
  -enableTCP6
     Whether to enable IPv6 for listening and dialing. By default, only IPv4 TCP and UDP are used
  -envflag.enable
     Whether to enable reading flags from environment variables in addition to the command line. Command line flag values have priority over values from environment vars. Flags are read only from the command line if this flag isn't set. See https://docs.victoriametrics.com/victoriametrics/single-server-victoriametrics/#environment-variables for more details
  -envflag.prefix string
     Prefix for environment variables if -envflag.enable is set
  -eula
     Deprecated, please use -license or -licenseFile flags instead. By specifying this flag, you confirm that you have an enterprise license and accept the ESA https://victoriametrics.com/legal/esa/ . This flag is available only in Enterprise binaries. See https://docs.victoriametrics.com/victoriametrics/enterprise/
  -filestream.disableFadvise
     Whether to disable fadvise() syscall when reading large data files. The fadvise() syscall prevents from eviction of recently accessed data from OS page cache during background merges and backups. In some rare cases it is better to disable the syscall if it uses too much CPU
  -flagsAuthKey value
     Auth key for /flags endpoint. It must be passed via authKey query arg. It overrides -httpAuth.*
     Flag value can be read from the given file when using -flagsAuthKey=file:///abs/path/to/file or -flagsAuthKey=file://./relative/path/to/file . Flag value can be read from the given http/https url when using -flagsAuthKey=http://host/path or -flagsAuthKey=https://host/path
  -fs.disableMincore
     Whether to disable the mincore() syscall for checking mmap()ed files. By default, mincore() is used to detect whether mmap()ed file pages are resident in memory. Disabling mincore() may be needed on older ZFS filesystems (below 2.1.5), since it may trigger ZFS bug. See https://github.com/VictoriaMetrics/VictoriaMetrics/issues/10327 for details.
  -fs.disableMmap
     Whether to use pread() instead of mmap() for reading data files. By default, mmap() is used for 64-bit arches and pread() is used for 32-bit arches, since they cannot read data files bigger than 2^32 bytes in memory. mmap() is usually faster for reading small data chunks than pread()
  -fs.maxConcurrency int
     The maximum number of concurrent goroutines to work with files; smaller values may help reducing Go scheduling latency on systems with small number of CPU cores; higher values may help reducing data ingestion latency on systems with high-latency storage such as NFS or Ceph (default 64)
  -http.connTimeout duration
     Incoming connections to -httpListenAddr are closed after the configured timeout. This may help evenly spreading load among a cluster of services behind TCP-level load balancer. Zero value disables closing of incoming connections (default 2m0s)
  -http.disableCORS
     Disable CORS for all origins (*)
  -http.disableKeepAlive
     Whether to disable HTTP keep-alive for incoming connections at -httpListenAddr
  -http.disableResponseCompression
```

--------------------------------

### JSON Logger Field Renaming Example

Source: https://docs.victoriametrics.com/victoriametrics/changelog/changelog_2022/index.html

Example of how to rename fields in JSON logs when VictoriaMetrics components are started with `-loggerFormat=json`. This allows customizing log output.

```bash
-loggerJSONFields=ts:timestamp,msg:message
```

--------------------------------

### Display vmbackup help information

Source: https://docs.victoriametrics.com/victoriametrics/vmbackup

Run this command to list all available command-line options and their descriptions.

```bash
vmbackup -help
```

--------------------------------

### Start vmauth with configuration

Source: https://docs.victoriametrics.com/victoriametrics/vmauth/index.html

Run the vmauth binary by specifying the path to the required YAML configuration file.

```bash
/path/to/vmauth -auth.config=/path/to/auth/config.yml
```

--------------------------------

### GET /api/v1/backups Response Example

Source: https://docs.victoriametrics.com/victoriametrics/vmbackupmanager/index.html

Returns a list of backups stored in remote storage with metadata.

```json
[{"name":"daily/2023-04-07","size_bytes":318837,"size":"311.4ki","created_at":"2023-04-07T16:15:07+00:00"},{"name":"hourly/2023-04-07:11","size_bytes":318837,"size":"311.4ki","created_at":"2023-04-07T16:15:06+00:00"},{"name":"latest","size_bytes":318837,"size":"311.4ki","created_at":"2023-04-07T16:15:04+00:00"},{"name":"monthly/2023-04","size_bytes":318837,"size":"311.4ki","created_at":"2023-04-07T16:15:10+00:00"},{"name":"weekly/2023-14","size_bytes":318837,"size":"311.4ki","created_at":"2023-04-07T16:15:09+00:00"}]
```

--------------------------------

### Verify startup logs

Source: https://docs.victoriametrics.com/victoriametrics/quick-start

Check the console output to confirm the server has initialized and is listening on the default port.

```text
      2026-07-10T16:55:06.615Z    info    app/victoria-metrics/main.go:102    started VictoriaMetrics in 0.019 seconds
...
2026-07-10T16:55:06.615Z    info    lib/httpserver/httpserver.go:148    started server at http://0.0.0.0:8428/
    
```

--------------------------------

### Run vmselect with mTLS

Source: https://docs.victoriametrics.com/victoriametrics/cluster-victoriametrics/index.html

Example command to start vmselect with mTLS enabled, restricting connections to authenticated clients only.

```bash
./vmselect -tls -mtls
```

--------------------------------

### Setup Single Node data directory

Source: https://docs.victoriametrics.com/victoriametrics/quick-start/index.html

Create the data storage directory and assign ownership to the service user.

```bash
      sudo mkdir -p /var/lib/victoria-metrics && sudo chown -R victoriametrics:victoriametrics /var/lib/victoria-metrics
    
```

--------------------------------

### Verify startup logs

Source: https://docs.victoriametrics.com/victoriametrics/quick-start/index.html

Example log output confirming the server is running on port 8428.

```text
2026-07-10T16:55:06.615Z    info    app/victoria-metrics/main.go:102    started VictoriaMetrics in 0.019 seconds
...
2026-07-10T16:55:06.615Z    info    lib/httpserver/httpserver.go:148    started server at http://0.0.0.0:8428/
```

--------------------------------

### Override GOGC environment variable

Source: https://docs.victoriametrics.com/victoriametrics/changelog/changelog_2025/index.html

Example of starting a VictoriaMetrics component with a custom GOGC value to manage memory and CPU usage.

```bash
GOGC=200 ./path/to/vmagent
```

--------------------------------

### Export Data with Time Range

Source: https://docs.victoriametrics.com/victoriametrics/index.html

Examples of exporting data using specific start and end timestamps in either Unix epoch or ISO 8601 formats.

```bash
curl http://<victoriametrics-addr>:8428/api/v1/export/native -d 'match[]=<timeseries_selector_for_export>' -d 'start=1654543486' -d 'end=1654543486'
```

```bash
curl http://<victoriametrics-addr>:8428/api/v1/export/native -d 'match[]=<timeseries_selector_for_export>' -d 'start=2022-06-06T19:25:48' -d 'end=2022-06-06T19:29:07'
```

--------------------------------

### Initialize Terraform

Source: https://docs.victoriametrics.com/victoriametrics-cloud/integrations/terraform/index.html

Download the provider and initialize the working directory.

```bash
terraform init
```

--------------------------------

### Display vmctl help and command list

Source: https://docs.victoriametrics.com/victoriametrics/vmctl/index.html

Run the help command to view all available migration commands and global options.

```bash
      NAME:
   vmctl - VictoriaMetrics command-line tool

USAGE:
   vmctl [global options] command [command options]


COMMANDS:
   opentsdb      Migrate time series from OpenTSDB
   influx        Migrate time series from InfluxDB
   remote-read   Migrate time series via Prometheus remote-read protocol
   prometheus    Migrate time series from Prometheus
   mimir         Migrate time series from Mimir object storage or local filesystem
   thanos        Migrate time series from Thanos blocks (supports raw and downsampled data)
   vm-native     Migrate time series between VictoriaMetrics installations
   verify-block  Verifies exported block with VictoriaMetrics Native format
   help, h       Shows a list of commands or help for one command

GLOBAL OPTIONS:
   --help, -h     show help
   --version, -v  print the version
```

--------------------------------

### VictoriaMetrics Single Node Startup Output

Source: https://docs.victoriametrics.com/victoriametrics/quick-start/index.html

Expected console output confirming the server has started and partitions are initialized.

```text
       started server at http://0.0.0.0:8428/
 partition "2025_03" has been created
```

--------------------------------

### GET /api/v1/labels

Source: https://docs.victoriametrics.com/victoriametrics/url-examples/index.html

Get a list of label names at the given time range.

```APIDOC
## GET /api/v1/labels

### Description
Get a list of label names at the given time range.

### Method
GET

### Endpoint
/prometheus/api/v1/labels

### Parameters
#### Query Parameters
- **start** (string) - Optional - Start time range
- **end** (string) - Optional - End time range
```

--------------------------------

### Display vmctl Help

Source: https://docs.victoriametrics.com/victoriametrics/vmctl/index.html

Command to list all supported migration modes and global options.

```bash
$ ./vmctl-prod --help
NAME:
   vmctl - VictoriaMetrics command-line tool

USAGE:
   vmctl [global options] command [command options] [arguments...]

COMMANDS:
   opentsdb      Migrate time series from OpenTSDB
   influx        Migrate time series from InfluxDB
   remote-read   Migrate time series via Prometheus remote-read protocol
   prometheus    Migrate time series from Prometheus
   vm-native     Migrate time series between VictoriaMetrics installations
   verify-block  Verifies exported block with VictoriaMetrics Native format
```

--------------------------------

### InfluxDB line protocol example

Source: https://docs.victoriametrics.com/victoriametrics/vmctl/influxdb/index.html

Example of a raw InfluxDB line protocol input.

```text
      foo,tag1=value1,tag2=value2 field1=12,field2=40
```

--------------------------------

### Cortex API Configuration Example

Source: https://docs.victoriametrics.com/victoriametrics/vmctl/cortex/index.html

Example of Cortex API configuration, specifically the prometheus_http_prefix setting.

```yaml
      api:
  prometheus_http_prefix:
    
```

--------------------------------

### Start and enable vmselect service

Source: https://docs.victoriametrics.com/victoriametrics/quick-start/index.html

Reloads systemd daemon and enables the vmselect service to start on boot.

```bash
      sudo systemctl daemon-reload && sudo systemctl enable --now vmselect.service
```

--------------------------------

### Display vmbackupmanager help

Source: https://docs.victoriametrics.com/victoriametrics/vmbackupmanager/index.html

Run this command to view the full list of supported flags and configuration options for the backup manager.

```bash
./vmbackupmanager --help
```

--------------------------------

### Start and enable vminsert service

Source: https://docs.victoriametrics.com/victoriametrics/quick-start/index.html

Reloads systemd daemon and enables the vminsert service to start on boot.

```bash
      sudo systemctl daemon-reload && sudo systemctl enable --now vminsert.service
```

--------------------------------

### Example migration output

Source: https://docs.victoriametrics.com/victoriametrics/vmctl/mimir/index.html

Sample console output showing the progress and final statistics of a successful import process.

```text
      2025/01/18 13:01:59 Fetching blocks from remote storage
Found 204 blocks to import. Continue? [Y/n] y
VM worker 0:? 1589405 samples/s                                                                                                                                                                                     
VM worker 1:? 1911834 samples/s                                                                                                                                                                                     
VM worker 2:? 1849187 samples/s                                                                                                                                                                                     
VM worker 3:? 1648820 samples/s                                                                                                                                                                                     
VM worker 4:? 1539212 samples/s                                                                                                                                                                                     
VM worker 5:? 1411485 samples/s                                                                                                                                                                                     
Processing blocks: 204 / 204 [?????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????????] 100.00%
2025/01/18 13:02:18 Import finished!
2025/01/18 13:02:18 VictoriaMetrics importer stats:
  idle duration: 18.485875611s;
  time spent while importing: 16.40543875s;
  total samples: 177961995;
  samples/s: 10847743.71;
  total bytes: 4.1 GB;
  bytes/s: 248.2 MB;
  import requests: 893;
  import requests retries: 0;
2025/01/18 13:02:18 Total time: 18.867547083s
```

--------------------------------

### VictoriaMetrics log output example

Source: https://docs.victoriametrics.com/victoriametrics/vmctl/thanos

Example log messages indicating successful partition creation in VictoriaMetrics.

```text
2020-04-27T18:38:46.474Z info VictoriaMetrics/lib/storage/partition.go:207 creating a partition "2025_04" with smallPartsPath="/victoria-metrics-data/data/small/2025_04", bigPartsPath="/victoria-metrics-data/data/big/2025_04"
2020-04-27T18:38:46.506Z info VictoriaMetrics/lib/storage/partition.go:222 partition "2025_04" has been created
```

--------------------------------

### Start and enable vmstorage service

Source: https://docs.victoriametrics.com/victoriametrics/quick-start/index.html

Reload systemd configuration and enable the vmstorage service.

```bash
      sudo systemctl daemon-reload && sudo systemctl enable --now vmstorage
    
```

--------------------------------

### Start VictoriaMetrics and vmgateway

Source: https://docs.victoriametrics.com/victoriametrics/vmgateway

Commands to initialize the VictoriaMetrics single-node instance and the vmgateway service.

```bash
# single
# start node
./bin/victoria-metrics --selfScrapeInterval=10s
```

```bash
./bin/vmgateway -licenseFile=/path/to/vm-license -enable.auth -read.url http://localhost:8428 --write.url http://localhost:8428
```

--------------------------------

### Consul SD Configuration Example

Source: https://docs.victoriametrics.com/victoriametrics/sd_configs/index.html

Example configuration block for defining a Consul service discovery job in scrape_configs.

```yaml
      scrape_configs:
- job_name: consul
  consul_sd_configs:

    # server is an optional Consul server to connect to. By default, localhost:8500 is used
    #
  - server: "localhost:8500"

    # token is an optional Consul API token.
    # If the token isn't specified, then it is read from a file pointed by CONSUL_HTTP_TOKEN_FILE
    # environment var or from the CONSUL_HTTP_TOKEN environment var.
    #
    # token: "..."

    # datacenter is an optional Consul API datacenter.
    # If the datacenter isn't specified, then it is read from Consul server.
    # See https://www.consul.io/api-docs/agent#read-configuration
    #
    # datacenter: "..."

    # namespace is an optional Consul namespace.
    # See https://developer.hashicorp.com/consul/docs/enterprise/namespaces
    # If the namespace isn't specified, then it is read from CONSUL_NAMESPACE environment var.
    #
    # namespace: "..."

    # partition is an optional Consul partition.
    # See https://developer.hashicorp.com/consul/docs/enterprise/admin-partitions
    # If partition isn't specified, then the default partition is used.
    #
    # partition: "..."

    # scheme is an optional scheme (http or https) to use for connecting to Consul server.
    # By default, http scheme is used.
    #
    # scheme: "..."

    # services is an optional list of services for which targets are retrieved.
    # If omitted, all services are scraped.
    # See https://www.consul.io/api-docs/catalog#list-nodes-for-service .
    #
    # services: ["...", "..."]

    # tags is an optional list of tags used to filter nodes for a given service.
    # Services must contain all tags in the list.
    # Deprecated: use filter instead with ServiceTags selector.
    #
    # tags: ["...", "..."]

    # node_meta is an optional node metadata key/value pairs to filter nodes for a given service.
    # Deprecated: use filter instead with NodeMeta selector.
    #
    # node_meta:
    #   "...": "..."

    # tag_separator is an optional string by which Consul tags are joined into the __meta_consul_tags label.
    # By default, "," is used as a tag separator.
    # Individual tags are also available via __meta_consul_tag_<tagname> labels - see below.
    #
    # tag_separator: "..."

    # filter is an optional filter for service discovery.
    # Replaces tags and node_meta options.
    # Consul supports it since 1.14 version.
    # See the list of supported filters at https://developer.hashicorp.com/consul/api-docs/catalog#filtering-1
    # See filter examples at https://developer.hashicorp.com/consul/api-docs/features/filtering
    #
    # filter: "..."

    # allow_stale is an optional config, which allows stale Consul results.
    # See https://developer.hashicorp.com/consul/api-docs/features/consistency
    # Reduce load on Consul if set to true. By default, it is set to true.
    #
    # allow_stale: ...

    # Additional HTTP API client options can be specified here.
    # See https://docs.victoriametrics.com/victoriametrics/sd_configs/#http-api-client-options
```

--------------------------------

### Example Exported Data Format

Source: https://docs.victoriametrics.com/victoriametrics/integrations/influxdb/index.html

This is an example of the JSON response format from the `/api/v1/export` endpoint, showing exported metrics and their values.

```json
{"metric":{"__name__":"measurement1_field1","tag1":"value1","tag2":"value2"},"values":[123],"timestamps":[1766983684142]}
{"metric":{"__name__":"measurement1_field2","tag1":"value1","tag2":"value2"},"values":[1.23],"timestamps":[1766983684142]}
{"metric":{"__name__":"measurement2_field1","tag1":"value1","tag2":"value2"},"values":[456],"timestamps":[1767012583021]}
{"metric":{"__name__":"measurement2_field2","tag1":"value1","tag2":"value2"},"values":[4.56],"timestamps":[1767012583021]}
{"metric":{"__name__":"measurement3_field1","tag1":"value1","tag2":"value2"},"values":[789],"timestamps":[1767012583021]}
{"metric":{"__name__":"measurement3_field2","tag1":"value1","tag2":"value2"},"values":[7.89],"timestamps":[1767012583021]}
    
```

--------------------------------

### Create working directory

Source: https://docs.victoriametrics.com/victoriametrics/quick-start/index.html

Prepare a dedicated directory for the VictoriaMetrics test drive.

```bash
mkdir vm-quick-start && cd vm-quick-start
```

--------------------------------

### Start VictoriaMetrics

Source: https://docs.victoriametrics.com/victoriametrics/quick-start/index.html

Launch the binary with self-scraping enabled to collect internal metrics.

```bash
./victoria-metrics-prod -selfScrapeInterval=10s
```
Tokens:
Raw