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

docs: follow up after 939952068b (#4923)

Browse Source
This commit is contained in:
Dmytro Kozlov 2023-08-31 10:53:26 +02:00 committed by Aliaksandr Valialkin
parent d079780ec6
commit 986ad3d112
No known key found for this signature in database
GPG Key ID: A72BEC6CD3D0DED1
2 changed files with 30 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
app/vmctl/README.md
View File

@ -489,13 +489,14 @@ doesn't support it).
See `./vmctl remote-read --help` for details and full list of flags. See `./vmctl remote-read --help` for details and full list of flags.
To start the migration process configure the following flags: To start the migration process configure the following flags:
1. `--remote-read-src-addr` - data source address to read from; 1. `--remote-read-src-addr` - data source address to read from;
2. `--vm-addr` - VictoriaMetrics address to write to. For single-node VM is usually equal to `--httpListenAddr`, 1. `--vm-addr` - VictoriaMetrics address to write to. For single-node VM is usually equal to `--httpListenAddr`,
and for cluster version is equal to `--httpListenAddr` flag of vminsert component (for example `http://<vminsert>:8480/insert/<accountID>/prometheus`); and for cluster version is equal to `--httpListenAddr` flag of vminsert component (for example `http://<vminsert>:8480/insert/<accountID>/prometheus`);
3. `--remote-read-filter-time-start` - the time filter in RFC3339 format to select time series with timestamp equal or higher than provided value. E.g. '2020-01-01T20:07:00Z'; 1. `--remote-read-filter-time-start` - the time filter in RFC3339 format to select time series with timestamp equal or higher than provided value. E.g. '2020-01-01T20:07:00Z';
4. `--remote-read-filter-time-end` - the time filter in RFC3339 format to select time series with timestamp equal or smaller than provided value. E.g. '2020-01-01T20:07:00Z'. Current time is used when omitted.; 1. `--remote-read-filter-time-end` - the time filter in RFC3339 format to select time series with timestamp equal or smaller than provided value. E.g. '2020-01-01T20:07:00Z'. Current time is used when omitted.;
5. `--remote-read-step-interval` - split export data into chunks. Valid values are `month, day, hour, minute`; 1. `--remote-read-step-interval` - split export data into chunks. Valid values are `month, day, hour, minute`;
6. `--remote-read-use-stream` - defines whether to use `SAMPLES` or `STREAMED_XOR_CHUNKS` mode. By default, is uses `SAMPLES` mode. 1. `--remote-read-use-stream` - defines whether to use `SAMPLES` or `STREAMED_XOR_CHUNKS` mode. By default, is uses `SAMPLES` mode.
The importing process example for local installation of Prometheus The importing process example for local installation of Prometheus
and single-node VictoriaMetrics(`http://localhost:8428`): and single-node VictoriaMetrics(`http://localhost:8428`):
@ -562,7 +563,7 @@ and that you have a separate Thanos Store installation.
- url: http://victoria-metrics:8428/api/v1/write - url: http://victoria-metrics:8428/api/v1/write
``` ```
2. Make sure VM is running, of course. Now check the logs to make sure that Prometheus is sending and VM is receiving. 1. Make sure VM is running, of course. Now check the logs to make sure that Prometheus is sending and VM is receiving.
In Prometheus, make sure there are no errors. On the VM side, you should see messages like this: In Prometheus, make sure there are no errors. On the VM side, you should see messages like this:
``` ```
@ -570,7 +571,7 @@ and that you have a separate Thanos Store installation.
2020-04-27T18:38:46.506Z info VictoriaMetrics/lib/storage/partition.go:222 partition "2020_04" has been created 2020-04-27T18:38:46.506Z info VictoriaMetrics/lib/storage/partition.go:222 partition "2020_04" has been created
``` ```
3. Now just wait. Within two hours, Prometheus should finish its current data file and hand it off to Thanos Store for long term 1. Now just wait. Within two hours, Prometheus should finish its current data file and hand it off to Thanos Store for long term
storage. storage.
### Historical data ### Historical data
@ -579,12 +580,13 @@ Let's assume your data is stored on S3 served by minio. You first need to copy t
then import it into VM using `vmctl` in `prometheus` mode. then import it into VM using `vmctl` in `prometheus` mode.
1. Copy data from minio. 1. Copy data from minio.
1.1 Run the `minio/mc` Docker container. 1. Run the `minio/mc` Docker container.
1.2 `mc config host add minio http://minio:9000 accessKey secretKey`, substituting appropriate values for the last 3 items. 1. `mc config host add minio http://minio:9000 accessKey secretKey`, substituting appropriate values for the last 3 items.
1.3 `mc cp -r minio/prometheus thanos-data` 1. `mc cp -r minio/prometheus thanos-data`
2. Import using `vmctl`.
2.1 Follow the [instructions](#how-to-build) to compile `vmctl` on your machine. 1. Import using `vmctl`.
2.2 Use [prometheus](#migrating-data-from-prometheus) mode to import data: 1. Follow the [instructions](#how-to-build) to compile `vmctl` on your machine.
1. Use [prometheus](#migrating-data-from-prometheus) mode to import data:
``` ```
vmctl prometheus --prom-snapshot thanos-data --vm-addr http://victoria-metrics:8428 vmctl prometheus --prom-snapshot thanos-data --vm-addr http://victoria-metrics:8428

28
docs/vmctl.md
View File

@ -500,13 +500,14 @@ doesn't support it).
See `./vmctl remote-read --help` for details and full list of flags. See `./vmctl remote-read --help` for details and full list of flags.
To start the migration process configure the following flags: To start the migration process configure the following flags:
1. `--remote-read-src-addr` - data source address to read from; 1. `--remote-read-src-addr` - data source address to read from;
2. `--vm-addr` - VictoriaMetrics address to write to. For single-node VM is usually equal to `--httpListenAddr`, 1. `--vm-addr` - VictoriaMetrics address to write to. For single-node VM is usually equal to `--httpListenAddr`,
and for cluster version is equal to `--httpListenAddr` flag of vminsert component (for example `http://<vminsert>:8480/insert/<accountID>/prometheus`); and for cluster version is equal to `--httpListenAddr` flag of vminsert component (for example `http://<vminsert>:8480/insert/<accountID>/prometheus`);
3. `--remote-read-filter-time-start` - the time filter in RFC3339 format to select time series with timestamp equal or higher than provided value. E.g. '2020-01-01T20:07:00Z'; 1. `--remote-read-filter-time-start` - the time filter in RFC3339 format to select time series with timestamp equal or higher than provided value. E.g. '2020-01-01T20:07:00Z';
4. `--remote-read-filter-time-end` - the time filter in RFC3339 format to select time series with timestamp equal or smaller than provided value. E.g. '2020-01-01T20:07:00Z'. Current time is used when omitted.; 1. `--remote-read-filter-time-end` - the time filter in RFC3339 format to select time series with timestamp equal or smaller than provided value. E.g. '2020-01-01T20:07:00Z'. Current time is used when omitted.;
5. `--remote-read-step-interval` - split export data into chunks. Valid values are `month, day, hour, minute`; 1. `--remote-read-step-interval` - split export data into chunks. Valid values are `month, day, hour, minute`;
6. `--remote-read-use-stream` - defines whether to use `SAMPLES` or `STREAMED_XOR_CHUNKS` mode. By default, is uses `SAMPLES` mode. 1. `--remote-read-use-stream` - defines whether to use `SAMPLES` or `STREAMED_XOR_CHUNKS` mode. By default, is uses `SAMPLES` mode.
The importing process example for local installation of Prometheus The importing process example for local installation of Prometheus
and single-node VictoriaMetrics(`http://localhost:8428`): and single-node VictoriaMetrics(`http://localhost:8428`):
@ -573,7 +574,7 @@ and that you have a separate Thanos Store installation.
- url: http://victoria-metrics:8428/api/v1/write - url: http://victoria-metrics:8428/api/v1/write
``` ```
2. Make sure VM is running, of course. Now check the logs to make sure that Prometheus is sending and VM is receiving. 1. Make sure VM is running, of course. Now check the logs to make sure that Prometheus is sending and VM is receiving.
In Prometheus, make sure there are no errors. On the VM side, you should see messages like this: In Prometheus, make sure there are no errors. On the VM side, you should see messages like this:
``` ```
@ -581,7 +582,7 @@ and that you have a separate Thanos Store installation.
2020-04-27T18:38:46.506Z info VictoriaMetrics/lib/storage/partition.go:222 partition "2020_04" has been created 2020-04-27T18:38:46.506Z info VictoriaMetrics/lib/storage/partition.go:222 partition "2020_04" has been created
``` ```
3. Now just wait. Within two hours, Prometheus should finish its current data file and hand it off to Thanos Store for long term 1. Now just wait. Within two hours, Prometheus should finish its current data file and hand it off to Thanos Store for long term
storage. storage.
### Historical data ### Historical data
@ -590,12 +591,13 @@ Let's assume your data is stored on S3 served by minio. You first need to copy t
then import it into VM using `vmctl` in `prometheus` mode. then import it into VM using `vmctl` in `prometheus` mode.
1. Copy data from minio. 1. Copy data from minio.
1.1 Run the `minio/mc` Docker container. 1. Run the `minio/mc` Docker container.
1.2 `mc config host add minio http://minio:9000 accessKey secretKey`, substituting appropriate values for the last 3 items. 1. `mc config host add minio http://minio:9000 accessKey secretKey`, substituting appropriate values for the last 3 items.
1.3 `mc cp -r minio/prometheus thanos-data` 1. `mc cp -r minio/prometheus thanos-data`
2. Import using `vmctl`.
2.1 Follow the [instructions](#how-to-build) to compile `vmctl` on your machine. 1. Import using `vmctl`.
2.2 Use [prometheus](#migrating-data-from-prometheus) mode to import data: 1. Follow the [instructions](#how-to-build) to compile `vmctl` on your machine.
1. Use [prometheus](#migrating-data-from-prometheus) mode to import data:
``` ```
vmctl prometheus --prom-snapshot thanos-data --vm-addr http://victoria-metrics:8428 vmctl prometheus --prom-snapshot thanos-data --vm-addr http://victoria-metrics:8428