diff --git a/docs/VictoriaLogs/LogsQL.md b/docs/VictoriaLogs/LogsQL.md index c3f84bb45..b2bff6996 100644 --- a/docs/VictoriaLogs/LogsQL.md +++ b/docs/VictoriaLogs/LogsQL.md @@ -1829,7 +1829,7 @@ the following query rounds the `request_duration` [field](https://docs.victoriam _time:5m | math round(request_duration, 1e9) as request_duration_nsecs | format '' as request_duration ``` -The `eval` keyword can be used instead of `math` for convenince. For example, the following query calculates `duration_msecs` field +The `eval` keyword can be used instead of `math` for convenience. For example, the following query calculates `duration_msecs` field by multiplying `duration_secs` [field](https://docs.victoriametrics.com/victorialogs/keyconcepts/#data-model) to `1000`: ```logsql diff --git a/docs/VictoriaLogs/logsql-examples.md b/docs/VictoriaLogs/logsql-examples.md index c676d8b9e..971d05646 100644 --- a/docs/VictoriaLogs/logsql-examples.md +++ b/docs/VictoriaLogs/logsql-examples.md @@ -89,7 +89,7 @@ See also: Use [`NOT` logical filter](https://docs.victoriametrics.com/victorialogs/logsql/#logical-filter). For example, the following query returns all the logs without the `INFO` [word](https://docs.victoriametrics.com/victorialogs/logsql/#word) in the [log message](https://docs.victoriametrics.com/victorialogs/keyconcepts/#message-field): -```logsq +```logsql !INFO ``` @@ -345,7 +345,7 @@ _time:5m | stats by (_stream) count() rows | filter rows:>1000 Use [`stats` by time bucket](https://docs.victoriametrics.com/victorialogs/logsql/#stats-by-time-buckets). For example, the following query returns per-hour number of logs with the `error` [word](https://docs.victoriametrics.com/victorialogs/logsql/#word) for the last day: -```logsq +```logsql _time:1d error | stats by (_time:1h) count() rows | sort by (_time) ``` @@ -460,7 +460,7 @@ For example, the following query selects logs from Monday to Friday in working h _time:4w _time:week_range[Mon, Fri] _time:day_range[08:00, 18:00) ``` -It uses implicit [`AND` logical filtere](https://docs.victoriametrics.com/victorialogs/logsql/#logical-filter) for joining multiple filters +It uses implicit [`AND` logical filter](https://docs.victoriametrics.com/victorialogs/logsql/#logical-filter) for joining multiple filters on [`_time` field](https://docs.victoriametrics.com/victorialogs/keyconcepts/#time-field). ## How to find logs with the given phrase containing whitespace? diff --git a/docs/anomaly-detection/components/models.md b/docs/anomaly-detection/components/models.md index 92bb55190..1549fb4ad 100644 --- a/docs/anomaly-detection/components/models.md +++ b/docs/anomaly-detection/components/models.md @@ -177,10 +177,10 @@ models: reader: # ... queries: - query_values_the_lower_the_better: metricql_expression1 # i.e. error rate - query_values_the_higher_the_better: metricql_expression2 # i.e. customer satisfaction rate - query_values_both_direction_matters: metricql_expression3 # i.e. no domain expertise to choose only 1 direction -# other components like writer, schedulers, monitoring + query_values_the_lower_the_better: metricsql_expression1 + query_values_the_higher_the_better: metricsql_expression2 + query_values_both_direction_matters: metricsql_expression3 +# other components like writer, schedule, monitoring ``` ### Minimal deviation from expected diff --git a/docs/operator/CHANGELOG.md b/docs/operator/CHANGELOG.md index b02a5a125..8f7880fc5 100644 --- a/docs/operator/CHANGELOG.md +++ b/docs/operator/CHANGELOG.md @@ -136,7 +136,7 @@ aliases: - [operator](./README.md): adds new `status.updateStatus` field to the all objects with pods. It helps to track rollout updates properly. - [operator](./README.md): adds annotation `operator.victoriametrics/last-applied-spec` to all objects with pods. It helps to track changes and implements proper resource deletion later as part of [issue](https://github.com/VictoriaMetrics/operator/issues/758). - [vmagent](./api.md#vmagent): adds `flush_on_shutdown` to the streamAggrConfig. See this [issue](https://github.com/VictoriaMetrics/operator/issues/860) for details. -- [vmagent](./api.md#vmagent): adds `spec.ingestOnlyMode` experimental field. It switches vmagent into special mode without scrape configuration and config-reloaders. Currently it also disables tls and auth options for remoteWrites, it must be addressed at the next releaes. +- [vmagent](./api.md#vmagent): adds `spec.ingestOnlyMode` experimental field. It switches vmagent into special mode without scrape configuration and config-reloaders. Currently it also disables tls and auth options for remoteWrites, it must be addressed at the next release. - [vmalertmanager](./api.html#vmalertmanager): use `blackhole` as default router if not configuration provided instead of dummy webhook. 9ee567ff9bc93f43dfedcf9361be1be54a5e7597 - [vmalertmanager](./api.html#vmalertmanager): properly assign path for templates, if it's configured at config file and defined via `spec.templates`. 1128fa9e152a52c7a566fe7ac1375fefbfc6b276 - [vmauth](./api.html#vmauth): adds new field `spec.configSecret`, which allows to use vmauth with external configuration stored at secret under `config.yaml` key. Configuration changes can be tracked with extraArgs: `configCheckInterval: 10s` or manually defined config-reloader container. @@ -448,7 +448,7 @@ aliases: ### Fixes - vmalertmanagerconfig: properly build `name` setting for `mute_time_intervals`. It must be uniq https://github.com/VictoriaMetrics/operator/commit/4db1c89abd5360a119e68874d51c27872265acb6 -- vmcluster: add `dedupMinScrape` only if replicationFactor > 1. It must improve overall cluster perfomance. Thanks [@hagen1778](https://github.com/hagen1778) https://github.com/VictoriaMetrics/operator/commit/837d6e71c6298e5a44c3f73f85235560aec4ee60 +- vmcluster: add `dedupMinScrape` only if replicationFactor > 1. It must improve overall cluster performance. Thanks [@hagen1778](https://github.com/hagen1778) https://github.com/VictoriaMetrics/operator/commit/837d6e71c6298e5a44c3f73f85235560aec4ee60 - controllers/vmalert: do not delete annotations from created secret. Thanks [@zoetrope](https://github.com/zoetrope) https://github.com/VictoriaMetrics/operator/pull/588 ### Features @@ -492,12 +492,12 @@ aliases: - dependency: upgrade deps for fs-notify https://github.com/VictoriaMetrics/operator/pull/576 Thanks [@yanggangtony](https://github.com/yanggangtony) - controllers/options: fixes incorrectly used flags at options https://github.com/VictoriaMetrics/operator/commit/eac040c947ab4821bf6eb0eeae22b9b2d02b938c - controllers/self-serviceScrape: prevents matching for auto-created serviceScrapes https://github.com/VictoriaMetrics/operator/issues/578 -- controllers/vmauth: fixes missing ows for serviceScrape https://github.com/VictoriaMetrics/operator/issues/579 +- controllers/vmauth: fixes missing owns for serviceScrape https://github.com/VictoriaMetrics/operator/issues/579 ### Features - adds `/ready` and `/health` api endpoints for probes https://github.com/VictoriaMetrics/operator/commit/b74d103998547fae5e69966bb68eddd08ae1ac00 -- controllers/concurrency: introduce new setting for reconcilation concurrency `controller.maxConcurrentReconciles` https://github.com/VictoriaMetrics/operator/commit/e8bbf9159cd61257d11e515fa77510ab2444a557 https://github.com/VictoriaMetrics/operator/issues/575 +- controllers/concurrency: introduce new setting for reconciliation concurrency `controller.maxConcurrentReconciles` https://github.com/VictoriaMetrics/operator/commit/e8bbf9159cd61257d11e515fa77510ab2444a557 https://github.com/VictoriaMetrics/operator/issues/575 - api/relabelConfig: adds missing `if`, `labels` and `match` actions https://github.com/VictoriaMetrics/operator/commit/93c9e780981ceb6869ee2953056a9bd3b6e6eae7 [Changes][v0.30.1] @@ -570,7 +570,7 @@ aliases: ### Features -* podDistruptionBudget: adds configurable selectors https://github.com/VictoriaMetrics/operator/commit/4f3f5eaf29ad85c6e9b142be5b05ef57b962fcb6 +* PodDisruptionBudget: adds configurable selectors https://github.com/VictoriaMetrics/operator/commit/4f3f5eaf29ad85c6e9b142be5b05ef57b962fcb6 ### New Contributors @@ -736,7 +736,7 @@ aliases: * security: new alpine image with security fixes https://github.com/VictoriaMetrics/operator/commit/c991b5f315ebb3176b98f5cb00c64430efa0d9c1 * alertmanager: metrics endpoint when routePrefix is configured https://github.com/VictoriaMetrics/operator/pull/488 Thanks [@blesswinsamuel](https://github.com/blesswinsamuel) -* alertmanager: Automaticly disable high availability mode for 1 replica in https://github.com/VictoriaMetrics/operator/pull/495. Thanks [@hadesy](https://github.com/hadesy) +* alertmanager: Automaticaly disable high availability mode for 1 replica in https://github.com/VictoriaMetrics/operator/pull/495. Thanks [@hadesy](https://github.com/hadesy) * vmalertmanager: fix extraArgs, add two dashes https://github.com/VictoriaMetrics/operator/pull/503 Thanks [@flokli](https://github.com/flokli) * vmcluster: disables selectNode arg passing to vmselect with enabled `HPA`. It should prevent vmselect cascade restarts https://github.com/VictoriaMetrics/operator/issues/499 * controllers: changes default rate limiter max delay from 16minutes to 2 minutes. https://github.com/VictoriaMetrics/operator/issues/500 @@ -792,7 +792,7 @@ aliases: - Added `StatefulMode` for `VMAgent` it allows to use `Statefulset` instead of `Deployment` https://github.com/VictoriaMetrics/operator/issues/219 - Added `Validation Webhook` for `VMRule`, it allows check errors at rules https://github.com/VictoriaMetrics/operator/issues/471 - Added additional metrics for operator `operator_log_messages_total`, `operator_controller_objects_count`, `operator_reconcile_throttled_events_total`, `vm_app_version`, `vm_app_uptime_seconds`, `vm_app_start_timestamp` https://github.com/VictoriaMetrics/operator/commit/b941a42fb6fdfd8ea99ff190e822cb9314efb9d0 https://github.com/VictoriaMetrics/operator/commit/b3c7286e7dc737c46c4d33aa203c0b598a5ef187 -- Adds rate limiting for `VMAgent` and `VMAlert` reconcilation https://github.com/VictoriaMetrics/operator/commit/dfb6a14e1193089ba5ab112e0acf4e459aba68b4 +- Adds rate limiting for `VMAgent` and `VMAlert` reconciliation https://github.com/VictoriaMetrics/operator/commit/dfb6a14e1193089ba5ab112e0acf4e459aba68b4 ### New Contributors * [@pavan541cs](https://github.com/pavan541cs) made their first contribution in https://github.com/VictoriaMetrics/operator/pull/473 @@ -809,7 +809,7 @@ aliases: - Finalizers at UrlRelabelConfig and additionalScrapeConfigs https://github.com/VictoriaMetrics/operator/issues/442 - vmagent config update after scrape objects secret data changes https://github.com/VictoriaMetrics/operator/issues/443 - Log typos https://github.com/VictoriaMetrics/operator/issues/459 -- Correctly renders `opsgenia_config` for `VMAlertmanagerConfig` https://github.com/VictoriaMetrics/operator/commit/9128b7f24d5d6d98dcf7abc6f212d57cd39b0e7d thanks [@iyuroch](https://github.com/iyuroch) +- Correctly renders `opsgenie_config` for `VMAlertmanagerConfig` https://github.com/VictoriaMetrics/operator/commit/9128b7f24d5d6d98dcf7abc6f212d57cd39b0e7d thanks [@iyuroch](https://github.com/iyuroch) - Updates basic image with CVE fix https://github.com/VictoriaMetrics/operator/commit/f4a9e530be6d5ebd6e450085ec807117b05e80a8 - Adds missing finalizer for `VMSingle` deployment https://github.com/VictoriaMetrics/operator/commit/06dada488d629d4d321985e80d14ee04e099bdfd thanks [@lujiajing1126](https://github.com/lujiajing1126) - `pager_duty` generation for `VMAlertmanagerConfig` https://github.com/VictoriaMetrics/operator/pull/439/files thanks [@okzheng](https://github.com/okzheng) @@ -896,7 +896,7 @@ aliases: ### Features -- bumps VictoriaMetrics appllications versions to the v1.72.0 https://github.com/VictoriaMetrics/operator/commit/de289af8af8472e5299fc6ff6e99749b58012edd +- bumps VictoriaMetrics applications versions to the v1.72.0 https://github.com/VictoriaMetrics/operator/commit/de289af8af8472e5299fc6ff6e99749b58012edd [Changes][v0.22.1] @@ -1007,7 +1007,7 @@ aliases: ### Fixes - Regression at `VMStaticScrape` - basic auth was incorrectly handled https://github.com/VictoriaMetrics/operator/issues/337 -- Convesion from `PodMonitor` to `VMPodScrape` https://github.com/VictoriaMetrics/operator/issues/335 +- Conversion from `PodMonitor` to `VMPodScrape` https://github.com/VictoriaMetrics/operator/issues/335 [Changes][v0.19.1] @@ -1296,7 +1296,7 @@ aliases: ### Fixes -- Fixes `VMAlert` `rule` arg - it was unproperly escaped https://github.com/VictoriaMetrics/operator/commit/870f258b324dbaec1e3d0d8739ff2feffc27bf0a +- Fixes `VMAlert` `rule` arg - it was improperly escaped https://github.com/VictoriaMetrics/operator/commit/870f258b324dbaec1e3d0d8739ff2feffc27bf0a - Fixes `VMProbes`, now it supports relabeling for static targets https://github.com/VictoriaMetrics/operator/commit/b4db7d5128a22d4979d7284e15576322acbc9b4c - Fixes `VMStaticScrape` - adds `honorLabels` and `honorTimestamps` setting to CRD @@ -1328,7 +1328,7 @@ aliases: ### Features - Added finalizers to objects created by operator. It must fix an issue with resource deletion by controller manager. Note, it requires additional rbac access. https://github.com/VictoriaMetrics/operator/issues/159 https://github.com/VictoriaMetrics/operator/pull/189 -- Added new resouce for static targets scrapping - `VMStaticScrape` https://github.com/VictoriaMetrics/operator/issues/155 +- Added new resource for static targets scrapping - `VMStaticScrape` https://github.com/VictoriaMetrics/operator/issues/155 - Added `unlimited` param for default resources - https://github.com/VictoriaMetrics/operator/issues/181 - Added clusterVersion spec to `VMCluster` it should simplify management https://github.com/VictoriaMetrics/operator/issues/176 @@ -1413,7 +1413,7 @@ aliases: ### Fixes - serverName for tlsConfig https://github.com/VictoriaMetrics/operator/issues/144 -- minScrapeInterval for vmstorage https://github.com/VictoriaMetrics/operator/pull/143 Thansk [@umezawatakeshi](https://github.com/umezawatakeshi) +- minScrapeInterval for vmstorage https://github.com/VictoriaMetrics/operator/pull/143 Thanks [@umezawatakeshi](https://github.com/umezawatakeshi) [Changes][v0.7.2] @@ -1496,7 +1496,7 @@ aliases: - PodSecurityPolicy automatically created for each object, with own ServiceAccount, ClusterRole and ClusterRoleBinding. Its possible to use custom PSP. https://github.com/VictoriaMetrics/operator/issues/109 - Adds `VMAgent` rbac auto-creation. -- Adds ServiceAccount auto-creation. Its possible to use custome ServiceAccount instead of default. +- Adds ServiceAccount auto-creation. Its possible to use custom ServiceAccount instead of default. - Adds `ownerReferences` for converted resources from `Prometheus-operator` CRDs, https://github.com/VictoriaMetrics/operator/pull/105 thanks [@teqwve](https://github.com/teqwve) . - Adds `runtimeClassName`, `schedulerName` for all VictoriaMetrics applications. - Adds `topologySpreadConstraints` for all VictoriaMetrics applications. https://github.com/VictoriaMetrics/operator/issues/107. diff --git a/docs/operator/api.md b/docs/operator/api.md index f47c5c9d4..aa7049bf0 100644 --- a/docs/operator/api.md +++ b/docs/operator/api.md @@ -954,7 +954,7 @@ ServiceSpec defines additional service for CRD with user-defined params. by defa | Field | Description | Scheme | Required | | ----- | ----------- | ------ | -------- | -| useAsDefault | UseAsDefault applies changes from given service definition to the main object Service Changing from headless service to clusterIP or loadbalancer may break cross-component communication | bool | false | +| useAsDefault | UseAsDefault applies changes from given service definition to the main object Service Changing from headless service to clusterIP or load balancer may break cross-component communication | bool | false | | metadata | EmbeddedObjectMetadata defines objectMeta for additional service. | [EmbeddedObjectMetadata](#embeddedobjectmetadata) | false | | spec | ServiceSpec describes the attributes that a user creates on a service. More info: https://kubernetes.io/docs/concepts/services-networking/service/ | v1.ServiceSpec | true | diff --git a/docs/operator/enterprise.md b/docs/operator/enterprise.md index 6875cf4c9..3bcf4e2c0 100644 --- a/docs/operator/enterprise.md +++ b/docs/operator/enterprise.md @@ -28,13 +28,13 @@ Operator doesn't have enterprise version for itself, but it supports - [Multiple retentions / Retention filters](./resources/vmcluster.md#retention-filters) - [Advanced per-tenant statistic](./resources/vmcluster.md#advanced-per-tenant-statistic) - [mTLS protection](./resources/vmcluster.md#mtls-protection) - - [Backup atomation](./resources/vmcluster.md#backup-atomation) + - [Backup automation](./resources/vmcluster.md#backup-automation) - [VMRule Enterprise features](./resources/vmrule.md#enterprise-features) - [Multitenancy](./resources/vmrule.md#multitenancy) - [VMSingle Enterprise features](./resources/vmsingle.md#enterprise-features) - [Downsampling](./resources/vmsingle.md#downsampling) - [Retention filters](./resources/vmsingle.md#retention-filters) - - [Backup atomation](./resources/vmsingle.md#backup-atomation) + - [Backup automation](./resources/vmsingle.md#backup-automation) - [VMUser Enterprise features](./resources/vmuser.md#enterprise-features) - [IP Filters](./resources/vmuser.md#ip-filters) diff --git a/docs/operator/resources/README.md b/docs/operator/resources/README.md index 98e723592..ffcf4d554 100644 --- a/docs/operator/resources/README.md +++ b/docs/operator/resources/README.md @@ -183,13 +183,13 @@ Operator supports following [Enterprise features for VictoriaMetrics components] - [Multiple retentions / Retention filters](./vmcluster.md#retention-filters) - [Advanced per-tenant statistic](./vmcluster.md#advanced-per-tenant-statistic) - [mTLS protection](./vmcluster.md#mtls-protection) - - [Backup atomation](./vmcluster.md#backup-atomation) + - [Backup automation](./vmcluster.md#backup-automation) - [VMRule Enterprise features](./vmrule.md#enterprise-features) - [Multitenancy](./vmrule.md#multitenancy) - [VMSingle Enterprise features](./vmsingle.md#enterprise-features) - [Downsampling](./vmsingle.md#downsampling) - [Retention filters](./vmsingle.md#retention-filters) - - [Backup atomation](./vmsingle.md#backup-atomation) + - [Backup automation](./vmsingle.md#backup-automation) - [VMUser Enterprise features](./vmuser.md#enterprise-features) - [IP Filters](./vmuser.md#ip-filters) diff --git a/docs/operator/vars.md b/docs/operator/vars.md index 93204a4b9..439daa66b 100644 --- a/docs/operator/vars.md +++ b/docs/operator/vars.md @@ -13,7 +13,7 @@ menu: updated at Mon Jun 10 12:28:11 UTC 2024 -| varible name | variable default value | variable required | variable description | +| variable name | variable default value | variable required | variable description | | --- | --- | --- | --- | | VM_USECUSTOMCONFIGRELOADER | false | false | enables custom config reloader for vmauth and vmagent,it should speed-up config reloading process. | | VM_CONTAINERREGISTRY | - | false | container registry name prefix, e.g. docker.io |