diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 2af5a433c..c06ce8832 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -6,7 +6,7 @@ body: attributes: value: | Before filling a bug report it would be great to [upgrade](https://docs.victoriametrics.com/#how-to-upgrade) - to [the latest available release](https://github.com/VictoriaMetrics/VictoriaMetrics/releases) + to [the latest available release](https://github.com/VictoriaMetrics/VictoriaMetrics/releases/latest) and verify whether the bug is reproducible there. It's also recommended to read the [troubleshooting docs](https://docs.victoriametrics.com/Troubleshooting.html) first. - type: textarea diff --git a/README.md b/README.md index 0ce11d209..e966a8bb4 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ VictoriaMetrics is a fast, cost-effective and scalable monitoring solution and time series database. -VictoriaMetrics is available in [binary releases](https://github.com/VictoriaMetrics/VictoriaMetrics/releases), +VictoriaMetrics is available in [binary releases](https://github.com/VictoriaMetrics/VictoriaMetrics/releases/latest), [Docker images](https://hub.docker.com/r/victoriametrics/victoria-metrics/), [Snap packages](https://snapcraft.io/victoriametrics) and [source code](https://github.com/VictoriaMetrics/VictoriaMetrics). @@ -29,7 +29,7 @@ If you have questions about VictoriaMetrics, then feel free asking them at [Vict [Contact us](mailto:info@victoriametrics.com) if you need enterprise support for VictoriaMetrics. See [features available in enterprise package](https://docs.victoriametrics.com/enterprise.html). Enterprise binaries can be downloaded and evaluated for free -from [the releases page](https://github.com/VictoriaMetrics/VictoriaMetrics/releases). +from [the releases page](https://github.com/VictoriaMetrics/VictoriaMetrics/releases/latest). See how to request a free trial license [here](https://victoriametrics.com/products/enterprise/trial/). VictoriaMetrics is developed at a fast pace, so it is recommended periodically checking the [CHANGELOG](https://docs.victoriametrics.com/CHANGELOG.html) and performing [regular upgrades](#how-to-upgrade-victoriametrics). @@ -137,7 +137,8 @@ See also [articles and slides about VictoriaMetrics from our users](https://docs ### Install -To quickly try VictoriaMetrics, just download [VictoriaMetrics executable](https://github.com/VictoriaMetrics/VictoriaMetrics/releases) or [Docker image](https://hub.docker.com/r/victoriametrics/victoria-metrics/) and start it with the desired command-line flags. +To quickly try VictoriaMetrics, just download [VictoriaMetrics executable](https://github.com/VictoriaMetrics/VictoriaMetrics/releases/latest) +or [Docker image](https://hub.docker.com/r/victoriametrics/victoria-metrics/) and start it with the desired command-line flags. See also [QuickStart guide](https://docs.victoriametrics.com/Quick-Start.html) for additional information. VictoriaMetrics can also be installed via these installation methods: @@ -328,7 +329,7 @@ too high memory consumption of Prometheus, then try to lower `max_samples_per_se Keep in mind that these two params are tightly connected. Read more about tuning remote write for Prometheus [here](https://prometheus.io/docs/practices/remote_write). -It is recommended upgrading Prometheus to [v2.12.0](https://github.com/prometheus/prometheus/releases) or newer, +It is recommended upgrading Prometheus to [v2.12.0](https://github.com/prometheus/prometheus/releases/latest) or newer, since previous versions may have issues with `remote_write`. Take a look also at [vmagent](https://docs.victoriametrics.com/vmagent.html) @@ -355,9 +356,11 @@ See more in [description](https://github.com/VictoriaMetrics/grafana-datasource# VictoriaMetrics is developed at a fast pace, so it is recommended periodically checking [the CHANGELOG page](https://docs.victoriametrics.com/CHANGELOG.html) and performing regular upgrades. -It is safe upgrading VictoriaMetrics to new versions unless [release notes](https://github.com/VictoriaMetrics/VictoriaMetrics/releases) say otherwise. It is safe skipping multiple versions during the upgrade unless [release notes](https://github.com/VictoriaMetrics/VictoriaMetrics/releases) say otherwise. It is recommended performing regular upgrades to the latest version, since it may contain important bug fixes, performance optimizations or new features. +It is safe upgrading VictoriaMetrics to new versions unless [release notes](https://github.com/VictoriaMetrics/VictoriaMetrics/releases/latest) say otherwise. +It is safe skipping multiple versions during the upgrade unless [release notes](https://github.com/VictoriaMetrics/VictoriaMetrics/releases/latest) say otherwise. +It is recommended performing regular upgrades to the latest version, since it may contain important bug fixes, performance optimizations or new features. -It is also safe downgrading to older versions unless [release notes](https://github.com/VictoriaMetrics/VictoriaMetrics/releases) say otherwise. +It is also safe downgrading to older versions unless [release notes](https://github.com/VictoriaMetrics/VictoriaMetrics/releases/latest) say otherwise. The following steps must be performed during the upgrade / downgrade procedure: @@ -1068,7 +1071,7 @@ VictoriaMetrics supports the following handlers from [Graphite Tags API](https:/ ## How to build from sources -We recommend using either [binary releases](https://github.com/VictoriaMetrics/VictoriaMetrics/releases) or +We recommend using either [binary releases](https://github.com/VictoriaMetrics/VictoriaMetrics/releases/latest) or [docker images](https://hub.docker.com/r/victoriametrics/victoria-metrics/) instead of building VictoriaMetrics from sources. Building from sources is reasonable when developing additional features specific to your needs or when testing bugfixes. @@ -1883,7 +1886,7 @@ to historical data. See [how to configure multiple retentions in VictoriaMetrics cluster](https://docs.victoriametrics.com/Cluster-VictoriaMetrics.html#retention-filters). -Retention filters can be evaluated for free by downloading and using enterprise binaries from [the releases page](https://github.com/VictoriaMetrics/VictoriaMetrics/releases). +Retention filters can be evaluated for free by downloading and using enterprise binaries from [the releases page](https://github.com/VictoriaMetrics/VictoriaMetrics/releases/latest). See how to request a free trial license [here](https://victoriametrics.com/products/enterprise/trial/). ## Downsampling @@ -1905,7 +1908,7 @@ Please, note that intervals of `-downsampling.period` must be multiples of each In case [deduplication](https://docs.victoriametrics.com/#deduplication) is enabled value of `-dedup.minScrapeInterval` must also be multiple of `-downsampling.period` intervals. This is required to ensure consistency of deduplication and downsampling results. -The downsampling can be evaluated for free by downloading and using enterprise binaries from [the releases page](https://github.com/VictoriaMetrics/VictoriaMetrics/releases). +The downsampling can be evaluated for free by downloading and using enterprise binaries from [the releases page](https://github.com/VictoriaMetrics/VictoriaMetrics/releases/latest). See how to request a free trial license [here](https://victoriametrics.com/products/enterprise/trial/). ## Multi-tenancy @@ -2135,7 +2138,7 @@ and [cardinality explorer docs](#cardinality-explorer). * It is recommended inspecting logs during troubleshooting, since they may contain useful information. -* It is recommended upgrading to the latest available release from [this page](https://github.com/VictoriaMetrics/VictoriaMetrics/releases), +* It is recommended upgrading to the latest available release from [this page](https://github.com/VictoriaMetrics/VictoriaMetrics/releases/latest), since the encountered issue could be already fixed there. * It is recommended to have at least 50% of spare resources for CPU, disk IO and RAM, so VictoriaMetrics could handle short spikes in the workload without performance issues. @@ -2341,7 +2344,7 @@ See also [high availability docs](#high-availability) and [backup docs](#backups VictoriaMetrics supports backups via [vmbackup](https://docs.victoriametrics.com/vmbackup.html) and [vmrestore](https://docs.victoriametrics.com/vmrestore.html) tools. We also provide [vmbackupmanager](https://docs.victoriametrics.com/vmbackupmanager.html) tool for enterprise subscribers. -Enterprise binaries can be downloaded and evaluated for free from [the releases page](https://github.com/VictoriaMetrics/VictoriaMetrics/releases). +Enterprise binaries can be downloaded and evaluated for free from [the releases page](https://github.com/VictoriaMetrics/VictoriaMetrics/releases/latest). See how to request a free trial license [here](https://victoriametrics.com/products/enterprise/trial/). ## vmalert diff --git a/app/vmagent/README.md b/app/vmagent/README.md index 5ffe5fd5f..941557f77 100644 --- a/app/vmagent/README.md +++ b/app/vmagent/README.md @@ -46,7 +46,7 @@ additionally to [discovering Prometheus-compatible targets and scraping metrics ## Quick Start -Please download `vmutils-*` archive from [releases page](https://github.com/VictoriaMetrics/VictoriaMetrics/releases) ( +Please download `vmutils-*` archive from [releases page](https://github.com/VictoriaMetrics/VictoriaMetrics/releases/latest) ( `vmagent` is also available in [docker images](https://hub.docker.com/r/victoriametrics/vmagent/tags)), unpack it and pass the following flags to the `vmagent` binary in order to start scraping Prometheus-compatible targets and sending the data to the Prometheus-compatible remote storage: @@ -1025,7 +1025,7 @@ See also [troubleshooting docs](https://docs.victoriametrics.com/Troubleshooting * [Reading metrics from Kafka](#reading-metrics-from-kafka) * [Writing metrics to Kafka](#writing-metrics-to-kafka) -The enterprise version of vmagent is available for evaluation at [releases](https://github.com/VictoriaMetrics/VictoriaMetrics/releases) page +The enterprise version of vmagent is available for evaluation at [releases](https://github.com/VictoriaMetrics/VictoriaMetrics/releases/latest) page in `vmutils-...-enterprise.tar.gz` archives and in [docker images](https://hub.docker.com/r/victoriametrics/vmagent/tags) with tags containing `enterprise` suffix. See how to request a free trial license [here](https://victoriametrics.com/products/enterprise/trial/). @@ -1074,7 +1074,7 @@ data_format = "influx" #### Command-line flags for Kafka consumer These command-line flags are available only in [enterprise](https://docs.victoriametrics.com/enterprise.html) version of `vmagent`, -which can be downloaded for evaluation from [releases](https://github.com/VictoriaMetrics/VictoriaMetrics/releases) page +which can be downloaded for evaluation from [releases](https://github.com/VictoriaMetrics/VictoriaMetrics/releases/latest) page (see `vmutils-...-enterprise.tar.gz` archives) and from [docker images](https://hub.docker.com/r/victoriametrics/vmagent/tags) with tags containing `enterprise` suffix. ``` @@ -1134,7 +1134,7 @@ Two types of auth are supported: ## How to build from sources -We recommend using [official binary releases](https://github.com/VictoriaMetrics/VictoriaMetrics/releases) - `vmagent` is located in the `vmutils-...` archives. +We recommend using [official binary releases](https://github.com/VictoriaMetrics/VictoriaMetrics/releases/latest) - `vmagent` is located in the `vmutils-...` archives. It may be needed to build `vmagent` from source code when developing or testing new feature or bugfix. diff --git a/app/vmalert/README.md b/app/vmalert/README.md index f389ce554..8c02f5eba 100644 --- a/app/vmalert/README.md +++ b/app/vmalert/README.md @@ -439,7 +439,7 @@ If `-clusterMode` is enabled and the `tenant` in a particular group is missing, is obtained from `-defaultTenant.prometheus` or `-defaultTenant.graphite` depending on the `type` of the group. The enterprise version of vmalert is available in `vmutils-*-enterprise.tar.gz` files -at [release page](https://github.com/VictoriaMetrics/VictoriaMetrics/releases) and in `*-enterprise` +at [release page](https://github.com/VictoriaMetrics/VictoriaMetrics/releases/latest) and in `*-enterprise` tags at [Docker Hub](https://hub.docker.com/r/victoriametrics/vmalert/tags). ### Reading rules from object storage @@ -1508,7 +1508,7 @@ software. Please keep simplicity as the main priority. ## How to build from sources It is recommended using -[binary releases](https://github.com/VictoriaMetrics/VictoriaMetrics/releases) +[binary releases](https://github.com/VictoriaMetrics/VictoriaMetrics/releases/latest) * `vmalert` is located in `vmutils-*` archives there. diff --git a/app/vmauth/README.md b/app/vmauth/README.md index 711204187..485039cca 100644 --- a/app/vmauth/README.md +++ b/app/vmauth/README.md @@ -7,7 +7,7 @@ The `-auth.config` can point to either local file or to http url. ## Quick start -Just download `vmutils-*` archive from [releases page](https://github.com/VictoriaMetrics/VictoriaMetrics/releases), unpack it +Just download `vmutils-*` archive from [releases page](https://github.com/VictoriaMetrics/VictoriaMetrics/releases/latest), unpack it and pass the following flag to `vmauth` binary in order to start authorizing and routing requests: ```console @@ -317,7 +317,7 @@ metric without label (if `unauthorized_user` section of config is used). ## How to build from sources -It is recommended using [binary releases](https://github.com/VictoriaMetrics/VictoriaMetrics/releases) - `vmauth` is located in `vmutils-*` archives there. +It is recommended using [binary releases](https://github.com/VictoriaMetrics/VictoriaMetrics/releases/latest) - `vmauth` is located in `vmutils-*` archives there. ### Development build diff --git a/app/vmbackup/README.md b/app/vmbackup/README.md index 284addb8f..5c4b81ecd 100644 --- a/app/vmbackup/README.md +++ b/app/vmbackup/README.md @@ -410,7 +410,7 @@ Run `vmbackup -help` in order to see all the available options: ## How to build from sources -It is recommended using [binary releases](https://github.com/VictoriaMetrics/VictoriaMetrics/releases) - see `vmutils-*` archives there. +It is recommended using [binary releases](https://github.com/VictoriaMetrics/VictoriaMetrics/releases/latest) - see `vmutils-*` archives there. ### Development build diff --git a/app/vmbackupmanager/README.md b/app/vmbackupmanager/README.md index deecd4858..f4422ac44 100644 --- a/app/vmbackupmanager/README.md +++ b/app/vmbackupmanager/README.md @@ -1,7 +1,7 @@ # vmbackupmanager ***vmbackupmanager is a part of [enterprise package](https://docs.victoriametrics.com/enterprise.html). -It is available for download and evaluation at [releases page](https://github.com/VictoriaMetrics/VictoriaMetrics/releases). +It is available for download and evaluation at [releases page](https://github.com/VictoriaMetrics/VictoriaMetrics/releases/latest). See how to request a free trial license [here](https://victoriametrics.com/products/enterprise/trial/).*** The VictoriaMetrics backup manager automates regular backup procedures. It supports the following backup intervals: **hourly**, **daily**, **weekly** and **monthly**. diff --git a/app/vmctl/README.md b/app/vmctl/README.md index 8535d9e34..97fc16945 100644 --- a/app/vmctl/README.md +++ b/app/vmctl/README.md @@ -1064,7 +1064,7 @@ as a proxy between `vmctl` and destination with `-remoteWrite.rateLimit` flag en ## How to build -It is recommended using [binary releases](https://github.com/VictoriaMetrics/VictoriaMetrics/releases) - `vmctl` is located in `vmutils-*` archives there. +It is recommended using [binary releases](https://github.com/VictoriaMetrics/VictoriaMetrics/releases/latest) - `vmctl` is located in `vmutils-*` archives there. ### Development build diff --git a/app/vmgateway/README.md b/app/vmgateway/README.md index 5139210cb..d62469721 100644 --- a/app/vmgateway/README.md +++ b/app/vmgateway/README.md @@ -1,7 +1,7 @@ # vmgateway ***vmgateway is a part of [enterprise package](https://docs.victoriametrics.com/enterprise.html). -It is available for download and evaluation at [releases page](https://github.com/VictoriaMetrics/VictoriaMetrics/releases). +It is available for download and evaluation at [releases page](https://github.com/VictoriaMetrics/VictoriaMetrics/releases/latest). See how to request a free trial license [here](https://victoriametrics.com/products/enterprise/trial/).*** vmgateway diff --git a/app/vmrestore/README.md b/app/vmrestore/README.md index 141cc1e22..142af1dc1 100644 --- a/app/vmrestore/README.md +++ b/app/vmrestore/README.md @@ -203,7 +203,7 @@ i.e. the end result would be similar to [rsync --delete](https://askubuntu.com/q ## How to build from sources -It is recommended using [binary releases](https://github.com/VictoriaMetrics/VictoriaMetrics/releases) - see `vmutils-*` archives there. +It is recommended using [binary releases](https://github.com/VictoriaMetrics/VictoriaMetrics/releases/latest) - see `vmutils-*` archives there. ### Development build diff --git a/deployment/marketplace/digitialocean/one-click-droplet/RELEASE_GUIDE.md b/deployment/marketplace/digitialocean/one-click-droplet/RELEASE_GUIDE.md index 662e5b48b..1000b2e8b 100644 --- a/deployment/marketplace/digitialocean/one-click-droplet/RELEASE_GUIDE.md +++ b/deployment/marketplace/digitialocean/one-click-droplet/RELEASE_GUIDE.md @@ -4,7 +4,7 @@ 1. To build the snapshot in DigitalOcean account you will need API Token and [packer](https://learn.hashicorp.com/tutorials/packer/get-started-install-cli). 2. API Token can be generated on [https://cloud.digitalocean.com/account/api/tokens](https://cloud.digitalocean.com/account/api/tokens) or use already generated from OnePassword. -3. Choose prefered version of VictoriaMetrics on [Github releases](https://github.com/VictoriaMetrics/VictoriaMetrics/releases) page. +3. Choose prefered version of VictoriaMetrics on [Github releases](https://github.com/VictoriaMetrics/VictoriaMetrics/releases/latest) page. 4. Set variables `DIGITALOCEAN_API_TOKEN` with `VM_VERSION` for `packer` environment and run make from example below: ```console diff --git a/deployment/marketplace/vultr/RELEASE_GUIDE.md b/deployment/marketplace/vultr/RELEASE_GUIDE.md index 44386c3e1..9d4664f98 100644 --- a/deployment/marketplace/vultr/RELEASE_GUIDE.md +++ b/deployment/marketplace/vultr/RELEASE_GUIDE.md @@ -4,7 +4,7 @@ 1. To build the snapshot in Vultr account you will need `VULTR_API_KEY` and [packer](https://learn.hashicorp.com/tutorials/packer/get-started-install-cli). 2. `VULTR_API_KEY` can be generated on [https://my.vultr.com/settings/#settingsapi](https://my.vultr.com/settings/#settingsapi) or use already generated from OnePassword. -3. Choose prefered version of VictoriaMetrics on [Github releases](https://github.com/VictoriaMetrics/VictoriaMetrics/releases) page. +3. Choose prefered version of VictoriaMetrics on [Github releases](https://github.com/VictoriaMetrics/VictoriaMetrics/releases/latest) page. 4. Set variables `VULTR_API_KEY` with `VM_VERSION` for `packer` environment and run make from example below: ```console diff --git a/docs/BestPractices.md b/docs/BestPractices.md index e79e612de..7d07f3ead 100644 --- a/docs/BestPractices.md +++ b/docs/BestPractices.md @@ -14,7 +14,8 @@ aliases: ## Install Recommendation -It is recommended running the latest available release of VictoriaMetrics from [this page](https://github.com/VictoriaMetrics/VictoriaMetrics/releases), since it contains all the bugfixes and enhancements. +It is recommended running the latest available release of VictoriaMetrics from [this page](https://github.com/VictoriaMetrics/VictoriaMetrics/releases/latest), +since it contains all the bugfixes and enhancements. There is no need to tune VictoriaMetrics because it uses reasonable defaults for command-line flags. These flags are automatically adjusted for the available CPU and RAM resources. There is no need in Operating System tuning because VictoriaMetrics is optimized for default OS settings. The only option is to increase the limit on the [number of open files in the OS](https://medium.com/@muhammadtriwibowo/set-permanently-ulimit-n-open-files-in-ubuntu-4d61064429a), so VictoriaMetrics could accept more incoming connections and could keep open more data files. @@ -52,7 +53,9 @@ VictoriaMetrics can run also on MacOS for testing and development purposes. ## Upgrade procedure -It is safe to upgrade VictoriaMetrics to new versions unless the [release notes](https://github.com/VictoriaMetrics/VictoriaMetrics/releases) say otherwise. It is safe to skip multiple versions during the upgrade unless release notes say otherwise. It is recommended to perform regular upgrades to the latest version, since it may contain important bug fixes, performance optimizations or new features. +It is safe to upgrade VictoriaMetrics to new versions unless the [release notes](https://github.com/VictoriaMetrics/VictoriaMetrics/releases/latest) say otherwise. +It is safe to skip multiple versions during the upgrade unless release notes say otherwise. It is recommended to perform regular upgrades to the latest version, +since it may contain important bug fixes, performance optimizations or new features. It is also safe to downgrade to the previous version unless release notes say otherwise. diff --git a/docs/Cluster-VictoriaMetrics.md b/docs/Cluster-VictoriaMetrics.md index 062fc0cdb..9b6fd488c 100644 --- a/docs/Cluster-VictoriaMetrics.md +++ b/docs/Cluster-VictoriaMetrics.md @@ -29,7 +29,7 @@ If you have questions about VictoriaMetrics, then feel free asking them at [Vict [Contact us](mailto:info@victoriametrics.com) if you need enterprise support for VictoriaMetrics. See [features available in enterprise package](https://docs.victoriametrics.com/enterprise.html). Enterprise binaries can be downloaded and evaluated for free -from [the releases page](https://github.com/VictoriaMetrics/VictoriaMetrics/releases). +from [the releases page](https://github.com/VictoriaMetrics/VictoriaMetrics/releases/latest). See how to request a free trial license [here](https://victoriametrics.com/products/enterprise/trial/). VictoriaMetrics is developed at a fast pace, so it is recommended periodically checking the [CHANGELOG](https://docs.victoriametrics.com/CHANGELOG.html) and performing [regular upgrades](#how-to-upgrade-victoriametrics). @@ -116,7 +116,7 @@ since untrusted source may break per-tenant data by writing unwanted samples to ## Binaries -Compiled binaries for the cluster version are available in the `assets` section of the [releases page](https://github.com/VictoriaMetrics/VictoriaMetrics/releases). +Compiled binaries for the cluster version are available in the `assets` section of the [releases page](https://github.com/VictoriaMetrics/VictoriaMetrics/releases/latest). Also see archives containing the word `cluster`. Docker images for the cluster version are available here: @@ -290,7 +290,7 @@ When `vmselect` runs with `-clusternativeListenAddr` command-line option, then i See [these docs](https://gist.github.com/f41gh7/76ed8e5fb1ebb9737fe746bae9175ee6) on how to set up mTLS in VictoriaMetrics cluster. -[Enterprise version of VictoriaMetrics](https://docs.victoriametrics.com/enterprise.html) can be downloaded and evaluated for free from [the releases page](https://github.com/VictoriaMetrics/VictoriaMetrics/releases). +[Enterprise version of VictoriaMetrics](https://docs.victoriametrics.com/enterprise.html) can be downloaded and evaluated for free from [the releases page](https://github.com/VictoriaMetrics/VictoriaMetrics/releases/latest). See how to request a free trial license [here](https://victoriametrics.com/products/enterprise/trial/). ## Monitoring @@ -745,14 +745,14 @@ For example, the following config sets retention to 5 days for time series with See also [these docs](https://docs.victoriametrics.com/#retention-filters) for additional details on retention filters. -Enterprise binaries can be downloaded and evaluated for free from [the releases page](https://github.com/VictoriaMetrics/VictoriaMetrics/releases). +Enterprise binaries can be downloaded and evaluated for free from [the releases page](https://github.com/VictoriaMetrics/VictoriaMetrics/releases/latest). See how to request a free trial license [here](https://victoriametrics.com/products/enterprise/trial/). ## Downsampling Downsampling is available in [enterprise version of VictoriaMetrics](https://docs.victoriametrics.com/enterprise.html). It is configured with `-downsampling.period` command-line flag. The same flag value must be passed to both `vmstorage` and `vmselect` nodes. See [these docs](https://docs.victoriametrics.com/#downsampling) for details. -Enterprise binaries can be downloaded and evaluated for free from [the releases page](https://github.com/VictoriaMetrics/VictoriaMetrics/releases). +Enterprise binaries can be downloaded and evaluated for free from [the releases page](https://github.com/VictoriaMetrics/VictoriaMetrics/releases/latest). See how to request a free trial license [here](https://victoriametrics.com/products/enterprise/trial/). ## Profiling diff --git a/docs/FAQ.md b/docs/FAQ.md index c43a62b74..6ce8077d7 100644 --- a/docs/FAQ.md +++ b/docs/FAQ.md @@ -299,7 +299,9 @@ Memory usage for VictoriaMetrics components can be tuned according to the follow ## How can I run VictoriaMetrics on FreeBSD/OpenBSD? -VictoriaMetrics is included in [OpenBSD](https://github.com/openbsd/ports/blob/c1bfea520bbb30d6e5f8d0f09115ace341f820d6/infrastructure/db/user.list#L383) and [FreeBSD](https://www.freebsd.org/cgi/ports.cgi?query=victoria&stype=all) ports so just install it from there or use pre-built binaries from [releases page](https://github.com/VictoriaMetrics/VictoriaMetrics/releases). +VictoriaMetrics is included in [OpenBSD](https://github.com/openbsd/ports/blob/c1bfea520bbb30d6e5f8d0f09115ace341f820d6/infrastructure/db/user.list#L383) +and [FreeBSD](https://www.freebsd.org/cgi/ports.cgi?query=victoria&stype=all) ports so just install it from there +or use pre-built binaries from [releases page](https://github.com/VictoriaMetrics/VictoriaMetrics/releases/latest). ## Does VictoriaMetrics support the Graphite query language? diff --git a/docs/PerTenantStatistic.md b/docs/PerTenantStatistic.md index 3be89eb6a..78f559ec9 100644 --- a/docs/PerTenantStatistic.md +++ b/docs/PerTenantStatistic.md @@ -12,7 +12,7 @@ aliases: # VictoriaMetrics Cluster Per Tenant Statistic -***The per-tenant statistic is a part of [enterprise package](https://docs.victoriametrics.com/enterprise.html). It is available for download and evaluation at [releases page](https://github.com/VictoriaMetrics/VictoriaMetrics/releases). You need to request a [free trial license](https://victoriametrics.com/products/enterprise/trial/) for evaluation.*** +***The per-tenant statistic is a part of [enterprise package](https://docs.victoriametrics.com/enterprise.html). It is available for download and evaluation at [releases page](https://github.com/VictoriaMetrics/VictoriaMetrics/releases/latest). You need to request a [free trial license](https://victoriametrics.com/products/enterprise/trial/) for evaluation.*** cluster-per-tenant-stat diff --git a/docs/Quick-Start.md b/docs/Quick-Start.md index 55e332e78..c0c67522e 100644 --- a/docs/Quick-Start.md +++ b/docs/Quick-Start.md @@ -27,7 +27,7 @@ Single-server-VictoriaMetrics VictoriaMetrics is available as: * [Docker images](https://hub.docker.com/r/victoriametrics/victoria-metrics/) * [Snap packages](https://snapcraft.io/victoriametrics) * [Helm Charts](https://github.com/VictoriaMetrics/helm-charts#list-of-charts) -* [Binary releases](https://github.com/VictoriaMetrics/VictoriaMetrics/releases) +* [Binary releases](https://github.com/VictoriaMetrics/VictoriaMetrics/releases/latest) * [Source code](https://github.com/VictoriaMetrics/VictoriaMetrics). See [How to build from sources](https://docs.victoriametrics.com/Single-server-VictoriaMetrics.html#how-to-build-from-sources) * [VictoriaMetrics on Linode](https://www.linode.com/marketplace/apps/victoriametrics/victoriametrics/) diff --git a/docs/README.md b/docs/README.md index 044242f95..082aa30b4 100644 --- a/docs/README.md +++ b/docs/README.md @@ -16,7 +16,7 @@ title: VictoriaMetrics VictoriaMetrics is a fast, cost-effective and scalable monitoring solution and time series database. -VictoriaMetrics is available in [binary releases](https://github.com/VictoriaMetrics/VictoriaMetrics/releases), +VictoriaMetrics is available in [binary releases](https://github.com/VictoriaMetrics/VictoriaMetrics/releases/latest), [Docker images](https://hub.docker.com/r/victoriametrics/victoria-metrics/), [Snap packages](https://snapcraft.io/victoriametrics) and [source code](https://github.com/VictoriaMetrics/VictoriaMetrics). @@ -32,7 +32,7 @@ If you have questions about VictoriaMetrics, then feel free asking them at [Vict [Contact us](mailto:info@victoriametrics.com) if you need enterprise support for VictoriaMetrics. See [features available in enterprise package](https://docs.victoriametrics.com/enterprise.html). Enterprise binaries can be downloaded and evaluated for free -from [the releases page](https://github.com/VictoriaMetrics/VictoriaMetrics/releases). +from [the releases page](https://github.com/VictoriaMetrics/VictoriaMetrics/releases/latest). See how to request a free trial license [here](https://victoriametrics.com/products/enterprise/trial/). VictoriaMetrics is developed at a fast pace, so it is recommended periodically checking the [CHANGELOG](https://docs.victoriametrics.com/CHANGELOG.html) and performing [regular upgrades](#how-to-upgrade-victoriametrics). @@ -140,7 +140,8 @@ See also [articles and slides about VictoriaMetrics from our users](https://docs ### Install -To quickly try VictoriaMetrics, just download [VictoriaMetrics executable](https://github.com/VictoriaMetrics/VictoriaMetrics/releases) or [Docker image](https://hub.docker.com/r/victoriametrics/victoria-metrics/) and start it with the desired command-line flags. +To quickly try VictoriaMetrics, just download [VictoriaMetrics executable](https://github.com/VictoriaMetrics/VictoriaMetrics/releases/latest) +or [Docker image](https://hub.docker.com/r/victoriametrics/victoria-metrics/) and start it with the desired command-line flags. See also [QuickStart guide](https://docs.victoriametrics.com/Quick-Start.html) for additional information. VictoriaMetrics can also be installed via these installation methods: @@ -331,7 +332,7 @@ too high memory consumption of Prometheus, then try to lower `max_samples_per_se Keep in mind that these two params are tightly connected. Read more about tuning remote write for Prometheus [here](https://prometheus.io/docs/practices/remote_write). -It is recommended upgrading Prometheus to [v2.12.0](https://github.com/prometheus/prometheus/releases) or newer, +It is recommended upgrading Prometheus to [v2.12.0](https://github.com/prometheus/prometheus/releases/latest) or newer, since previous versions may have issues with `remote_write`. Take a look also at [vmagent](https://docs.victoriametrics.com/vmagent.html) @@ -358,9 +359,11 @@ See more in [description](https://github.com/VictoriaMetrics/grafana-datasource# VictoriaMetrics is developed at a fast pace, so it is recommended periodically checking [the CHANGELOG page](https://docs.victoriametrics.com/CHANGELOG.html) and performing regular upgrades. -It is safe upgrading VictoriaMetrics to new versions unless [release notes](https://github.com/VictoriaMetrics/VictoriaMetrics/releases) say otherwise. It is safe skipping multiple versions during the upgrade unless [release notes](https://github.com/VictoriaMetrics/VictoriaMetrics/releases) say otherwise. It is recommended performing regular upgrades to the latest version, since it may contain important bug fixes, performance optimizations or new features. +It is safe upgrading VictoriaMetrics to new versions unless [release notes](https://github.com/VictoriaMetrics/VictoriaMetrics/releases/latest) say otherwise. +It is safe skipping multiple versions during the upgrade unless [release notes](https://github.com/VictoriaMetrics/VictoriaMetrics/releases/latest) say otherwise. +It is recommended performing regular upgrades to the latest version, since it may contain important bug fixes, performance optimizations or new features. -It is also safe downgrading to older versions unless [release notes](https://github.com/VictoriaMetrics/VictoriaMetrics/releases) say otherwise. +It is also safe downgrading to older versions unless [release notes](https://github.com/VictoriaMetrics/VictoriaMetrics/releases/latest) say otherwise. The following steps must be performed during the upgrade / downgrade procedure: @@ -1071,7 +1074,7 @@ VictoriaMetrics supports the following handlers from [Graphite Tags API](https:/ ## How to build from sources -We recommend using either [binary releases](https://github.com/VictoriaMetrics/VictoriaMetrics/releases) or +We recommend using either [binary releases](https://github.com/VictoriaMetrics/VictoriaMetrics/releases/latest) or [docker images](https://hub.docker.com/r/victoriametrics/victoria-metrics/) instead of building VictoriaMetrics from sources. Building from sources is reasonable when developing additional features specific to your needs or when testing bugfixes. @@ -1886,7 +1889,7 @@ to historical data. See [how to configure multiple retentions in VictoriaMetrics cluster](https://docs.victoriametrics.com/Cluster-VictoriaMetrics.html#retention-filters). -Retention filters can be evaluated for free by downloading and using enterprise binaries from [the releases page](https://github.com/VictoriaMetrics/VictoriaMetrics/releases). +Retention filters can be evaluated for free by downloading and using enterprise binaries from [the releases page](https://github.com/VictoriaMetrics/VictoriaMetrics/releases/latest). See how to request a free trial license [here](https://victoriametrics.com/products/enterprise/trial/). ## Downsampling @@ -1908,7 +1911,7 @@ Please, note that intervals of `-downsampling.period` must be multiples of each In case [deduplication](https://docs.victoriametrics.com/#deduplication) is enabled value of `-dedup.minScrapeInterval` must also be multiple of `-downsampling.period` intervals. This is required to ensure consistency of deduplication and downsampling results. -The downsampling can be evaluated for free by downloading and using enterprise binaries from [the releases page](https://github.com/VictoriaMetrics/VictoriaMetrics/releases). +The downsampling can be evaluated for free by downloading and using enterprise binaries from [the releases page](https://github.com/VictoriaMetrics/VictoriaMetrics/releases/latest). See how to request a free trial license [here](https://victoriametrics.com/products/enterprise/trial/). ## Multi-tenancy @@ -2138,7 +2141,7 @@ and [cardinality explorer docs](#cardinality-explorer). * It is recommended inspecting logs during troubleshooting, since they may contain useful information. -* It is recommended upgrading to the latest available release from [this page](https://github.com/VictoriaMetrics/VictoriaMetrics/releases), +* It is recommended upgrading to the latest available release from [this page](https://github.com/VictoriaMetrics/VictoriaMetrics/releases/latest), since the encountered issue could be already fixed there. * It is recommended to have at least 50% of spare resources for CPU, disk IO and RAM, so VictoriaMetrics could handle short spikes in the workload without performance issues. @@ -2344,7 +2347,7 @@ See also [high availability docs](#high-availability) and [backup docs](#backups VictoriaMetrics supports backups via [vmbackup](https://docs.victoriametrics.com/vmbackup.html) and [vmrestore](https://docs.victoriametrics.com/vmrestore.html) tools. We also provide [vmbackupmanager](https://docs.victoriametrics.com/vmbackupmanager.html) tool for enterprise subscribers. -Enterprise binaries can be downloaded and evaluated for free from [the releases page](https://github.com/VictoriaMetrics/VictoriaMetrics/releases). +Enterprise binaries can be downloaded and evaluated for free from [the releases page](https://github.com/VictoriaMetrics/VictoriaMetrics/releases/latest). See how to request a free trial license [here](https://victoriametrics.com/products/enterprise/trial/). ## vmalert diff --git a/docs/Single-server-VictoriaMetrics.md b/docs/Single-server-VictoriaMetrics.md index 0cda2974e..db91525aa 100644 --- a/docs/Single-server-VictoriaMetrics.md +++ b/docs/Single-server-VictoriaMetrics.md @@ -24,7 +24,7 @@ aliases: VictoriaMetrics is a fast, cost-effective and scalable monitoring solution and time series database. -VictoriaMetrics is available in [binary releases](https://github.com/VictoriaMetrics/VictoriaMetrics/releases), +VictoriaMetrics is available in [binary releases](https://github.com/VictoriaMetrics/VictoriaMetrics/releases/latest), [Docker images](https://hub.docker.com/r/victoriametrics/victoria-metrics/), [Snap packages](https://snapcraft.io/victoriametrics) and [source code](https://github.com/VictoriaMetrics/VictoriaMetrics). @@ -40,7 +40,7 @@ If you have questions about VictoriaMetrics, then feel free asking them at [Vict [Contact us](mailto:info@victoriametrics.com) if you need enterprise support for VictoriaMetrics. See [features available in enterprise package](https://docs.victoriametrics.com/enterprise.html). Enterprise binaries can be downloaded and evaluated for free -from [the releases page](https://github.com/VictoriaMetrics/VictoriaMetrics/releases). +from [the releases page](https://github.com/VictoriaMetrics/VictoriaMetrics/releases/latest). See how to request a free trial license [here](https://victoriametrics.com/products/enterprise/trial/). VictoriaMetrics is developed at a fast pace, so it is recommended periodically checking the [CHANGELOG](https://docs.victoriametrics.com/CHANGELOG.html) and performing [regular upgrades](#how-to-upgrade-victoriametrics). @@ -148,7 +148,8 @@ See also [articles and slides about VictoriaMetrics from our users](https://docs ### Install -To quickly try VictoriaMetrics, just download [VictoriaMetrics executable](https://github.com/VictoriaMetrics/VictoriaMetrics/releases) or [Docker image](https://hub.docker.com/r/victoriametrics/victoria-metrics/) and start it with the desired command-line flags. +To quickly try VictoriaMetrics, just download [VictoriaMetrics executable](https://github.com/VictoriaMetrics/VictoriaMetrics/releases/latest) +or [Docker image](https://hub.docker.com/r/victoriametrics/victoria-metrics/) and start it with the desired command-line flags. See also [QuickStart guide](https://docs.victoriametrics.com/Quick-Start.html) for additional information. VictoriaMetrics can also be installed via these installation methods: @@ -339,7 +340,7 @@ too high memory consumption of Prometheus, then try to lower `max_samples_per_se Keep in mind that these two params are tightly connected. Read more about tuning remote write for Prometheus [here](https://prometheus.io/docs/practices/remote_write). -It is recommended upgrading Prometheus to [v2.12.0](https://github.com/prometheus/prometheus/releases) or newer, +It is recommended upgrading Prometheus to [v2.12.0](https://github.com/prometheus/prometheus/releases/latest) or newer, since previous versions may have issues with `remote_write`. Take a look also at [vmagent](https://docs.victoriametrics.com/vmagent.html) @@ -366,9 +367,11 @@ See more in [description](https://github.com/VictoriaMetrics/grafana-datasource# VictoriaMetrics is developed at a fast pace, so it is recommended periodically checking [the CHANGELOG page](https://docs.victoriametrics.com/CHANGELOG.html) and performing regular upgrades. -It is safe upgrading VictoriaMetrics to new versions unless [release notes](https://github.com/VictoriaMetrics/VictoriaMetrics/releases) say otherwise. It is safe skipping multiple versions during the upgrade unless [release notes](https://github.com/VictoriaMetrics/VictoriaMetrics/releases) say otherwise. It is recommended performing regular upgrades to the latest version, since it may contain important bug fixes, performance optimizations or new features. +It is safe upgrading VictoriaMetrics to new versions unless [release notes](https://github.com/VictoriaMetrics/VictoriaMetrics/releases/latest) say otherwise. +It is safe skipping multiple versions during the upgrade unless [release notes](https://github.com/VictoriaMetrics/VictoriaMetrics/releases/latest) say otherwise. +It is recommended performing regular upgrades to the latest version, since it may contain important bug fixes, performance optimizations or new features. -It is also safe downgrading to older versions unless [release notes](https://github.com/VictoriaMetrics/VictoriaMetrics/releases) say otherwise. +It is also safe downgrading to older versions unless [release notes](https://github.com/VictoriaMetrics/VictoriaMetrics/releases/latest) say otherwise. The following steps must be performed during the upgrade / downgrade procedure: @@ -1079,7 +1082,7 @@ VictoriaMetrics supports the following handlers from [Graphite Tags API](https:/ ## How to build from sources -We recommend using either [binary releases](https://github.com/VictoriaMetrics/VictoriaMetrics/releases) or +We recommend using either [binary releases](https://github.com/VictoriaMetrics/VictoriaMetrics/releases/latest) or [docker images](https://hub.docker.com/r/victoriametrics/victoria-metrics/) instead of building VictoriaMetrics from sources. Building from sources is reasonable when developing additional features specific to your needs or when testing bugfixes. @@ -1894,7 +1897,7 @@ to historical data. See [how to configure multiple retentions in VictoriaMetrics cluster](https://docs.victoriametrics.com/Cluster-VictoriaMetrics.html#retention-filters). -Retention filters can be evaluated for free by downloading and using enterprise binaries from [the releases page](https://github.com/VictoriaMetrics/VictoriaMetrics/releases). +Retention filters can be evaluated for free by downloading and using enterprise binaries from [the releases page](https://github.com/VictoriaMetrics/VictoriaMetrics/releases/latest). See how to request a free trial license [here](https://victoriametrics.com/products/enterprise/trial/). ## Downsampling @@ -1916,7 +1919,7 @@ Please, note that intervals of `-downsampling.period` must be multiples of each In case [deduplication](https://docs.victoriametrics.com/#deduplication) is enabled value of `-dedup.minScrapeInterval` must also be multiple of `-downsampling.period` intervals. This is required to ensure consistency of deduplication and downsampling results. -The downsampling can be evaluated for free by downloading and using enterprise binaries from [the releases page](https://github.com/VictoriaMetrics/VictoriaMetrics/releases). +The downsampling can be evaluated for free by downloading and using enterprise binaries from [the releases page](https://github.com/VictoriaMetrics/VictoriaMetrics/releases/latest). See how to request a free trial license [here](https://victoriametrics.com/products/enterprise/trial/). ## Multi-tenancy @@ -2146,7 +2149,7 @@ and [cardinality explorer docs](#cardinality-explorer). * It is recommended inspecting logs during troubleshooting, since they may contain useful information. -* It is recommended upgrading to the latest available release from [this page](https://github.com/VictoriaMetrics/VictoriaMetrics/releases), +* It is recommended upgrading to the latest available release from [this page](https://github.com/VictoriaMetrics/VictoriaMetrics/releases/latest), since the encountered issue could be already fixed there. * It is recommended to have at least 50% of spare resources for CPU, disk IO and RAM, so VictoriaMetrics could handle short spikes in the workload without performance issues. @@ -2352,7 +2355,7 @@ See also [high availability docs](#high-availability) and [backup docs](#backups VictoriaMetrics supports backups via [vmbackup](https://docs.victoriametrics.com/vmbackup.html) and [vmrestore](https://docs.victoriametrics.com/vmrestore.html) tools. We also provide [vmbackupmanager](https://docs.victoriametrics.com/vmbackupmanager.html) tool for enterprise subscribers. -Enterprise binaries can be downloaded and evaluated for free from [the releases page](https://github.com/VictoriaMetrics/VictoriaMetrics/releases). +Enterprise binaries can be downloaded and evaluated for free from [the releases page](https://github.com/VictoriaMetrics/VictoriaMetrics/releases/latest). See how to request a free trial license [here](https://victoriametrics.com/products/enterprise/trial/). ## vmalert diff --git a/docs/Troubleshooting.md b/docs/Troubleshooting.md index 587740b41..61f1d012b 100644 --- a/docs/Troubleshooting.md +++ b/docs/Troubleshooting.md @@ -177,7 +177,7 @@ If you see unexpected or unreliable query results from VictoriaMetrics, then try to the static interval for gaps filling by setting `-search.minStalenessInterval=5m` cmd-line flag (`5m` is the static interval used by Prometheus). -1. Try upgrading to the [latest available version of VictoriaMetrics](https://github.com/VictoriaMetrics/VictoriaMetrics/releases) +1. Try upgrading to the [latest available version of VictoriaMetrics](https://github.com/VictoriaMetrics/VictoriaMetrics/releases/latest) and verifying whether the issue is fixed there. 1. Try executing the query with `trace=1` query arg. This enables query tracing, which may contain diff --git a/docs/VictoriaLogs/README.md b/docs/VictoriaLogs/README.md index 648e54ce9..faa529033 100644 --- a/docs/VictoriaLogs/README.md +++ b/docs/VictoriaLogs/README.md @@ -50,11 +50,11 @@ VictoriaLogs emits its own logs to stdout. It is recommended to investigate thes ## Upgrading -It is safe upgrading VictoriaLogs to new versions unless [release notes](https://github.com/VictoriaMetrics/VictoriaMetrics/releases) say otherwise. -It is safe to skip multiple versions during the upgrade unless [release notes](https://github.com/VictoriaMetrics/VictoriaMetrics/releases) say otherwise. +It is safe upgrading VictoriaLogs to new versions unless [release notes](https://docs.victoriametrics.com/VictoriaLogs/CHANGELOG.html) say otherwise. +It is safe to skip multiple versions during the upgrade unless [release notes](https://docs.victoriametrics.com/VictoriaLogs/CHANGELOG.html) say otherwise. It is recommended to perform regular upgrades to the latest version, since it may contain important bug fixes, performance optimizations or new features. -It is also safe to downgrade to older versions unless [release notes](https://github.com/VictoriaMetrics/VictoriaMetrics/releases) say otherwise. +It is also safe to downgrade to older versions unless [release notes](https://docs.victoriametrics.com/VictoriaLogs/CHANGELOG.html) say otherwise. The following steps must be performed during the upgrade / downgrade procedure: diff --git a/docs/enterprise.md b/docs/enterprise.md index c79e98643..eb7125a69 100644 --- a/docs/enterprise.md +++ b/docs/enterprise.md @@ -18,7 +18,7 @@ and [Enterprise edition](https://victoriametrics.com/products/enterprise/). VictoriaMetrics community components are open source and are free to use - see [the source code](https://github.com/VictoriaMetrics/VictoriaMetrics/) and [the license](https://github.com/VictoriaMetrics/VictoriaMetrics/blob/master/LICENSE). -VictoriaMetrics Enterprise components are available in binary form at [releases page](https://github.com/VictoriaMetrics/VictoriaMetrics/releases) +VictoriaMetrics Enterprise components are available in binary form at [releases page](https://github.com/VictoriaMetrics/VictoriaMetrics/releases/latest) and at [docker hub](https://hub.docker.com/u/victoriametrics). Enterprise binaries and packages have `enterprise` suffix in their names. ## Valid cases for VictoriaMetrics Enterprise @@ -79,11 +79,11 @@ VictoriaMetrics Enterprise components are available in the following forms: It is allowed to run VictoriaMetrics Enterprise components in [cases listed here](#valid-cases-for-victoriametrics-enterprise). -Binary releases of VictoriaMetrics Enterprise are available [at the releases page](https://github.com/VictoriaMetrics/VictoriaMetrics/releases). +Binary releases of VictoriaMetrics Enterprise are available [at the releases page](https://github.com/VictoriaMetrics/VictoriaMetrics/releases/latest). Enterprise binaries and packages have `enterprise` suffix in their names. For example, `victoria-metrics-linux-amd64-v1.94.0-enterprise.tar.gz`. In order to run binary release of VictoriaMetrics Enterprise component, please download the `*-enterprise.tar.gz` archive for your OS and architecture -from the [releases page](https://github.com/VictoriaMetrics/VictoriaMetrics/releases) and unpack it. Then run the unpacked binary. +from the [releases page](https://github.com/VictoriaMetrics/VictoriaMetrics/releases/latest) and unpack it. Then run the unpacked binary. All the VictoriaMetrics Enterprise components prior `v1.94.0` release require `-eula` command-line flag to be passed to them. This flag acknowledges that your usage fits one of the cases listed [here](#valid-cases-for-victoriametrics-enterprise). diff --git a/docs/managed-victoriametrics/alerting-vmalert-managed-victoria-metrics.md b/docs/managed-victoriametrics/alerting-vmalert-managed-victoria-metrics.md index c6fc73a9c..77fc49699 100644 --- a/docs/managed-victoriametrics/alerting-vmalert-managed-victoria-metrics.md +++ b/docs/managed-victoriametrics/alerting-vmalert-managed-victoria-metrics.md @@ -17,7 +17,7 @@ This guide explains the different ways in which you can use vmalert in conjuncti ## Preconditions -* [vmalert](https://docs.victoriametrics.com/vmalert.html) is installed. You can obtain it by building it from [source](https://docs.victoriametrics.com/vmalert.html#quickstart), downloading it from the [GitHub releases page](https://github.com/VictoriaMetrics/VictoriaMetrics/releases), or using the [docker image](https://hub.docker.com/r/victoriametrics/vmalert) for the container ecosystem (such as docker, k8s, etc.). +* [vmalert](https://docs.victoriametrics.com/vmalert.html) is installed. You can obtain it by building it from [source](https://docs.victoriametrics.com/vmalert.html#quickstart), downloading it from the [GitHub releases page](https://github.com/VictoriaMetrics/VictoriaMetrics/releases/latest), or using the [docker image](https://hub.docker.com/r/victoriametrics/vmalert) for the container ecosystem (such as docker, k8s, etc.). * [Alertmanager](https://prometheus.io/docs/alerting/latest/alertmanager/) is installed. * You have a [single or cluster](https://docs.victoriametrics.com/managed-victoriametrics/quickstart.html#creating-deployment) deployment in [Managed VictoriaMetrics](https://docs.victoriametrics.com/managed-victoriametrics/overview.html). * If you are using helm, add the [VictoriaMetrics helm chart](https://github.com/VictoriaMetrics/helm-charts/tree/master/charts/victoria-metrics-alert#how-to-install) repository to your helm repositories. This step is optional. diff --git a/docs/vmagent.md b/docs/vmagent.md index 3cd593dbd..2d767c474 100644 --- a/docs/vmagent.md +++ b/docs/vmagent.md @@ -57,7 +57,7 @@ additionally to [discovering Prometheus-compatible targets and scraping metrics ## Quick Start -Please download `vmutils-*` archive from [releases page](https://github.com/VictoriaMetrics/VictoriaMetrics/releases) ( +Please download `vmutils-*` archive from [releases page](https://github.com/VictoriaMetrics/VictoriaMetrics/releases/latest) ( `vmagent` is also available in [docker images](https://hub.docker.com/r/victoriametrics/vmagent/tags)), unpack it and pass the following flags to the `vmagent` binary in order to start scraping Prometheus-compatible targets and sending the data to the Prometheus-compatible remote storage: @@ -1036,7 +1036,7 @@ See also [troubleshooting docs](https://docs.victoriametrics.com/Troubleshooting * [Reading metrics from Kafka](#reading-metrics-from-kafka) * [Writing metrics to Kafka](#writing-metrics-to-kafka) -The enterprise version of vmagent is available for evaluation at [releases](https://github.com/VictoriaMetrics/VictoriaMetrics/releases) page +The enterprise version of vmagent is available for evaluation at [releases](https://github.com/VictoriaMetrics/VictoriaMetrics/releases/latest) page in `vmutils-...-enterprise.tar.gz` archives and in [docker images](https://hub.docker.com/r/victoriametrics/vmagent/tags) with tags containing `enterprise` suffix. See how to request a free trial license [here](https://victoriametrics.com/products/enterprise/trial/). @@ -1085,7 +1085,7 @@ data_format = "influx" #### Command-line flags for Kafka consumer These command-line flags are available only in [enterprise](https://docs.victoriametrics.com/enterprise.html) version of `vmagent`, -which can be downloaded for evaluation from [releases](https://github.com/VictoriaMetrics/VictoriaMetrics/releases) page +which can be downloaded for evaluation from [releases](https://github.com/VictoriaMetrics/VictoriaMetrics/releases/latest) page (see `vmutils-...-enterprise.tar.gz` archives) and from [docker images](https://hub.docker.com/r/victoriametrics/vmagent/tags) with tags containing `enterprise` suffix. ``` @@ -1145,7 +1145,7 @@ Two types of auth are supported: ## How to build from sources -We recommend using [official binary releases](https://github.com/VictoriaMetrics/VictoriaMetrics/releases) - `vmagent` is located in the `vmutils-...` archives. +We recommend using [official binary releases](https://github.com/VictoriaMetrics/VictoriaMetrics/releases/latest) - `vmagent` is located in the `vmutils-...` archives. It may be needed to build `vmagent` from source code when developing or testing new feature or bugfix. diff --git a/docs/vmalert.md b/docs/vmalert.md index 5265d565e..8fc9aeaca 100644 --- a/docs/vmalert.md +++ b/docs/vmalert.md @@ -450,7 +450,7 @@ If `-clusterMode` is enabled and the `tenant` in a particular group is missing, is obtained from `-defaultTenant.prometheus` or `-defaultTenant.graphite` depending on the `type` of the group. The enterprise version of vmalert is available in `vmutils-*-enterprise.tar.gz` files -at [release page](https://github.com/VictoriaMetrics/VictoriaMetrics/releases) and in `*-enterprise` +at [release page](https://github.com/VictoriaMetrics/VictoriaMetrics/releases/latest) and in `*-enterprise` tags at [Docker Hub](https://hub.docker.com/r/victoriametrics/vmalert/tags). ### Reading rules from object storage @@ -1519,7 +1519,7 @@ software. Please keep simplicity as the main priority. ## How to build from sources It is recommended using -[binary releases](https://github.com/VictoriaMetrics/VictoriaMetrics/releases) +[binary releases](https://github.com/VictoriaMetrics/VictoriaMetrics/releases/latest) * `vmalert` is located in `vmutils-*` archives there. diff --git a/docs/vmauth.md b/docs/vmauth.md index 34b3c8340..8628753aa 100644 --- a/docs/vmauth.md +++ b/docs/vmauth.md @@ -18,7 +18,7 @@ The `-auth.config` can point to either local file or to http url. ## Quick start -Just download `vmutils-*` archive from [releases page](https://github.com/VictoriaMetrics/VictoriaMetrics/releases), unpack it +Just download `vmutils-*` archive from [releases page](https://github.com/VictoriaMetrics/VictoriaMetrics/releases/latest), unpack it and pass the following flag to `vmauth` binary in order to start authorizing and routing requests: ```console @@ -328,7 +328,7 @@ metric without label (if `unauthorized_user` section of config is used). ## How to build from sources -It is recommended using [binary releases](https://github.com/VictoriaMetrics/VictoriaMetrics/releases) - `vmauth` is located in `vmutils-*` archives there. +It is recommended using [binary releases](https://github.com/VictoriaMetrics/VictoriaMetrics/releases/latest) - `vmauth` is located in `vmutils-*` archives there. ### Development build diff --git a/docs/vmbackup.md b/docs/vmbackup.md index b5f959db0..660fc8910 100644 --- a/docs/vmbackup.md +++ b/docs/vmbackup.md @@ -421,7 +421,7 @@ Run `vmbackup -help` in order to see all the available options: ## How to build from sources -It is recommended using [binary releases](https://github.com/VictoriaMetrics/VictoriaMetrics/releases) - see `vmutils-*` archives there. +It is recommended using [binary releases](https://github.com/VictoriaMetrics/VictoriaMetrics/releases/latest) - see `vmutils-*` archives there. ### Development build diff --git a/docs/vmbackupmanager.md b/docs/vmbackupmanager.md index 21f6032f1..94de93680 100644 --- a/docs/vmbackupmanager.md +++ b/docs/vmbackupmanager.md @@ -12,7 +12,7 @@ aliases: # vmbackupmanager ***vmbackupmanager is a part of [enterprise package](https://docs.victoriametrics.com/enterprise.html). -It is available for download and evaluation at [releases page](https://github.com/VictoriaMetrics/VictoriaMetrics/releases). +It is available for download and evaluation at [releases page](https://github.com/VictoriaMetrics/VictoriaMetrics/releases/latest). See how to request a free trial license [here](https://victoriametrics.com/products/enterprise/trial/).*** The VictoriaMetrics backup manager automates regular backup procedures. It supports the following backup intervals: **hourly**, **daily**, **weekly** and **monthly**. diff --git a/docs/vmctl.md b/docs/vmctl.md index d01953dd4..eb3429509 100644 --- a/docs/vmctl.md +++ b/docs/vmctl.md @@ -1075,7 +1075,7 @@ as a proxy between `vmctl` and destination with `-remoteWrite.rateLimit` flag en ## How to build -It is recommended using [binary releases](https://github.com/VictoriaMetrics/VictoriaMetrics/releases) - `vmctl` is located in `vmutils-*` archives there. +It is recommended using [binary releases](https://github.com/VictoriaMetrics/VictoriaMetrics/releases/latest) - `vmctl` is located in `vmutils-*` archives there. ### Development build diff --git a/docs/vmgateway.md b/docs/vmgateway.md index e41d6c426..7b77e7a95 100644 --- a/docs/vmgateway.md +++ b/docs/vmgateway.md @@ -12,7 +12,7 @@ aliases: # vmgateway ***vmgateway is a part of [enterprise package](https://docs.victoriametrics.com/enterprise.html). -It is available for download and evaluation at [releases page](https://github.com/VictoriaMetrics/VictoriaMetrics/releases). +It is available for download and evaluation at [releases page](https://github.com/VictoriaMetrics/VictoriaMetrics/releases/latest). See how to request a free trial license [here](https://victoriametrics.com/products/enterprise/trial/).*** vmgateway diff --git a/docs/vmrestore.md b/docs/vmrestore.md index e0f12cd3e..07ad5815e 100644 --- a/docs/vmrestore.md +++ b/docs/vmrestore.md @@ -214,7 +214,7 @@ i.e. the end result would be similar to [rsync --delete](https://askubuntu.com/q ## How to build from sources -It is recommended using [binary releases](https://github.com/VictoriaMetrics/VictoriaMetrics/releases) - see `vmutils-*` archives there. +It is recommended using [binary releases](https://github.com/VictoriaMetrics/VictoriaMetrics/releases/latest) - see `vmutils-*` archives there. ### Development build