2021-02-01 00:10:16 +01:00
package main
import (
"fmt"
2022-11-29 22:53:28 +01:00
"time"
2021-02-01 00:10:16 +01:00
"github.com/urfave/cli/v2"
2022-09-06 09:09:34 +02:00
"github.com/VictoriaMetrics/VictoriaMetrics/app/vmctl/stepper"
2021-02-01 00:10:16 +01:00
)
const (
2024-06-10 12:20:52 +02:00
globalSilent = "s"
globalVerbose = "verbose"
globalDisableProgressBar = "disable-progress-bar"
2021-02-01 00:10:16 +01:00
)
var (
globalFlags = [ ] cli . Flag {
& cli . BoolFlag {
Name : globalSilent ,
Value : false ,
Usage : "Whether to run in silent mode. If set to true no confirmation prompts will appear." ,
2022-01-03 20:12:01 +01:00
} ,
& cli . BoolFlag {
Name : globalVerbose ,
Value : false ,
Usage : "Whether to enable verbosity in logs output." ,
2021-02-01 00:10:16 +01:00
} ,
2024-06-10 12:20:52 +02:00
& cli . BoolFlag {
Name : globalDisableProgressBar ,
Value : false ,
Usage : "Whether to disable progress bar during the import." ,
} ,
2021-02-01 00:10:16 +01:00
}
)
const (
vmAddr = "vm-addr"
vmUser = "vm-user"
vmPassword = "vm-password"
vmAccountID = "vm-account-id"
vmConcurrency = "vm-concurrency"
vmCompress = "vm-compress"
vmBatchSize = "vm-batch-size"
vmSignificantFigures = "vm-significant-figures"
2021-02-01 13:27:05 +01:00
vmRoundDigits = "vm-round-digits"
2024-03-08 20:47:36 +01:00
vmCertFile = "vm-cert-file"
vmKeyFile = "vm-key-file"
vmCAFile = "vm-CA-file"
vmServerName = "vm-server-name"
vmInsecureSkipVerify = "vm-insecure-skip-verify"
2021-12-24 11:18:07 +01:00
// also used in vm-native
vmExtraLabel = "vm-extra-label"
vmRateLimit = "vm-rate-limit"
2022-12-06 02:18:09 +01:00
vmInterCluster = "vm-intercluster"
2024-08-03 19:12:48 +02:00
vmBackoffRetries = "vm-backoff-retries"
vmBackoffFactor = "vm-backoff-factor"
vmBackoffMinDuration = "vm-backoff-min-duration"
2021-02-01 00:10:16 +01:00
)
var (
vmFlags = [ ] cli . Flag {
& cli . StringFlag {
Name : vmAddr ,
Value : "http://localhost:8428" ,
Usage : "VictoriaMetrics address to perform import requests. \n" +
2021-04-20 10:42:17 +02:00
"Should be the same as --httpListenAddr value for single-node version or vminsert component. \n" +
2021-09-01 08:31:44 +02:00
"When importing into the clustered version do not forget to set additionally --vm-account-id flag. \n" +
2021-02-01 00:10:16 +01:00
"Please note, that `vmctl` performs initial readiness check for the given address by checking `/health` endpoint." ,
} ,
& cli . StringFlag {
Name : vmUser ,
Usage : "VictoriaMetrics username for basic auth" ,
EnvVars : [ ] string { "VM_USERNAME" } ,
} ,
& cli . StringFlag {
Name : vmPassword ,
Usage : "VictoriaMetrics password for basic auth" ,
EnvVars : [ ] string { "VM_PASSWORD" } ,
} ,
& cli . StringFlag {
Name : vmAccountID ,
Usage : "AccountID is an arbitrary 32-bit integer identifying namespace for data ingestion (aka tenant). \n" +
2021-09-01 08:31:44 +02:00
"AccountID is required when importing into the clustered version of VictoriaMetrics. \n" +
2021-02-01 00:10:16 +01:00
"It is possible to set it as accountID:projectID, where projectID is also arbitrary 32-bit integer. \n" +
"If projectID isn't set, then it equals to 0" ,
} ,
& cli . UintFlag {
Name : vmConcurrency ,
Usage : "Number of workers concurrently performing import requests to VM" ,
Value : 2 ,
} ,
& cli . BoolFlag {
Name : vmCompress ,
Value : true ,
Usage : "Whether to apply gzip compression to import requests" ,
} ,
& cli . IntFlag {
Name : vmBatchSize ,
Value : 200e3 ,
Usage : "How many samples importer collects before sending the import request to VM" ,
} ,
& cli . IntFlag {
Name : vmSignificantFigures ,
Value : 0 ,
Usage : "The number of significant figures to leave in metric values before importing. " +
"See https://en.wikipedia.org/wiki/Significant_figures. Zero value saves all the significant figures. " +
2021-02-01 13:27:05 +01:00
"This option may be used for increasing on-disk compression level for the stored metrics. " +
"See also --vm-round-digits option" ,
} ,
& cli . IntFlag {
Name : vmRoundDigits ,
Value : 100 ,
Usage : "Round metric values to the given number of decimal digits after the point. " +
2021-02-01 00:10:16 +01:00
"This option may be used for increasing on-disk compression level for the stored metrics" ,
} ,
& cli . StringSliceFlag {
Name : vmExtraLabel ,
Value : nil ,
Usage : "Extra labels, that will be added to imported timeseries. In case of collision, label value defined by flag" +
"will have priority. Flag can be set multiple times, to add few additional labels." ,
} ,
2021-12-24 11:18:07 +01:00
& cli . Int64Flag {
Name : vmRateLimit ,
Usage : "Optional data transfer rate limit in bytes per second.\n" +
2023-05-10 09:50:41 +02:00
"By default, the rate limit is disabled. It can be useful for limiting load on configured via '--vmAddr' destination." ,
2021-12-24 11:18:07 +01:00
} ,
2024-03-08 20:47:36 +01:00
& cli . StringFlag {
Name : vmCertFile ,
Usage : "Optional path to client-side TLS certificate file to use when connecting to '--vmAddr'" ,
} ,
& cli . StringFlag {
Name : vmKeyFile ,
Usage : "Optional path to client-side TLS key to use when connecting to '--vmAddr'" ,
} ,
& cli . StringFlag {
Name : vmCAFile ,
Usage : "Optional path to TLS CA file to use for verifying connections to '--vmAddr'. By default, system CA is used" ,
} ,
& cli . StringFlag {
Name : vmServerName ,
Usage : "Optional TLS server name to use for connections to '--vmAddr'. By default, the server name from '--vmAddr' is used" ,
} ,
& cli . BoolFlag {
Name : vmInsecureSkipVerify ,
Usage : "Whether to skip tls verification when connecting to '--vmAddr'" ,
Value : false ,
} ,
2024-08-03 19:12:48 +02:00
& cli . IntFlag {
Name : vmBackoffRetries ,
Value : 10 ,
Usage : "How many import retries to perform before giving up." ,
} ,
& cli . Float64Flag {
Name : vmBackoffFactor ,
Value : 1.8 ,
Usage : "Factor to multiply the base duration after each failed import retry. Must be greater than 1.0" ,
} ,
& cli . DurationFlag {
Name : vmBackoffMinDuration ,
Value : time . Second * 2 ,
Usage : "Minimum duration to wait before the first import retry. Each subsequent import retry will be multiplied by the '--vm-backoff-factor'." ,
} ,
2021-02-01 00:10:16 +01:00
}
)
2021-04-08 21:58:06 +02:00
const (
2024-02-20 16:22:58 +01:00
otsdbAddr = "otsdb-addr"
otsdbConcurrency = "otsdb-concurrency"
otsdbQueryLimit = "otsdb-query-limit"
otsdbOffsetDays = "otsdb-offset-days"
otsdbHardTSStart = "otsdb-hard-ts-start"
otsdbRetentions = "otsdb-retentions"
otsdbFilters = "otsdb-filters"
otsdbNormalize = "otsdb-normalize"
otsdbMsecsTime = "otsdb-msecstime"
otsdbCertFile = "otsdb-cert-file"
otsdbKeyFile = "otsdb-key-file"
otsdbCAFile = "otsdb-CA-file"
otsdbServerName = "otsdb-server-name"
otsdbInsecureSkipVerify = "otsdb-insecure-skip-verify"
2021-04-08 21:58:06 +02:00
)
var (
otsdbFlags = [ ] cli . Flag {
& cli . StringFlag {
Name : otsdbAddr ,
Value : "http://localhost:4242" ,
Required : true ,
Usage : "OpenTSDB server addr" ,
} ,
& cli . IntFlag {
Name : otsdbConcurrency ,
Usage : "Number of concurrently running fetch queries to OpenTSDB per metric" ,
Value : 1 ,
} ,
& cli . StringSliceFlag {
Name : otsdbRetentions ,
Value : nil ,
Required : true ,
Usage : "Retentions patterns to collect on. Each pattern should describe the aggregation performed " +
"for the query, the row size (in HBase) that will define how long each individual query is, " +
"and the time range to query for. e.g. sum-1m-avg:1h:3d. " +
"The first time range defined should be a multiple of the row size in HBase. " +
"e.g. if the row size is 2 hours, 4h is good, 5h less so. We want each query to land on unique rows." ,
} ,
& cli . StringSliceFlag {
Name : otsdbFilters ,
Value : cli . NewStringSlice ( "a" , "b" , "c" , "d" , "e" , "f" , "g" , "h" , "i" , "j" , "k" , "l" , "m" , "n" , "o" , "p" , "q" , "r" , "s" , "t" , "u" , "v" , "w" , "x" , "y" , "z" ) ,
Usage : "Filters to process for discovering metrics in OpenTSDB" ,
} ,
& cli . Int64Flag {
Name : otsdbOffsetDays ,
Usage : "Days to offset our 'starting' point for collecting data from OpenTSDB" ,
Value : 0 ,
} ,
& cli . Int64Flag {
Name : otsdbHardTSStart ,
Usage : "A specific timestamp to start from, will override using an offset" ,
Value : 0 ,
} ,
/ *
because the defaults are set * extremely * low in OpenTSDB ( 10 - 25 results ) , we will
set a larger default limit , but still allow a user to increase / decrease it
* /
& cli . IntFlag {
Name : otsdbQueryLimit ,
Usage : "Result limit on meta queries to OpenTSDB (affects both metric name and tag value queries, recommended to use a value exceeding your largest series)" ,
2021-11-18 18:18:15 +01:00
Value : 100e6 ,
2021-04-08 21:58:06 +02:00
} ,
& cli . BoolFlag {
Name : otsdbMsecsTime ,
Value : false ,
Usage : "Whether OpenTSDB is writing values in milliseconds or seconds" ,
} ,
& cli . BoolFlag {
Name : otsdbNormalize ,
Value : false ,
Usage : "Whether to normalize all data received to lower case before forwarding to VictoriaMetrics" ,
} ,
2024-02-20 16:22:58 +01:00
& cli . StringFlag {
Name : otsdbCertFile ,
Usage : "Optional path to client-side TLS certificate file to use when connecting to -otsdb-addr" ,
} ,
& cli . StringFlag {
Name : otsdbKeyFile ,
Usage : "Optional path to client-side TLS key to use when connecting to -otsdb-addr" ,
} ,
& cli . StringFlag {
Name : otsdbCAFile ,
Usage : "Optional path to TLS CA file to use for verifying connections to -otsdb-addr. By default, system CA is used" ,
} ,
& cli . StringFlag {
Name : otsdbServerName ,
2024-03-08 20:47:36 +01:00
Usage : "Optional TLS server name to use for connections to -otsdb-addr. By default, the server name from -otsdb-addr is used" ,
2024-02-20 16:22:58 +01:00
} ,
& cli . BoolFlag {
Name : otsdbInsecureSkipVerify ,
Usage : "Whether to skip tls verification when connecting to -otsdb-addr" ,
Value : false ,
} ,
2021-04-08 21:58:06 +02:00
}
)
2021-02-01 00:10:16 +01:00
const (
influxAddr = "influx-addr"
influxUser = "influx-user"
influxPassword = "influx-password"
influxDB = "influx-database"
influxRetention = "influx-retention-policy"
influxChunkSize = "influx-chunk-size"
influxConcurrency = "influx-concurrency"
influxFilterSeries = "influx-filter-series"
influxFilterTimeStart = "influx-filter-time-start"
influxFilterTimeEnd = "influx-filter-time-end"
influxMeasurementFieldSeparator = "influx-measurement-field-separator"
2022-05-06 17:06:54 +02:00
influxSkipDatabaseLabel = "influx-skip-database-label"
2022-05-07 21:52:42 +02:00
influxPrometheusMode = "influx-prometheus-mode"
2024-02-16 14:59:18 +01:00
influxCertFile = "influx-cert-file"
influxKeyFile = "influx-key-file"
influxCAFile = "influx-CA-file"
influxServerName = "influx-server-name"
influxInsecureSkipVerify = "influx-insecure-skip-verify"
2021-02-01 00:10:16 +01:00
)
var (
influxFlags = [ ] cli . Flag {
& cli . StringFlag {
Name : influxAddr ,
Value : "http://localhost:8086" ,
2021-09-13 16:04:28 +02:00
Usage : "InfluxDB server addr" ,
2021-02-01 00:10:16 +01:00
} ,
& cli . StringFlag {
Name : influxUser ,
2021-09-13 16:04:28 +02:00
Usage : "InfluxDB user" ,
2021-02-01 00:10:16 +01:00
EnvVars : [ ] string { "INFLUX_USERNAME" } ,
} ,
& cli . StringFlag {
Name : influxPassword ,
2021-09-13 16:04:28 +02:00
Usage : "InfluxDB user password" ,
2021-02-01 00:10:16 +01:00
EnvVars : [ ] string { "INFLUX_PASSWORD" } ,
} ,
& cli . StringFlag {
Name : influxDB ,
2021-09-13 16:04:28 +02:00
Usage : "InfluxDB database" ,
2021-02-01 00:10:16 +01:00
Required : true ,
} ,
& cli . StringFlag {
Name : influxRetention ,
2021-09-13 16:04:28 +02:00
Usage : "InfluxDB retention policy" ,
2021-02-01 00:10:16 +01:00
Value : "autogen" ,
} ,
& cli . IntFlag {
Name : influxChunkSize ,
Usage : "The chunkSize defines max amount of series to be returned in one chunk" ,
Value : 10e3 ,
} ,
& cli . IntFlag {
Name : influxConcurrency ,
Usage : "Number of concurrently running fetch queries to InfluxDB" ,
Value : 1 ,
} ,
& cli . StringFlag {
Name : influxFilterSeries ,
2021-09-13 16:04:28 +02:00
Usage : "InfluxDB filter expression to select series. E.g. \"from cpu where arch='x86' AND hostname='host_2753'\".\n" +
2021-02-01 00:10:16 +01:00
"See for details https://docs.influxdata.com/influxdb/v1.7/query_language/schema_exploration#show-series" ,
} ,
& cli . StringFlag {
Name : influxFilterTimeStart ,
Usage : "The time filter to select timeseries with timestamp equal or higher than provided value. E.g. '2020-01-01T20:07:00Z'" ,
} ,
& cli . StringFlag {
Name : influxFilterTimeEnd ,
Usage : "The time filter to select timeseries with timestamp equal or lower than provided value. E.g. '2020-01-01T20:07:00Z'" ,
} ,
& cli . StringFlag {
Name : influxMeasurementFieldSeparator ,
Usage : "The {separator} symbol used to concatenate {measurement} and {field} names into series name {measurement}{separator}{field}." ,
Value : "_" ,
} ,
2022-05-06 17:06:54 +02:00
& cli . BoolFlag {
Name : influxSkipDatabaseLabel ,
Usage : "Wether to skip adding the label 'db' to timeseries." ,
Value : false ,
} ,
2022-05-07 21:52:42 +02:00
& cli . BoolFlag {
Name : influxPrometheusMode ,
2024-02-16 15:22:44 +01:00
Usage : "Whether to restore the original timeseries name previously written from Prometheus to InfluxDB v1 via remote_write." ,
2022-05-07 21:52:42 +02:00
Value : false ,
} ,
2024-02-16 14:59:18 +01:00
& cli . StringFlag {
Name : influxCertFile ,
2024-02-16 15:22:44 +01:00
Usage : "Optional path to client-side TLS certificate file to use when connecting to -influx-addr" ,
2024-02-16 14:59:18 +01:00
} ,
& cli . StringFlag {
Name : influxKeyFile ,
2024-02-16 15:22:44 +01:00
Usage : "Optional path to client-side TLS key to use when connecting to -influx-addr" ,
2024-02-16 14:59:18 +01:00
} ,
& cli . StringFlag {
Name : influxCAFile ,
2024-02-16 15:22:44 +01:00
Usage : "Optional path to TLS CA file to use for verifying connections to -influx-addr. By default, system CA is used" ,
2024-02-16 14:59:18 +01:00
} ,
& cli . StringFlag {
Name : influxServerName ,
2024-02-16 15:22:44 +01:00
Usage : "Optional TLS server name to use for connections to -influx-addr. By default, the server name from -influx-addr is used" ,
2024-02-16 14:59:18 +01:00
} ,
& cli . BoolFlag {
Name : influxInsecureSkipVerify ,
2024-02-16 15:22:44 +01:00
Usage : "Whether to skip tls verification when connecting to -influx-addr" ,
2024-02-16 14:59:18 +01:00
Value : false ,
} ,
2021-02-01 00:10:16 +01:00
}
)
const (
promSnapshot = "prom-snapshot"
promConcurrency = "prom-concurrency"
promFilterTimeStart = "prom-filter-time-start"
promFilterTimeEnd = "prom-filter-time-end"
promFilterLabel = "prom-filter-label"
promFilterLabelValue = "prom-filter-label-value"
)
var (
promFlags = [ ] cli . Flag {
& cli . StringFlag {
Name : promSnapshot ,
Usage : "Path to Prometheus snapshot. Pls see for details https://www.robustperception.io/taking-snapshots-of-prometheus-data" ,
Required : true ,
} ,
& cli . IntFlag {
Name : promConcurrency ,
Usage : "Number of concurrently running snapshot readers" ,
Value : 1 ,
} ,
& cli . StringFlag {
Name : promFilterTimeStart ,
Usage : "The time filter in RFC3339 format to select timeseries with timestamp equal or higher than provided value. E.g. '2020-01-01T20:07:00Z'" ,
} ,
& cli . StringFlag {
Name : promFilterTimeEnd ,
Usage : "The time filter in RFC3339 format to select timeseries with timestamp equal or lower than provided value. E.g. '2020-01-01T20:07:00Z'" ,
} ,
& cli . StringFlag {
Name : promFilterLabel ,
Usage : "Prometheus label name to filter timeseries by. E.g. '__name__' will filter timeseries by name." ,
} ,
& cli . StringFlag {
Name : promFilterLabelValue ,
Usage : fmt . Sprintf ( "Prometheus regular expression to filter label from %q flag." , promFilterLabel ) ,
Value : ".*" ,
} ,
}
)
const (
2023-12-12 13:05:44 +01:00
vmNativeFilterMatch = "vm-native-filter-match"
vmNativeFilterTimeStart = "vm-native-filter-time-start"
vmNativeFilterTimeEnd = "vm-native-filter-time-end"
vmNativeFilterTimeReverse = "vm-native-filter-time-reverse"
vmNativeStepInterval = "vm-native-step-interval"
2021-02-01 00:10:16 +01:00
2023-12-15 12:36:28 +01:00
vmNativeDisableBinaryProtocol = "vm-native-disable-binary-protocol"
vmNativeDisableHTTPKeepAlive = "vm-native-disable-http-keep-alive"
vmNativeDisablePerMetricMigration = "vm-native-disable-per-metric-migration"
2023-03-09 09:47:46 +01:00
2024-01-11 14:04:32 +01:00
vmNativeSrcAddr = "vm-native-src-addr"
vmNativeSrcUser = "vm-native-src-user"
vmNativeSrcPassword = "vm-native-src-password"
vmNativeSrcHeaders = "vm-native-src-headers"
vmNativeSrcBearerToken = "vm-native-src-bearer-token"
2024-03-08 19:52:55 +01:00
vmNativeSrcCertFile = "vm-native-src-cert-file"
vmNativeSrcKeyFile = "vm-native-src-key-file"
vmNativeSrcCAFile = "vm-native-src-ca-file"
vmNativeSrcServerName = "vm-native-src-server-name"
2024-01-11 14:04:32 +01:00
vmNativeSrcInsecureSkipVerify = "vm-native-src-insecure-skip-verify"
2021-02-01 00:10:16 +01:00
2024-01-11 14:04:32 +01:00
vmNativeDstAddr = "vm-native-dst-addr"
vmNativeDstUser = "vm-native-dst-user"
vmNativeDstPassword = "vm-native-dst-password"
vmNativeDstHeaders = "vm-native-dst-headers"
vmNativeDstBearerToken = "vm-native-dst-bearer-token"
2024-03-08 19:52:55 +01:00
vmNativeDstCertFile = "vm-native-dst-cert-file"
vmNativeDstKeyFile = "vm-native-dst-key-file"
vmNativeDstCAFile = "vm-native-dst-ca-file"
vmNativeDstServerName = "vm-native-dst-server-name"
2024-01-11 14:04:32 +01:00
vmNativeDstInsecureSkipVerify = "vm-native-dst-insecure-skip-verify"
2024-08-03 19:12:48 +02:00
vmNativeBackoffRetries = "vm-native-backoff-retries"
vmNativeBackoffFactor = "vm-native-backoff-factor"
vmNativeBackoffMinDuration = "vm-native-backoff-min-duration"
2021-02-01 00:10:16 +01:00
)
var (
vmNativeFlags = [ ] cli . Flag {
& cli . StringFlag {
Name : vmNativeFilterMatch ,
Usage : "Time series selector to match series for export. For example, select {instance!=\"localhost\"} will " +
"match all series with \"instance\" label different to \"localhost\".\n" +
" See more details here https://github.com/VictoriaMetrics/VictoriaMetrics#how-to-export-data-in-native-format" ,
Value : ` { __name__!=""} ` ,
} ,
& cli . StringFlag {
2023-03-02 13:19:45 +01:00
Name : vmNativeFilterTimeStart ,
2024-04-18 03:11:03 +02:00
Usage : "The time filter may contain different timestamp formats. See more details here https://docs.victoriametrics.com/single-server-victoriametrics/#timestamp-formats" ,
2023-03-02 13:19:45 +01:00
Required : true ,
2021-02-01 00:10:16 +01:00
} ,
& cli . StringFlag {
Name : vmNativeFilterTimeEnd ,
2024-04-18 03:11:03 +02:00
Usage : "The time filter may contain different timestamp formats. See more details here https://docs.victoriametrics.com/single-server-victoriametrics/#timestamp-formats" ,
2021-02-01 00:10:16 +01:00
} ,
2022-09-06 09:09:34 +02:00
& cli . StringFlag {
2023-08-12 16:32:11 +02:00
Name : vmNativeStepInterval ,
2023-12-12 13:44:21 +01:00
Usage : fmt . Sprintf ( "The time interval to split the migration into steps. For example, to migrate 1y of data with '--%s=month' vmctl will execute it in 12 separate requests from the beginning of the time range to its end. To reverse the order use '--%s'. Requires setting '--%s'. Valid values are '%s','%s','%s','%s','%s'." ,
vmNativeStepInterval , vmNativeFilterTimeReverse , vmNativeFilterTimeStart , stepper . StepMonth , stepper . StepWeek , stepper . StepDay , stepper . StepHour , stepper . StepMinute ) ,
2023-05-18 13:43:35 +02:00
Value : stepper . StepMonth ,
2022-09-06 09:09:34 +02:00
} ,
2023-12-12 13:05:44 +01:00
& cli . BoolFlag {
Name : vmNativeFilterTimeReverse ,
2023-12-12 13:44:21 +01:00
Usage : fmt . Sprintf ( "Whether to reverse the order of time intervals split by '--%s' cmd-line flag. When set, the migration will start from the newest to the oldest data." , vmNativeStepInterval ) ,
2023-12-12 13:05:44 +01:00
Value : false ,
} ,
2023-03-09 09:47:46 +01:00
& cli . BoolFlag {
Name : vmNativeDisableHTTPKeepAlive ,
Usage : "Disable HTTP persistent connections for requests made to VictoriaMetrics components during export" ,
Value : false ,
} ,
2021-02-01 00:10:16 +01:00
& cli . StringFlag {
Name : vmNativeSrcAddr ,
Usage : "VictoriaMetrics address to perform export from. \n" +
2021-04-20 10:42:17 +02:00
" Should be the same as --httpListenAddr value for single-node version or vmselect component." +
2024-04-18 02:54:20 +02:00
" If exporting from cluster version see https://docs.victoriametrics.com/cluster-victoriametrics/#url-format" ,
2021-02-01 00:10:16 +01:00
Required : true ,
} ,
& cli . StringFlag {
Name : vmNativeSrcUser ,
Usage : "VictoriaMetrics username for basic auth" ,
EnvVars : [ ] string { "VM_NATIVE_SRC_USERNAME" } ,
} ,
& cli . StringFlag {
Name : vmNativeSrcPassword ,
Usage : "VictoriaMetrics password for basic auth" ,
EnvVars : [ ] string { "VM_NATIVE_SRC_PASSWORD" } ,
} ,
2023-03-06 11:22:31 +01:00
& cli . StringFlag {
Name : vmNativeSrcHeaders ,
Usage : "Optional HTTP headers to send with each request to the corresponding source address. \n" +
"For example, --vm-native-src-headers='My-Auth:foobar' would send 'My-Auth: foobar' HTTP header with every request to the corresponding source address. \n" +
"Multiple headers must be delimited by '^^': --vm-native-src-headers='header1:value1^^header2:value2'" ,
} ,
2023-03-09 14:53:29 +01:00
& cli . StringFlag {
Name : vmNativeSrcBearerToken ,
Usage : "Optional bearer auth token to use for the corresponding `--vm-native-src-addr`" ,
} ,
2024-03-08 20:04:02 +01:00
& cli . StringFlag {
Name : vmNativeSrcCertFile ,
Usage : "Optional path to client-side TLS certificate file to use when connecting to `--vm-native-src-addr`" ,
} ,
& cli . StringFlag {
Name : vmNativeSrcKeyFile ,
Usage : "Optional path to client-side TLS key to use when connecting to `--vm-native-src-addr`" ,
} ,
& cli . StringFlag {
Name : vmNativeSrcCAFile ,
Usage : "Optional path to TLS CA file to use for verifying connections to `--vm-native-src-addr`. By default, system CA is used" ,
} ,
& cli . StringFlag {
Name : vmNativeSrcServerName ,
Usage : "Optional TLS server name to use for connections to `--vm-native-src-addr`. By default, the server name from `--vm-native-src-addr` is used" ,
} ,
& cli . BoolFlag {
Name : vmNativeSrcInsecureSkipVerify ,
Usage : "Whether to skip TLS certificate verification when connecting to `--vm-native-src-addr`" ,
Value : false ,
} ,
2021-02-01 00:10:16 +01:00
& cli . StringFlag {
Name : vmNativeDstAddr ,
Usage : "VictoriaMetrics address to perform import to. \n" +
2021-04-20 10:42:17 +02:00
" Should be the same as --httpListenAddr value for single-node version or vminsert component." +
2024-04-18 02:54:20 +02:00
" If importing into cluster version see https://docs.victoriametrics.com/cluster-victoriametrics/#url-format" ,
2021-02-01 00:10:16 +01:00
Required : true ,
} ,
& cli . StringFlag {
Name : vmNativeDstUser ,
Usage : "VictoriaMetrics username for basic auth" ,
EnvVars : [ ] string { "VM_NATIVE_DST_USERNAME" } ,
} ,
& cli . StringFlag {
Name : vmNativeDstPassword ,
Usage : "VictoriaMetrics password for basic auth" ,
EnvVars : [ ] string { "VM_NATIVE_DST_PASSWORD" } ,
} ,
2023-03-06 11:22:31 +01:00
& cli . StringFlag {
Name : vmNativeDstHeaders ,
Usage : "Optional HTTP headers to send with each request to the corresponding destination address. \n" +
"For example, --vm-native-dst-headers='My-Auth:foobar' would send 'My-Auth: foobar' HTTP header with every request to the corresponding destination address. \n" +
"Multiple headers must be delimited by '^^': --vm-native-dst-headers='header1:value1^^header2:value2'" ,
} ,
2023-03-09 14:53:29 +01:00
& cli . StringFlag {
Name : vmNativeDstBearerToken ,
Usage : "Optional bearer auth token to use for the corresponding `--vm-native-dst-addr`" ,
} ,
2024-03-08 20:04:02 +01:00
& cli . StringFlag {
Name : vmNativeDstCertFile ,
Usage : "Optional path to client-side TLS certificate file to use when connecting to `--vm-native-dst-addr`" ,
} ,
& cli . StringFlag {
Name : vmNativeDstKeyFile ,
Usage : "Optional path to client-side TLS key to use when connecting to `--vm-native-dst-addr`" ,
} ,
& cli . StringFlag {
Name : vmNativeDstCAFile ,
Usage : "Optional path to TLS CA file to use for verifying connections to `--vm-native-dst-addr`. By default, system CA is used" ,
} ,
& cli . StringFlag {
Name : vmNativeDstServerName ,
Usage : "Optional TLS server name to use for connections to `--vm-native-dst-addr`. By default, the server name from `--vm-native-dst-addr` is used" ,
} ,
& cli . BoolFlag {
Name : vmNativeDstInsecureSkipVerify ,
Usage : "Whether to skip TLS certificate verification when connecting to `--vm-native-dst-addr`" ,
Value : false ,
} ,
2021-02-01 00:10:16 +01:00
& cli . StringSliceFlag {
Name : vmExtraLabel ,
Value : nil ,
Usage : "Extra labels, that will be added to imported timeseries. In case of collision, label value defined by flag" +
"will have priority. Flag can be set multiple times, to add few additional labels." ,
} ,
2021-12-24 11:18:07 +01:00
& cli . Int64Flag {
Name : vmRateLimit ,
Usage : "Optional data transfer rate limit in bytes per second.\n" +
2023-05-10 09:50:41 +02:00
"By default, the rate limit is disabled. It can be useful for limiting load on source or destination databases." ,
2021-12-24 11:18:07 +01:00
} ,
2022-12-06 02:18:09 +01:00
& cli . BoolFlag {
Name : vmInterCluster ,
Usage : "Enables cluster-to-cluster migration mode with automatic tenants data migration.\n" +
fmt . Sprintf ( " In this mode --%s flag format is: 'http://vmselect:8481/'. --%s flag format is: http://vminsert:8480/. \n" , vmNativeSrcAddr , vmNativeDstAddr ) +
" TenantID will be appended automatically after discovering tenants from src." ,
} ,
2023-03-02 13:19:45 +01:00
& cli . UintFlag {
Name : vmConcurrency ,
Usage : "Number of workers concurrently performing import requests to VM" ,
Value : 2 ,
} ,
2023-04-14 08:34:54 +02:00
& cli . BoolFlag {
2023-12-15 12:36:28 +01:00
Name : vmNativeDisablePerMetricMigration ,
Usage : "Defines whether to disable per-metric migration and migrate all data via one connection. In this mode, vmctl makes less export/import requests, but can't provide a progress bar or retry failed requests." ,
2023-04-14 08:34:54 +02:00
Value : false ,
} ,
2023-08-01 09:45:50 +02:00
& cli . BoolFlag {
Name : vmNativeDisableBinaryProtocol ,
Usage : "Whether to use https://docs.victoriametrics.com/#how-to-export-data-in-json-line-format" +
"instead of https://docs.victoriametrics.com/#how-to-export-data-in-native-format API." +
"Binary export/import API protocol implies less network and resource usage, as it transfers compressed binary data blocks." +
"Non-binary export/import API is less efficient, but supports deduplication if it is configured on vm-native-src-addr side." ,
Value : false ,
} ,
2024-08-03 19:12:48 +02:00
& cli . IntFlag {
Name : vmNativeBackoffRetries ,
Value : 10 ,
Usage : "How many export/import retries to perform before giving up." ,
} ,
& cli . Float64Flag {
Name : vmNativeBackoffFactor ,
Value : 1.8 ,
Usage : "Factor to multiply the base duration after each failed export/import retry. Must be greater than 1.0" ,
} ,
& cli . DurationFlag {
Name : vmNativeBackoffMinDuration ,
Value : time . Second * 2 ,
Usage : "Minimum duration to wait before the first export/import retry. Each subsequent export/import retry will be multiplied by the '--vm-native-backoff-factor'." ,
} ,
2021-02-01 00:10:16 +01:00
}
)
2022-11-29 22:53:28 +01:00
const (
2023-01-10 23:18:49 +01:00
remoteRead = "remote-read"
remoteReadUseStream = "remote-read-use-stream"
remoteReadConcurrency = "remote-read-concurrency"
remoteReadFilterTimeStart = "remote-read-filter-time-start"
remoteReadFilterTimeEnd = "remote-read-filter-time-end"
2023-12-12 13:05:44 +01:00
remoteReadFilterTimeReverse = "remote-read-filter-time-reverse"
2023-01-10 23:18:49 +01:00
remoteReadFilterLabel = "remote-read-filter-label"
remoteReadFilterLabelValue = "remote-read-filter-label-value"
remoteReadStepInterval = "remote-read-step-interval"
remoteReadSrcAddr = "remote-read-src-addr"
remoteReadUser = "remote-read-user"
remoteReadPassword = "remote-read-password"
remoteReadHTTPTimeout = "remote-read-http-timeout"
remoteReadHeaders = "remote-read-headers"
2024-02-16 15:12:43 +01:00
remoteReadCertFile = "remote-read-cert-file"
remoteReadKeyFile = "remote-read-key-file"
remoteReadCAFile = "remote-read-CA-file"
remoteReadServerName = "remote-read-server-name"
2023-01-10 23:18:49 +01:00
remoteReadInsecureSkipVerify = "remote-read-insecure-skip-verify"
2023-08-01 16:43:00 +02:00
remoteReadDisablePathAppend = "remote-read-disable-path-append"
2022-11-29 22:53:28 +01:00
)
var (
remoteReadFlags = [ ] cli . Flag {
& cli . IntFlag {
Name : remoteReadConcurrency ,
Usage : "Number of concurrently running remote read readers" ,
Value : 1 ,
} ,
& cli . TimestampFlag {
2023-07-13 17:14:43 +02:00
Name : remoteReadFilterTimeStart ,
Usage : "The time filter in RFC3339 format to select timeseries with timestamp equal or higher than provided value. E.g. '2020-01-01T20:07:00Z'" ,
Layout : time . RFC3339 ,
Required : true ,
2022-11-29 22:53:28 +01:00
} ,
& cli . TimestampFlag {
Name : remoteReadFilterTimeEnd ,
Usage : "The time filter in RFC3339 format to select timeseries with timestamp equal or lower than provided value. E.g. '2020-01-01T20:07:00Z'" ,
Layout : time . RFC3339 ,
} ,
& cli . StringFlag {
Name : remoteReadFilterLabel ,
Usage : "Prometheus label name to filter timeseries by. E.g. '__name__' will filter timeseries by name." ,
Value : "__name__" ,
} ,
& cli . StringFlag {
Name : remoteReadFilterLabelValue ,
Usage : fmt . Sprintf ( "Prometheus regular expression to filter label from %q flag." , remoteReadFilterLabelValue ) ,
Value : ".*" ,
} ,
& cli . BoolFlag {
Name : remoteRead ,
Usage : "Use Prometheus remote read protocol" ,
Value : false ,
} ,
& cli . BoolFlag {
Name : remoteReadUseStream ,
2023-05-10 09:50:41 +02:00
Usage : "Defines whether to use SAMPLES or STREAMED_XOR_CHUNKS mode. By default, is uses SAMPLES mode. See https://prometheus.io/docs/prometheus/latest/querying/remote_read_api/#streamed-chunks" ,
2022-11-29 22:53:28 +01:00
Value : false ,
} ,
& cli . StringFlag {
2023-12-12 13:44:21 +01:00
Name : remoteReadStepInterval ,
Usage : fmt . Sprintf ( "The time interval to split the migration into steps. For example, to migrate 1y of data with '--%s=month' vmctl will execute it in 12 separate requests from the beginning of the time range to its end. To reverse the order use '--%s'. Requires setting '--%s'. Valid values are '%s','%s','%s','%s','%s'." ,
remoteReadStepInterval , remoteReadFilterTimeReverse , remoteReadFilterTimeStart , stepper . StepMonth , stepper . StepWeek , stepper . StepDay , stepper . StepHour , stepper . StepMinute ) , Required : true ,
2022-11-29 22:53:28 +01:00
} ,
2023-12-12 13:05:44 +01:00
& cli . BoolFlag {
Name : remoteReadFilterTimeReverse ,
2023-12-12 13:44:21 +01:00
Usage : fmt . Sprintf ( "Whether to reverse the order of time intervals split by '--%s' cmd-line flag. When set, the migration will start from the newest to the oldest data." , remoteReadStepInterval ) ,
2023-12-12 13:05:44 +01:00
Value : false ,
} ,
2022-11-29 22:53:28 +01:00
& cli . StringFlag {
Name : remoteReadSrcAddr ,
Usage : "Remote read address to perform read from." ,
Required : true ,
} ,
& cli . StringFlag {
Name : remoteReadUser ,
Usage : "Remote read username for basic auth" ,
EnvVars : [ ] string { "REMOTE_READ_USERNAME" } ,
} ,
& cli . StringFlag {
Name : remoteReadPassword ,
Usage : "Remote read password for basic auth" ,
EnvVars : [ ] string { "REMOTE_READ_PASSWORD" } ,
} ,
& cli . DurationFlag {
Name : remoteReadHTTPTimeout ,
2023-02-28 09:50:33 +01:00
Usage : "Timeout defines timeout for HTTP requests made by remote read client" ,
2022-11-29 22:53:28 +01:00
} ,
& cli . StringFlag {
Name : remoteReadHeaders ,
Value : "" ,
Usage : "Optional HTTP headers to send with each request to the corresponding remote source storage \n" +
"For example, --remote-read-headers='My-Auth:foobar' would send 'My-Auth: foobar' HTTP header with every request to the corresponding remote source storage. \n" +
"Multiple headers must be delimited by '^^': --remote-read-headers='header1:value1^^header2:value2'" ,
} ,
2024-02-16 15:12:43 +01:00
& cli . StringFlag {
Name : remoteReadCertFile ,
2024-02-16 15:22:44 +01:00
Usage : "Optional path to client-side TLS certificate file to use when connecting to -remote-read-src-addr" ,
2024-02-16 15:12:43 +01:00
} ,
& cli . StringFlag {
Name : remoteReadKeyFile ,
2024-02-16 15:22:44 +01:00
Usage : "Optional path to client-side TLS key to use when connecting to -remote-read-src-addr" ,
2024-02-16 15:12:43 +01:00
} ,
& cli . StringFlag {
Name : remoteReadCAFile ,
2024-02-16 15:22:44 +01:00
Usage : "Optional path to TLS CA file to use for verifying connections to -remote-read-src-addr. By default, system CA is used" ,
2024-02-16 15:12:43 +01:00
} ,
& cli . StringFlag {
Name : remoteReadServerName ,
2024-02-16 15:22:44 +01:00
Usage : "Optional TLS server name to use for connections to remoteReadSrcAddr. By default, the server name from -remote-read-src-addr is used" ,
2024-02-16 15:12:43 +01:00
} ,
2023-01-10 23:18:49 +01:00
& cli . BoolFlag {
Name : remoteReadInsecureSkipVerify ,
Usage : "Whether to skip TLS certificate verification when connecting to the remote read address" ,
Value : false ,
} ,
2023-08-01 16:43:00 +02:00
& cli . BoolFlag {
Name : remoteReadDisablePathAppend ,
2023-08-11 12:46:08 +02:00
Usage : "Whether to disable automatic appending of the /api/v1/read suffix to --remote-read-src-addr" ,
Value : false ,
2023-08-01 16:43:00 +02:00
} ,
2022-11-29 22:53:28 +01:00
}
)
2021-02-01 00:10:16 +01:00
func mergeFlags ( flags ... [ ] cli . Flag ) [ ] cli . Flag {
var result [ ] cli . Flag
for _ , f := range flags {
result = append ( result , f ... )
}
return result
}