docs/vmanomaly - patch release 1.18.3 (#7540)
Some checks are pending
build / Build (push) Waiting to run
CodeQL Go / Analyze (push) Waiting to run
main / lint (push) Waiting to run
main / test (test-full) (push) Blocked by required conditions
main / test (test-full-386) (push) Blocked by required conditions
main / test (test-pure) (push) Blocked by required conditions
publish-docs / Build (push) Waiting to run

### Describe Your Changes

`vmanomaly` docs update with patch release 1.18.3

### Checklist

The following checks are **mandatory**:

- [x] My change adheres [VictoriaMetrics contributing
guidelines](https://docs.victoriametrics.com/contributing/).
This commit is contained in:
Fred Navruzov 2024-11-14 18:59:13 +01:00 committed by GitHub
parent 18afeff742
commit a335ed23c7
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
7 changed files with 19 additions and 10 deletions

View File

@ -72,7 +72,7 @@ services:
restart: always restart: always
vmanomaly: vmanomaly:
container_name: vmanomaly container_name: vmanomaly
image: victoriametrics/vmanomaly:v1.18.2 image: victoriametrics/vmanomaly:v1.18.3
depends_on: depends_on:
- "victoriametrics" - "victoriametrics"
ports: ports:

View File

@ -11,14 +11,23 @@ aliases:
--- ---
Please find the changelog for VictoriaMetrics Anomaly Detection below. Please find the changelog for VictoriaMetrics Anomaly Detection below.
## v1.18.3
Released: 2024-11-14
- FIX: This patch release resolves an issue that could cause a service crash when parallelizing data processing with `VmReader`. Affected releases: [v1.18.1](#v1181) - [v1.18.2](#v1182).
## v1.18.2 ## v1.18.2
Released: 2024-11-13 Released: 2024-11-13
> **Note**: In release [v1.18.1](#v1181), an issue was identified that could lead to a service crash during parallelized data processing with [VmReader](https://docs.victoriametrics.com/anomaly-detection/components/reader/#vm-reader). Please update to patch [v1.18.3](#v1183), which resolves this issue.
- IMPROVEMENT: Enhanced the flexibility of the [`ProphetModel`](https://docs.victoriametrics.com/anomaly-detection/components/models/#prophet) for tz-aware data (`tz_aware = True`). The `tz_seasonalities` argument has been reformatted to align with the structure of the existing `seasonalities` argument. For more details, refer to the [model section here](https://docs.victoriametrics.com/anomaly-detection/components/models/#prophet). Additionally, tz-aware support for `ProphetModel` has been added to [`AutoTuned`](https://docs.victoriametrics.com/anomaly-detection/components/models/#autotuned) model wrapper. This feature is automatically enabled if the data is timezone-aware and its timezone is not set to the default ('UTC'), otherwise default timezone-free optimization flow will be used. - IMPROVEMENT: Enhanced the flexibility of the [`ProphetModel`](https://docs.victoriametrics.com/anomaly-detection/components/models/#prophet) for tz-aware data (`tz_aware = True`). The `tz_seasonalities` argument has been reformatted to align with the structure of the existing `seasonalities` argument. For more details, refer to the [model section here](https://docs.victoriametrics.com/anomaly-detection/components/models/#prophet). Additionally, tz-aware support for `ProphetModel` has been added to [`AutoTuned`](https://docs.victoriametrics.com/anomaly-detection/components/models/#autotuned) model wrapper. This feature is automatically enabled if the data is timezone-aware and its timezone is not set to the default ('UTC'), otherwise default timezone-free optimization flow will be used.
## v1.18.1 ## v1.18.1
Released: 2024-11-12 Released: 2024-11-12
> **Note**: In release [v1.18.1](#v1181), an issue was identified that could lead to a service crash during parallelized data processing with [VmReader](https://docs.victoriametrics.com/anomaly-detection/components/reader/#vm-reader). Please update to patch [v1.18.3](#v1183), which resolves this issue.
- IMPROVEMENT: Added a [reader-level](https://docs.victoriametrics.com/anomaly-detection/components/reader/#vm-reader) `data_range` argument, allowing users to define a default *valid* data range for all input queries in `queries`. Individual queries can still override this default with their own `data_range` if needed. - IMPROVEMENT: Added a [reader-level](https://docs.victoriametrics.com/anomaly-detection/components/reader/#vm-reader) `data_range` argument, allowing users to define a default *valid* data range for all input queries in `queries`. Individual queries can still override this default with their own `data_range` if needed.
- IMPROVEMENT: Added the `url` label to enhance labelset consistency across [self-monitoring metrics](https://docs.victoriametrics.com/anomaly-detection/components/monitoring/#metrics-generated-by-vmanomaly) in both [reader](https://docs.victoriametrics.com/anomaly-detection/components/monitoring/#reader-behaviour-metrics) and [writer](https://docs.victoriametrics.com/anomaly-detection/components/monitoring/#writer-behaviour-metrics) components. Metrics affected: - IMPROVEMENT: Added the `url` label to enhance labelset consistency across [self-monitoring metrics](https://docs.victoriametrics.com/anomaly-detection/components/monitoring/#metrics-generated-by-vmanomaly) in both [reader](https://docs.victoriametrics.com/anomaly-detection/components/monitoring/#reader-behaviour-metrics) and [writer](https://docs.victoriametrics.com/anomaly-detection/components/monitoring/#writer-behaviour-metrics) components. Metrics affected:
- `vmanomaly_reader_received_bytes` - `vmanomaly_reader_received_bytes`

View File

@ -159,7 +159,7 @@ services:
# ... # ...
vmanomaly: vmanomaly:
container_name: vmanomaly container_name: vmanomaly
image: victoriametrics/vmanomaly:v1.18.2 image: victoriametrics/vmanomaly:v1.18.3
# ... # ...
ports: ports:
- "8490:8490" - "8490:8490"

View File

@ -229,7 +229,7 @@ This will expose metrics at `http://0.0.0.0:8080/metrics` page.
To use *vmanomaly* you need to pull docker image: To use *vmanomaly* you need to pull docker image:
```sh ```sh
docker pull victoriametrics/vmanomaly:v1.18.2 docker pull victoriametrics/vmanomaly:v1.18.3
``` ```
> Note: please check what is latest release in [CHANGELOG](https://docs.victoriametrics.com/anomaly-detection/changelog/) > Note: please check what is latest release in [CHANGELOG](https://docs.victoriametrics.com/anomaly-detection/changelog/)
@ -239,7 +239,7 @@ docker pull victoriametrics/vmanomaly:v1.18.2
You can put a tag on it for your convenience: You can put a tag on it for your convenience:
```sh ```sh
docker image tag victoriametrics/vmanomaly:v1.18.2 vmanomaly docker image tag victoriametrics/vmanomaly:v1.18.3 vmanomaly
``` ```
Here is an example of how to run *vmanomaly* docker container with [license file](#licensing): Here is an example of how to run *vmanomaly* docker container with [license file](#licensing):

View File

@ -58,13 +58,13 @@ Below are the steps to get `vmanomaly` up and running inside a Docker container:
1. Pull Docker image: 1. Pull Docker image:
```sh ```sh
docker pull victoriametrics/vmanomaly:v1.18.2 docker pull victoriametrics/vmanomaly:v1.18.3
``` ```
2. (Optional step) tag the `vmanomaly` Docker image: 2. (Optional step) tag the `vmanomaly` Docker image:
```sh ```sh
docker image tag victoriametrics/vmanomaly:v1.18.2 vmanomaly docker image tag victoriametrics/vmanomaly:v1.18.3 vmanomaly
``` ```
3. Start the `vmanomaly` Docker container with a *license file*, use the command below. 3. Start the `vmanomaly` Docker container with a *license file*, use the command below.
@ -98,7 +98,7 @@ docker run -it --user 1000:1000 \
services: services:
# ... # ...
vmanomaly: vmanomaly:
image: victoriametrics/vmanomaly:v1.18.2 image: victoriametrics/vmanomaly:v1.18.3
volumes: volumes:
$YOUR_LICENSE_FILE_PATH:/license $YOUR_LICENSE_FILE_PATH:/license
$YOUR_CONFIG_FILE_PATH:/config.yml $YOUR_CONFIG_FILE_PATH:/config.yml

View File

@ -993,7 +993,7 @@ monitoring:
Let's pull the docker image for `vmanomaly`: Let's pull the docker image for `vmanomaly`:
```sh ```sh
docker pull victoriametrics/vmanomaly:v1.18.2 docker pull victoriametrics/vmanomaly:v1.18.3
``` ```
Now we can run the docker container putting as volumes both config and model file: Now we can run the docker container putting as volumes both config and model file:
@ -1007,7 +1007,7 @@ docker run -it \
-v $(PWD)/license:/license \ -v $(PWD)/license:/license \
-v $(PWD)/custom_model.py:/vmanomaly/model/custom.py \ -v $(PWD)/custom_model.py:/vmanomaly/model/custom.py \
-v $(PWD)/custom.yaml:/config.yaml \ -v $(PWD)/custom.yaml:/config.yaml \
victoriametrics/vmanomaly:v1.18.2 /config.yaml \ victoriametrics/vmanomaly:v1.18.3 /config.yaml \
--licenseFile=/license --licenseFile=/license
``` ```

View File

@ -385,7 +385,7 @@ services:
restart: always restart: always
vmanomaly: vmanomaly:
container_name: vmanomaly container_name: vmanomaly
image: victoriametrics/vmanomaly:v1.18.2 image: victoriametrics/vmanomaly:v1.18.3
depends_on: depends_on:
- "victoriametrics" - "victoriametrics"
ports: ports: