Monitoring Hub Reference on Cozystack

Monitoring Parameters

Mon, 01 Jan 0001 00:00:00 +0000

Parameters

Common parameters

Name	Description	Type	Value
`host`	The hostname used to access Grafana externally (defaults to ‘grafana’ subdomain for the tenant host).	`string`	`""`

Metrics storage configuration

Name	Description	Type	Value
`metricsStorages`	Configuration of metrics storage instances.	`[]object`	`[...]`
`metricsStorages[i].name`	Name of the storage instance.	`string`	`""`
`metricsStorages[i].retentionPeriod`	Retention period for metrics.	`string`	`""`
`metricsStorages[i].deduplicationInterval`	Deduplication interval for metrics.	`string`	`""`
`metricsStorages[i].storage`	Persistent volume size.	`string`	`10Gi`
`metricsStorages[i].storageClassName`	StorageClass used for the data.	`string`	`""`
`metricsStorages[i].vminsert`	Configuration for vminsert.	`object`	`{}`
`metricsStorages[i].vminsert.minAllowed`	Minimum guaranteed resources.	`object`	`{}`
`metricsStorages[i].vminsert.minAllowed.cpu`	CPU request.	`quantity`	`""`
`metricsStorages[i].vminsert.minAllowed.memory`	Memory request.	`quantity`	`""`
`metricsStorages[i].vminsert.maxAllowed`	Maximum allowed resources.	`object`	`{}`
`metricsStorages[i].vminsert.maxAllowed.cpu`	CPU limit.	`quantity`	`""`
`metricsStorages[i].vminsert.maxAllowed.memory`	Memory limit.	`quantity`	`""`
`metricsStorages[i].vmselect`	Configuration for vmselect.	`object`	`{}`
`metricsStorages[i].vmselect.minAllowed`	Minimum guaranteed resources.	`object`	`{}`
`metricsStorages[i].vmselect.minAllowed.cpu`	CPU request.	`quantity`	`""`
`metricsStorages[i].vmselect.minAllowed.memory`	Memory request.	`quantity`	`""`
`metricsStorages[i].vmselect.maxAllowed`	Maximum allowed resources.	`object`	`{}`
`metricsStorages[i].vmselect.maxAllowed.cpu`	CPU limit.	`quantity`	`""`
`metricsStorages[i].vmselect.maxAllowed.memory`	Memory limit.	`quantity`	`""`
`metricsStorages[i].vmstorage`	Configuration for vmstorage.	`object`	`{}`
`metricsStorages[i].vmstorage.minAllowed`	Minimum guaranteed resources.	`object`	`{}`
`metricsStorages[i].vmstorage.minAllowed.cpu`	CPU request.	`quantity`	`""`
`metricsStorages[i].vmstorage.minAllowed.memory`	Memory request.	`quantity`	`""`
`metricsStorages[i].vmstorage.maxAllowed`	Maximum allowed resources.	`object`	`{}`
`metricsStorages[i].vmstorage.maxAllowed.cpu`	CPU limit.	`quantity`	`""`
`metricsStorages[i].vmstorage.maxAllowed.memory`	Memory limit.	`quantity`	`""`

Logs storage configuration

Name	Description	Type	Value
`logsStorages`	Configuration of logs storage instances.	`[]object`	`[...]`
`logsStorages[i].name`	Name of the storage instance.	`string`	`""`
`logsStorages[i].retentionPeriod`	Retention period for logs.	`string`	`1`
`logsStorages[i].storage`	Persistent volume size.	`string`	`10Gi`
`logsStorages[i].storageClassName`	StorageClass used to store the data.	`string`	`replicated`

Alerta configuration

Name	Description	Type	Value
`alerta`	Configuration for the Alerta service.	`object`	`{}`
`alerta.storage`	Persistent volume size for the database.	`string`	`10Gi`
`alerta.storageClassName`	StorageClass used for the database.	`string`	`""`
`alerta.resources`	Resource configuration.	`object`	`{}`
`alerta.resources.requests`	Resource requests.	`object`	`{}`
`alerta.resources.requests.cpu`	CPU request.	`quantity`	`100m`
`alerta.resources.requests.memory`	Memory request.	`quantity`	`256Mi`
`alerta.resources.limits`	Resource limits.	`object`	`{}`
`alerta.resources.limits.cpu`	CPU limit.	`quantity`	`1`
`alerta.resources.limits.memory`	Memory limit.	`quantity`	`1Gi`
`alerta.alerts`	Alert routing configuration.	`object`	`{}`
`alerta.alerts.telegram`	Configuration for Telegram alerts.	`object`	`{}`
`alerta.alerts.telegram.token`	Telegram bot token.	`string`	`""`
`alerta.alerts.telegram.chatID`	Telegram chat ID(s), separated by commas.	`string`	`""`
`alerta.alerts.telegram.disabledSeverity`	List of severities without alerts (e.g. [“informational”,“warning”]).	`[]string`	`[]`
`alerta.alerts.slack`	Configuration for Slack alerts.	`object`	`{}`
`alerta.alerts.slack.url`	Configuration uri for Slack alerts.	`string`	`""`
`alerta.alerts.slack.disabledSeverity`	List of severities without alerts (e.g. [“informational”,“warning”]).	`[]string`	`[]`

