Compare commits

...

2 Commits

Author SHA1 Message Date
Dominic
d53a9014f5 Merge branch 'master' into add_feature/vmctl_brew 2026-08-24 13:38:24 -04:00
Aqua
a2a376b37d docs: document installation via the official Homebrew tap
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
2026-08-24 13:23:04 -04:00
4 changed files with 11 additions and 1 deletions

View File

@@ -60,6 +60,14 @@ tar xzf victoria-metrics-linux-amd64-v1.150.0.tar.gz
The binary is self-contained and requires no installation - it is ready to run as is.
Alternatively, on macOS or Linux with [Homebrew](https://brew.sh/):
```sh
brew install victoriametrics/tap/victoriametrics
```
This installs the same release binary as `victoria-metrics` and also provides a `brew services start victoriametrics` service definition.
### Step 2: Start VictoriaMetrics
Starting VictoriaMetrics is as simple as executing the binary, with no arguments at all.

View File

@@ -12,7 +12,7 @@ VictoriaMetrics is a fast, cost-effective, and scalable solution for monitoring
{width="600"}
- **Case studies**: [Grammarly, Roblox, Wix, Spotify,...](https://docs.victoriametrics.com/victoriametrics/casestudies/).
- **Available**: [Binary releases](https://github.com/VictoriaMetrics/VictoriaMetrics/releases/latest), Docker images on [Docker Hub](https://hub.docker.com/r/victoriametrics/victoria-metrics/) and [Quay](https://quay.io/repository/victoriametrics/victoria-metrics), [Source code](https://github.com/VictoriaMetrics/VictoriaMetrics).
- **Available**: [Binary releases](https://github.com/VictoriaMetrics/VictoriaMetrics/releases/latest), Docker images on [Docker Hub](https://hub.docker.com/r/victoriametrics/victoria-metrics/) and [Quay](https://quay.io/repository/victoriametrics/victoria-metrics), [Homebrew tap](https://github.com/VictoriaMetrics/homebrew-tap) (`brew install victoriametrics/tap/victoriametrics`), [Source code](https://github.com/VictoriaMetrics/VictoriaMetrics).
- **Deployment types**: [Single-node version](https://docs.victoriametrics.com/) and [Cluster version](https://docs.victoriametrics.com/victoriametrics/cluster-victoriametrics/) under [Apache License 2.0](https://github.com/VictoriaMetrics/VictoriaMetrics/blob/master/LICENSE).
- **Getting started:** Read [key concepts](https://docs.victoriametrics.com/victoriametrics/keyconcepts/) and follow the
[quick start guide](https://docs.victoriametrics.com/victoriametrics/quick-start/).

View File

@@ -26,6 +26,7 @@ See also [LTS releases](https://docs.victoriametrics.com/victoriametrics/lts-rel
## tip
* FEATURE: [vmsingle](https://docs.victoriametrics.com/victoriametrics/single-server-victoriametrics/) and [vmctl](https://docs.victoriametrics.com/victoriametrics/vmctl/): both can now be installed from the official [Homebrew tap](https://github.com/VictoriaMetrics/homebrew-tap) with `brew install victoriametrics/tap/victoriametrics` and `brew install victoriametrics/tap/vmctl`. The formulas install the prebuilt release binaries and include a service definition for `victoria-metrics`.
* FEATURE: [vmagent](https://docs.victoriametrics.com/victoriametrics/vmagent/), [vmsingle](https://docs.victoriametrics.com/victoriametrics/single-server-victoriametrics/), `vmstorage` and `vmselect` in [VictoriaMetrics cluster](https://docs.victoriametrics.com/victoriametrics/cluster-victoriametrics/): expose the `vm_app_prev_shutdown_unclean` gauge. It is set to `1` when the previous process run didn't shut down cleanly. Added the `UncleanShutdown` [alerting rule](https://github.com/VictoriaMetrics/VictoriaMetrics/blob/master/deployment/docker/rules/alerts-health.yml), which fires for 10 minutes after an unclean shutdown is detected. See [#8443](https://github.com/VictoriaMetrics/VictoriaMetrics/issues/8443).
* FEATURE: [vmui](https://docs.victoriametrics.com/victoriametrics/single-server-victoriametrics/#vmui): show the selected time zone UTC offset next to the date/time controls and allow opening time zone settings from it. See [#11332](https://github.com/VictoriaMetrics/VictoriaMetrics/pull/11332).
* FEATURE: [vmsingle](https://docs.victoriametrics.com/victoriametrics/single-server-victoriametrics/), [vmagent](https://docs.victoriametrics.com/victoriametrics/vmagent/), [vmalert](https://docs.victoriametrics.com/victoriametrics/vmalert/), and `vmselect` in [VictoriaMetrics cluster](https://docs.victoriametrics.com/victoriametrics/cluster-victoriametrics/): show how the default value is calculated for command-line flags which derive it from the number of available CPU cores. For example, `-maxConcurrentInserts` now prints `(default 16 = 2*cgroup.AvailableCPUs())` in `-help` output instead of `(default 16)`. Updated flags: `-search.maxConcurrentRequests`, `-search.maxWorkersPerQuery`, `-fs.maxConcurrency`, `-remoteWrite.concurrency`, `-remoteWrite.queues`. See [#9680](https://github.com/VictoriaMetrics/VictoriaMetrics/issues/9680). Thanks to @Vandit1604 for contribution.

View File

@@ -31,6 +31,7 @@ VictoriaMetrics single or cluster version.
vmctl command-line tool is available as:
* docker images at [Docker Hub](https://hub.docker.com/r/victoriametrics/vmctl/) and [Quay](https://quay.io/repository/victoriametrics/vmctl?tab=tags)
* [Binary releases](https://github.com/VictoriaMetrics/VictoriaMetrics/releases/latest) as part of `vmutils` package
* [Homebrew tap](https://github.com/VictoriaMetrics/homebrew-tap) on macOS and Linux: `brew install victoriametrics/tap/vmctl`. The installed binary is named `vmctl`, not `vmctl-prod`.
Download and unpack vmctl:
```sh