{"id":878,"date":"2022-01-27T05:12:00","date_gmt":"2022-01-27T05:12:00","guid":{"rendered":"https:\/\/blog.ngocha.biz\/?p=878"},"modified":"2022-01-27T05:12:00","modified_gmt":"2022-01-27T05:12:00","slug":"setup-kube-state-metrics","status":"publish","type":"post","link":"https:\/\/blog.ngocha.biz\/?p=878","title":{"rendered":"How To Setup Kube State Metrics on Kubernetes Cluster"},"content":{"rendered":"

In this blog, we will look at what is Kube State Metrics and its setup on Kubernetes. This blog is part of the Prometheus kubernetes setup tutorial<\/a> series.<\/p>\n

What is Kube State Metrics?<\/h2>\n

Kube State metrics<\/a> is a service that talks to the Kubernetes API server to get all the details about all the API objects like deployments, pods, daemonsets, Statefulsets, etc.<\/p>\n

Primarily it produces metrics in Prometheus format with the stability as the Kubernetes API. Overall it provides kubernetes objects & resources metrics that you cannot get directly from native Kubernetes monitoring components.<\/p>\n

Kube state metrics service exposes all the metrics on \/metrics<\/code> URI. Prometheus<\/a> can scrape all the metrics exposed by Kube state metrics.<\/p>\n

Following are some of the important metrics you can get from Kube state metrics.<\/p>\n

    \n
  1. Node status, node capacity (CPU and memory)<\/li>\n
  2. Replica-set compliance (desired\/available\/unavailable\/updated status of replicas per deployment)<\/li>\n
  3. Pod status (waiting, running, ready, etc)<\/li>\n
  4. Ingress metrics<\/li>\n
  5. PV, PVC metrics<\/li>\n
  6. Daemonset & Statefulset metrics.<\/li>\n
  7. Resource requests and limits.<\/li>\n
  8. Job & Cronjob metrics<\/li>\n<\/ol>\n

    You can check out the detailed supported metrics from the documentation here<\/a>.<\/p>\n

    Kube State Metrics Setup<\/h2>\n

    Kube state metrics is available as a public docker image. You will have to deploy the following Kubernetes objects for Kube state metrics to work.<\/p>\n

      \n
    1. A Service Account<\/strong><\/li>\n
    2. Cluster Role<\/strong> – For kube state metrics to access all the Kubernetes API objects.<\/li>\n
    3. Cluster Role Binding<\/strong> – Binds the service account with the cluster role.<\/li>\n
    4. Kube State Metrics Deployment<\/strong><\/li>\n
    5. Service<\/strong> – To expose the metrics<\/li>\n<\/ol>\n

      All the above Kube state metrics objects will be deployed in the kube-system<\/code> namespace<\/p>\n

      Let’s deploy the components. All the deployment objects are available in Github. You can also find the same deployment object in the official repo<\/a> as well.<\/p>\n

      Step 1:<\/strong> Clone the Github repo<\/p>\n

      git clone https:\/\/github.com\/devopscube\/kube-state-metrics-configs.git<\/code><\/pre>\n
      Step 2: <\/strong>Create all the objects by pointing to the cloned directory.<\/p>\n
      kubectl apply -f kube-state-metrics-configs\/<\/code><\/pre>\n
      Step 3:<\/strong> Check the deployment status using the following command.<\/p>\n
      kubectl get deployments kube-state-metrics -n kube-system<\/code><\/pre>\n
      kube State Metrics Prometheus Config<\/h2>\n
      All the Kube static metrics can be obtained from the Kube state service endpoint on \/metrics<\/code> URI.<\/p>\n
      This configuration can be added as part of the Prometheus job configuration<\/strong>. You need to add the following job configuration to your Prometheus config for Prometheus to scrape all the Kube state metrics.<\/p>\n
      \n
      \ud83d\udca1<\/div>\n
      Note<\/strong><\/b>: If you have followed my prometheus guide, you dont have to add this scrape config. It is already part of the prometheus config<\/a>. You should see the target status “up” after deploying kube state metrics.<\/div>\n<\/div>\n
      If you have follo<\/p>\n
      - job_name: 'kube-state-metrics'\n  static_configs:\n    - targets: ['kube-state-metrics.kube-system.svc.cluster.local:8080']\n<\/code><\/pre>\n
      \n
      Ngu\u1ed3n:<\/strong> How To Setup Kube State Metrics on Kubernetes Cluster \u2014 DevOpsCube<\/a><\/p>\n","protected":false},"excerpt":{"rendered":"
      Source: https:\/\/devopscube.com\/setup-kube-state-metrics\/<\/p>\n","protected":false},"author":1,"featured_media":879,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[1],"tags":[],"class_list":["post-878","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-devops"],"_links":{"self":[{"href":"https:\/\/blog.ngocha.biz\/index.php?rest_route=\/wp\/v2\/posts\/878","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/blog.ngocha.biz\/index.php?rest_route=\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/blog.ngocha.biz\/index.php?rest_route=\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/blog.ngocha.biz\/index.php?rest_route=\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/blog.ngocha.biz\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=878"}],"version-history":[{"count":0,"href":"https:\/\/blog.ngocha.biz\/index.php?rest_route=\/wp\/v2\/posts\/878\/revisions"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/blog.ngocha.biz\/index.php?rest_route=\/wp\/v2\/media\/879"}],"wp:attachment":[{"href":"https:\/\/blog.ngocha.biz\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=878"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/blog.ngocha.biz\/index.php?rest_route=%2Fwp%2Fv2%2Fcategories&post=878"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/blog.ngocha.biz\/index.php?rest_route=%2Fwp%2Fv2%2Ftags&post=878"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}