For a broader overview please visit the navigation page.
How to install and run vmanomaly #
To run
vmanomaly
, you need to have VictoriaMetrics Enterprise license. You can get a trial license key here.
The following options are available:
Note: Starting from v1.13.0 there is a mode to keep anomaly detection models on host filesystem after
fit
stage (instead of keeping them in-memory by default); This may lead to noticeable reduction of RAM used on bigger setups. See instructions here.
Note: Starting from v1.16.0, a similar optimization is available for data read from VictoriaMetrics TSDB. See instructions here.
Command-line arguments #
The vmanomaly
service supports several command-line arguments to configure its behavior, including options for licensing, logging levels, and more. These arguments can be passed when starting the service via Docker or any other setup. Below is the list of available options:
Note: Starting from v1.18.5
vmanomaly
support running on config directories, see theconfig
positional arg description in help message below.
You can specify these options when running vmanomaly
to fine-tune logging levels or handle licensing configurations, as per your requirements.
Licensing #
The license key can be passed via the following command-line flags: --license
, --licenseFile
, --license.forceOffline
In order to make it easier to monitor the license expiration date, the following metrics are exposed(see Monitoring section for details on how to scrape them):
Example alerts for vmalert:
Docker #
To run
vmanomaly
, you need to have VictoriaMetrics Enterprise license. You can get a trial license key here.
Below are the steps to get vmanomaly
up and running inside a Docker container:
- Pull Docker image:
- (Optional step) tag the
vmanomaly
Docker image:
- Start the
vmanomaly
Docker container with a license file, use the command below. Make sure to replaceYOUR_LICENSE_FILE_PATH
, andYOUR_CONFIG_FILE_PATH
with your specific details:
In case you found PermissionError: [Errno 13] Permission denied:
in vmanomaly
logs, set user/user group to 1000 in the run command above / in a docker-compose file:
For a complete docker-compose example please refer to our alerting guide, chapter docker-compose
See also:
- Verify the license online OR offline. See the details here.
- How to configure
vmanomaly
Kubernetes with Helm charts #
To run
vmanomaly
, you need to have VictoriaMetrics Enterprise license. You can get a trial license key here.
You can run vmanomaly
in Kubernetes environment
with these Helm charts.
How to configure vmanomaly #
To run vmanomaly
you need to set up configuration file in yaml
format.
Here is an example of config file that will run Facebook Prophet model, that will be retrained every 2 hours on 14 days of previous data. It will generate inference (including anomaly_score
metric) every 1 minute.
Next steps:
- Define how often to run and make inferences in the scheduler section of a config file.
- Setup the datasource to read data from in the reader section.
- Specify where and how to store anomaly detection metrics in the writer section.
- Configure built-in models parameters according to your needs in the models section.
- Integrate your custom models with
vmanomaly
. - Define queries for input data using MetricsQL.
Check also #
Here are other materials that you might find useful: