From 1b6d2467ff7420c040e02c7cb16b215ca00ab448 Mon Sep 17 00:00:00 2001 From: dereksfoster99 <62961548+dereksfoster99@users.noreply.github.com> Date: Wed, 14 Apr 2021 11:44:24 -0400 Subject: [PATCH] Update PerTenantStatistic.md --- docs/PerTenantStatistic.md | 28 ++++++++++++++-------------- 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/docs/PerTenantStatistic.md b/docs/PerTenantStatistic.md index 6b63163e9..a1d40d985 100644 --- a/docs/PerTenantStatistic.md +++ b/docs/PerTenantStatistic.md @@ -2,31 +2,31 @@ sort: 10 --- -## Victoria Metrics Cluster Per Tenant Statistic +## VictoriaMetrics Cluster Per Tenant Statistic cluster-per-tenant-stat -Enterprise version of Victoria Metrics Cluster exposes usage statistic for each tenant. +The enterprise version of VictoriaMetrics cluster exposes the usage statistics for each tenant. -The next statistic is exposed: +When the next statistic is exposed: - `vminsert` * `vm_tenant_inserted_rows_total` - the ingestion rate by tenant - `vmselect` - * `vm_tenant_select_requests_duration_ms_total` - query latency by tenant. It can be usefull for identifing tenant with the most heaviest queries - * `vm_tenant_select_requests_total` - total requests. You can calculate request rate (qps) by using this metric + * `vm_tenant_select_requests_duration_ms_total` - query latency by tenant. It can be useful to identify the tenant with the heaviest queries + * `vm_tenant_select_requests_total` - total requests. You can calculate request rate (qps) with this metric - `vmstorage` * `vm_tenant_active_timeseries` - the number of active timeseries - * `vm_tenant_used_tenant_bytes` - the disk spaces is consumed by metrics for particular tenant + * `vm_tenant_used_tenant_bytes` - the disk space consumed by the metrics for a particular tenant * `vm_tenant_timeseries_created_total` - the total number for timeseries by tenant -The information should be scrapped by the agent (`vmagent`, `victoriametrics`, prometheus, etc) and stored in TSDB. This can be the same cluster but a different tenant, but we encourage to use one more instance of TSDB (more lightweight, eg. VM single) for monitoring of monitoring. +The information should be scraped by the agent (`vmagent`, `victoriametrics`, prometheus, etc) and stored in the TSDB. This can be the same cluster but a different tenant however, we encourage the use of one more instance of TSDB (more lightweight, eg. VM single) for the monitoring of monitoring. -the config example for statistic scrapping +the config example for statistic scraping ```yaml scrape_configs: @@ -38,18 +38,18 @@ scrape_configs: ### Visualization -Visualisation of statistic can be done in grafana using this dashboard [link](https://github.com/VictoriaMetrics/VictoriaMetrics/tree/cluster/dashboards/clusterbytenant.json) +Visualisation of statistics can be done in Grafana using this dashboard [link](https://github.com/VictoriaMetrics/VictoriaMetrics/tree/cluster/dashboards/clusterbytenant.json) ### Integration with vmgateway -Per Tenant Statistic is the source data for `vmgateway` rate limiter. More information can be found [here](https://victoriametrics.github.io/vmgateway.html) +Per Tenant Statistics are the source data for the `vmgateway` rate limiter. More information can be found [here](https://victoriametrics.github.io/vmgateway.html) ### Integration with vmalert -You can generate alerts based on each tenant resource usage and notify the system/people about reaching the limits. +You can generate alerts based on each tenants' resource usage and notify the system/users that they are reaching the limits. -here is an example of alert by high churn rate by the tenant +Here is an example of an alert for high churn rate by the tenant ```yaml @@ -65,8 +65,8 @@ here is an example of alert by high churn rate by the tenant severity: warning annotations: summary: "Churn rate is more than 10% for the last 15m" - description: "VM constantly creates new time series at tenant: {{ $labels.accountID }}:{{ $labels.projectID }}.\n + description: "VM constantly creates new time series in the tenant: {{ $labels.accountID }}:{{ $labels.projectID }}.\n This effect is known as Churn Rate.\n - High Churn Rate tightly connected with database performance and may + High Churn Rate is tightly connected with database performance and may result in unexpected OOM's or slow queries." ```