From f7f29a18407b3a957598383aced9b23ecd372e0a Mon Sep 17 00:00:00 2001 From: Aliaksandr Valialkin Date: Sat, 12 Aug 2023 07:32:11 -0700 Subject: [PATCH] app/vmctl: document that -vm-native-step-interval command-line option now supports `week` value This is a follow-up for d322ee4b35ab1a2335618406fc2bccf789d1a22b Updates https://github.com/VictoriaMetrics/VictoriaMetrics/issues/4738 --- app/vmctl/README.md | 4 ++-- app/vmctl/flags.go | 5 +++-- app/vmctl/stepper/split.go | 4 ++-- docs/vmctl.md | 4 ++-- 4 files changed, 9 insertions(+), 8 deletions(-) diff --git a/app/vmctl/README.md b/app/vmctl/README.md index c5f008995f..50d11161ee 100644 --- a/app/vmctl/README.md +++ b/app/vmctl/README.md @@ -826,7 +826,7 @@ It is possible split migration process into set of smaller batches based on time migrating large volumes of data as this adds indication of progress and ability to restore process from certain point in case of failure. -To use this you need to specify `--vm-native-step-interval` flag. Supported values are: `month`, `day`, `hour`, `minute`. +To use this you need to specify `--vm-native-step-interval` flag. Supported values are: `month`, `week`, `day`, `hour`, `minute`. Note that in order to use this it is required `--vm-native-filter-time-start` to be set to calculate time ranges for export process. @@ -836,7 +836,7 @@ Every range is being processed independently, which means that: so it is possible to restart process starting from failed range. It is recommended using the `month` step when migrating the data over multiple months, -since the migration with `day` and `hour` steps may take longer time to complete because of additional overhead. +since the migration with `week`, `day` and `hour` steps may take longer time to complete because of additional overhead. Usage example: ```console diff --git a/app/vmctl/flags.go b/app/vmctl/flags.go index 92c582f29e..7a71d4ab01 100644 --- a/app/vmctl/flags.go +++ b/app/vmctl/flags.go @@ -361,8 +361,9 @@ var ( Usage: "The time filter may contain different timestamp formats. See more details here https://docs.victoriametrics.com/Single-server-VictoriaMetrics.html#timestamp-formats", }, &cli.StringFlag{ - Name: vmNativeStepInterval, - Usage: fmt.Sprintf("Split export data into chunks. Requires setting --%s. Valid values are '%s','%s','%s','%s'.", vmNativeFilterTimeStart, stepper.StepMonth, stepper.StepDay, stepper.StepHour, stepper.StepMinute), + Name: vmNativeStepInterval, + Usage: fmt.Sprintf("Split export data into chunks. Requires setting --%s. Valid values are '%s','%s','%s','%s','%s'.", vmNativeFilterTimeStart, + stepper.StepMonth, stepper.StepWeek, stepper.StepDay, stepper.StepHour, stepper.StepMinute), Value: stepper.StepMonth, }, &cli.BoolFlag{ diff --git a/app/vmctl/stepper/split.go b/app/vmctl/stepper/split.go index 8f890f6590..104b38ad84 100644 --- a/app/vmctl/stepper/split.go +++ b/app/vmctl/stepper/split.go @@ -8,10 +8,10 @@ import ( const ( // StepMonth represents a one month interval StepMonth string = "month" - // StepDay represents a one day interval - StepDay string = "day" // StepWeek represents a one week interval StepWeek string = "week" + // StepDay represents a one day interval + StepDay string = "day" // StepHour represents a one hour interval StepHour string = "hour" // StepMinute represents a one minute interval diff --git a/docs/vmctl.md b/docs/vmctl.md index 6015c0ba51..88e5b10a65 100644 --- a/docs/vmctl.md +++ b/docs/vmctl.md @@ -837,7 +837,7 @@ It is possible split migration process into set of smaller batches based on time migrating large volumes of data as this adds indication of progress and ability to restore process from certain point in case of failure. -To use this you need to specify `--vm-native-step-interval` flag. Supported values are: `month`, `day`, `hour`, `minute`. +To use this you need to specify `--vm-native-step-interval` flag. Supported values are: `month`, `week`, `day`, `hour`, `minute`. Note that in order to use this it is required `--vm-native-filter-time-start` to be set to calculate time ranges for export process. @@ -847,7 +847,7 @@ Every range is being processed independently, which means that: so it is possible to restart process starting from failed range. It is recommended using the `month` step when migrating the data over multiple months, -since the migration with `day` and `hour` steps may take longer time to complete because of additional overhead. +since the migration with `week`, `day` and `hour` steps may take longer time to complete because of additional overhead. Usage example: ```console