From b3d88610fdb940f0b1114f353d23d0e208082f37 Mon Sep 17 00:00:00 2001 From: Aliaksandr Valialkin Date: Fri, 16 Apr 2021 12:09:22 +0300 Subject: [PATCH] app/vmctl: update README.md according to bfecd0fd559260ba78acc1a8581c15df5d2d60c6 --- app/vmctl/README.md | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/app/vmctl/README.md b/app/vmctl/README.md index 166171a65..9b3550aec 100644 --- a/app/vmctl/README.md +++ b/app/vmctl/README.md @@ -1,3 +1,7 @@ +--- +sort: 7 +--- + # vmctl Victoria metrics command-line tool @@ -270,12 +274,12 @@ You may find useful a 3rd party solution for this - https://github.com/jonppe/in ## Migrating data from Prometheus `vmctl` supports the `prometheus` mode for migrating data from Prometheus to VictoriaMetrics time-series database. -Migration is based on reading Prometheus snapshot, which is basically a hard-link to Prometheus data files. +Migration is based on reading Prometheus snapshot, which is basically a hard-link to Prometheus data files. -See `./vmctl prometheus --help` for details and full list of flags. +See `./vmctl prometheus --help` for details and full list of flags. Also see Prometheus related articles [here](#articles). -To use migration tool please specify the path to Prometheus snapshot `--prom-snapshot` and VictoriaMetrics address `--vm-addr`. -More about Prometheus snapshots may be found [here](https://www.robustperception.io/taking-snapshots-of-prometheus-data). +To use migration tool please specify the file path to Prometheus snapshot `--prom-snapshot` (see how to make a snapshot [here](https://www.robustperception.io/taking-snapshots-of-prometheus-data)) and VictoriaMetrics address `--vm-addr`. +Please note, that `vmctl` *do not make a snapshot from Prometheus*, it uses an already prepared snapshot. More about Prometheus snapshots may be found [here](https://www.robustperception.io/taking-snapshots-of-prometheus-data) and [here](https://medium.com/@romanhavronenko/victoriametrics-how-to-migrate-data-from-prometheus-d44a6728f043). Flag `--vm-addr` for single-node VM is usually equal to `--httpListenAddr`, and for cluster version is equal to `--httpListenAddr` flag of VMInsert component. Please note, that vmctl performs initial readiness check for the given address by checking `/health` endpoint. For cluster version it is additionally required to specify the `--vm-account-id` flag.