Grafana configuration

Name	Description	Type	Value
`grafana`	Configuration for Grafana.	`object`	`{}`
`grafana.db`	Database configuration.	`object`	`{}`
`grafana.db.size`	Persistent volume size for the database.	`string`	`10Gi`
`grafana.resources`	Resource configuration.	`object`	`{}`
`grafana.resources.requests`	Resource requests.	`object`	`{}`
`grafana.resources.requests.cpu`	CPU request.	`quantity`	`100m`
`grafana.resources.requests.memory`	Memory request.	`quantity`	`256Mi`
`grafana.resources.limits`	Resource limits.	`object`	`{}`
`grafana.resources.limits.cpu`	CPU limit.	`quantity`	`1`
`grafana.resources.limits.memory`	Memory limit.	`quantity`	`1Gi`

Vmagent configuration

Name	Description	Type	Value
`vmagent`	Configuration for VictoriaMetrics Agent.	`object`	`{}`
`vmagent.externalLabels`	External labels applied to all metrics.	`object`	`{}`
`vmagent.remoteWrite`	Remote write configuration.	`object`	`{}`

Monitoring Setup

Mon, 01 Jan 0001 00:00:00 +0000

Overview

Cozystack provides a comprehensive monitoring and alerting system for Kubernetes clusters and applications. The system is based on Victoria Metrics for storing metrics and logs, Grafana for visualization, Alerta for alerting, and WorkloadMonitor for monitoring application states.

The architecture is divided into two levels:

System level: Monitoring of cluster infrastructure
Tenant-specific level: Isolated monitoring for each tenant

Installation of Monitoring

System Monitoring

System monitoring is installed automatically during platform deployment through the HelmRelease monitoring-agents in packages/apps/kubernetes/templates/helmreleases/monitoring-agents.yaml.

Monitoring Dashboards

Mon, 01 Jan 0001 00:00:00 +0000

Overview

Cozystack integrates Grafana as the primary visualization tool for monitoring metrics collected by VictoriaMetrics (VM). This section covers accessing pre-built dashboards, creating custom visualizations, and integrating external data sources to provide comprehensive observability for your Cozystack clusters and applications.

Accessing Grafana

To access Grafana and explore dashboards:

Navigate to the Grafana URL: https://grafana.<tenant-domain>, where <tenant-domain> is your tenant’s domain.
Log in using your tenant credentials (OIDC or token-based authentication).
Once logged in, you can browse pre-configured dashboards in the “Dashboards” section.

For initial setup and configuration details, refer to Monitoring Setup.

Monitoring Logs

Mon, 01 Jan 0001 00:00:00 +0000

Collecting and Storing Logs

Cozystack uses Fluent Bit for log collection and VictoriaLogs for log storage and querying. Logs are collected from various sources within the cluster and stored in dedicated log storages configured per tenant.

Configuring Logs Storages

Log storages are configured through the monitoring hub parameters. Each tenant can have multiple log storage instances with customizable retention periods and storage sizes.

Parameter	Description	Type	Default
`logsStorages`	Array of log storage configurations	`[]object`	`[]`
`logsStorages[i].name`	Name of the storage instance	`string`	`""`
`logsStorages[i].retentionPeriod`	Retention period for logs (e.g., “30d”)	`string`	`"1"`
`logsStorages[i].storage`	Persistent volume size	`string`	`"10Gi"`
`logsStorages[i].storageClassName`	StorageClass for data persistence	`string`	`"replicated"`

For detailed configuration options, see Monitoring Hub Reference.

Custom Metrics Collection

Mon, 01 Jan 0001 00:00:00 +0000

Overview

Cozystack tenant monitoring supports scraping custom metrics from your own applications and exporters. The tenant VMAgent discovers scrape targets through Kubernetes namespace labels, allowing you to connect any application that exposes a Prometheus-compatible /metrics endpoint.

This guide explains how to create VMServiceScrape and VMPodScrape resources so that the tenant VMAgent collects your custom metrics and makes them available in Grafana.

Prerequisites

Monitoring is enabled for your tenant (see Monitoring Setup)
Your application or exporter is deployed and exposes a Prometheus-compatible /metrics endpoint
You have kubectl access to the cluster

Using VMServiceScrape

A VMServiceScrape tells the tenant VMAgent to scrape metrics from endpoints behind a Kubernetes Service.

Monitoring Alerting

Mon, 01 Jan 0001 00:00:00 +0000

Overview

The alerting system in Cozystack integrates Prometheus, Alertmanager, and Alerta to provide comprehensive monitoring and notification capabilities. Alerts are generated based on metrics collected by VMAgent and stored in VMCluster, then routed through Alertmanager for grouping and deduplication, and finally managed by Alerta for notifications via various channels like Telegram and Slack.

Alerting Flow

sequenceDiagram
 participant P as Prometheus
 participant AM as Alertmanager
 participant A as Alerta
 participant T as Telegram
 participant S as Slack
 P->>AM: Send Alert
 AM->>A: Forward Alert
 A->>T: Send Notification
 A->>S: Send Notification

Configuring Alerts in Alerta

Alerta is the alerting system integrated into Cozystack’s monitoring stack. It processes alerts from various sources and provides notifications through multiple channels.