Project: VictoriaMetrics (Observability and Analysis / Observability)
File: how-to-monitor-k8s.md

sort: 3 weight: 3 title: Kubernetes Monitoring with Managed VictoriaMetrics menu: docs: parent: "managed" weight: 3 aliases: /managed-victoriametrics/how-to-monitor-k8s.html Monitoring kubernetes cluster is necessary to build SLO/SLI, to analyze performance and cost-efficiency of your workloads. To enable kubernetes cluster monitoring, we will be collecting metrics about cluster performance and utilization from kubernetes components like `kube-api-server`, `kube-controller-manager`, `kube-scheduler`, `kube-state-metrics`, `etcd`, `core-dns`, `kubelet` and `kube-proxy`. We will also install some recording rules, alert rules and dashboards to provide visibility of cluster performance, as well as alerting for cluster metrics. For node resource utilization we will be collecting metrics from `node-exporter`. We will also install dashboard and alerts for node related metrics For workloads monitoring in kubernetes cluster we will have . It enables us to define scrape jobs using kubernetes CRDs , . To add alerts or recording rules for workloads we can use CRD In this guide we will be using helm chart This chart will install `VMOperator`, `VMAgent`, `NodeExporter`, `kube-state-metrics`, `grafana` and some service scrape configurations to start monitoring kubernetes cluster components Active Managed VictoriaMetrics instance. You can learn how to signup for Managed VictoriaMetrics . Access to your kubernetes cluster Helm binary. You can find installation Install the Helm chart in a custom namespace Create a unique Kubernetes namespace, for example `monitoring` ```shell kubectl create namespace monitoring ``` Create kubernetes-secrets with token to access your dbaas deployment ```shell kubectl --namespace monitoring create secret generic dbaas-write-access-token --from-literal=bearerToken=your-token kubectl --namespace monitoring create secret generic dbaas-read-access-token --from-literal=bearerToken=your-token ``` You can find your access token on the "Access" tab of your deployment <img src="kubernetes_monitoring.webp"> Set up a Helm repository using the following commands: ```shell helm repo add grafana https://grafana.github.io/helm-charts helm repo add prometheus-community https://prometheus-community.github.io/helm-charts helm repo add vm https://victoriametrics.github.io/helm-charts helm repo update ``` Create a YAML file of Helm values called dbaas.yaml with following content ```yaml externalVM: read: url: <reading url, you can find it in examples on Access page> bearerTokenSecret: name: dbaas-write-access-token key: bearerToken write: url: <reading url, you can find it in examples on Access page> bearerTokenSecret: name: dbaas-read-access-token key: bearerToken vmsingle: enabled: false vmcluster: enabled: false vmalert: enabled: true spec: evaluationInterval: 15s vmagent: enabled: true spec: scrapeInterval: 30s externalLabels: cluster: <your cluster name> grafana: enabled: true ``` Install VictoriaMetrics-k8s-stack helm chart ```shell helm --namespace monitoring install vm vm/victoria-metrics-k8s-stack -f dbaas.yaml -n monitoring ``` Connect to grafana and create your datasource If you are using external grafana, you can skip steps 1-3 and you will need to import dashboards that can be found here manually Get grafana password ```shell kubectl --namespace monitoring get secret vm-grafana -o jsonpath="{.data.admin-password}" | base64 -d ``` Connect to grafana ```shell kubectl --namespace monitoring port-forward service/vm-grafana 3000:80 ``` Open grafana in your browser Use admin as username and password from previous step Click on add datasource Choose VictoriaMetrics or Prometheus as datasource type. Make sure you made this datasource as default for dashboards to work. > You can find token and URL in your deployment, on Access tab <img src="how-to-monitor-k8s_datasource.webp"> You should be able to see data that was sent to your dbaas using VMAgent dashboard You also will be able to see bunch of kubernetes dashboards in your grafana