Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?


Understanding kube-state-metrics Service


kube-state-metrics service is a Beta feature as of Paragon Insights Release 4.2.0.

kube-state-metrics is a third-party metrics monitoring service that generates metrics based on the current state of Kubernetes clusters. You can use kube-state-metrics to monitor the health of Kubernetes cluster and services. With Release 4.2.0, kube-state-metrics service is supported as a beta-only feature. kube-state-metrics runs as a cluster service, and is installed automatically when you install Paragon Insights. Once this service is installed, you can enable this service to generate, monitor, and expose metrics of various objects within a Kubernetes cluster.

kube-state-metrics service provides metrics on pods, DaemonSets, deployments, persistent volume, endpoints, ingress, job, lease, and configmap objects that are part of a Kubernetes cluster.

The following is a list of some metrics that are exposed:

  • Pods running in a namespace

  • Pods that are available

  • Information on successful/failed deployments

  • State of persistent volumes

  • Information on currently running, successful, and failed jobs

  • Pods that are in error state

  • Health of deployment and DaemonSets

  • Status and condition of Kubernetes nodes

Enable kube-state-metrics

You can enable kube-state-metrics from the CLI as well as from the Paragon Insights UI.

The following is an overview of steps to enable kube-state-metrics from the UI:

  1. Create a device.

    The device represents the cluster. The device hostname must be the kube-state-metrics service IP. For example, kube-state-metrics.healthbot.svc.cluster.local.

  2. Add the device to a device group.

  3. Create rules with server-monitoring sensor type and relevant kube-state-metrics sensor path(s).

  4. Apply playbooks.

Sample Rules and Playbooks