Plugins 〉kubernetes


Developer

Grafana Labs

Sign up to receive occasional product news and updates:


Grafana Cloud
Grafana Cloud
  • Grafana, of course
  • 10k series Prometheus metrics
  • 50 GB logs
  • 50 GB traces
  • 2,232 app o11y host hours
  • ...and more
Create free account

No credit card needed, ever.


The kubernetes plugin has been deprecated and is no longer maintained.

Application
grafana

kubernetes

  • Overview
  • Installation
  • Related content

Grafana App for Kubernetes

Kubernetes is an open-source system for automating deployment, scaling, and management of containerized applications.

The Grafana Kubernetes App allows you to monitor your Kubernetes cluster's performance. It includes 4 dashboards, Cluster, Node, Pod/Container and Deployment. It allows for the automatic deployment of the required Prometheus exporters and a default scrape config to use with your in cluster Prometheus deployment. The metrics collected are high-level cluster and node stats as well as lower level pod and container stats. Use the high-level metrics to alert on and the low-level metrics to troubleshoot.

Container Dashboard

Container Dashboard

Node Dashboard

Requirements

  1. Currently only has support for Prometheus
  2. For automatic deployment of the exporters, then Kubernetes 1.6 or higher is required.
  3. Grafana 5.0.0+

Features

  • The app uses Kubernetes tags to allow you to filter pod metrics. Kubernetes clusters tend to have a lot of pods and a lot of pod metrics. The Pod/Container dashboard leverages the pod tags so you can easily find the relevant pod or pods.

  • Easy installation of exporters, either a one click deploy from Grafana or detailed instructions to deploy them manually them with kubectl (also quite easy!)

  • Cluster level metrics that are not available in Heapster, like CPU Capacity vs CPU Usage.

Cluster Metrics

  • Pod Capacity/Usage
  • Memory Capacity/Usage
  • CPU Capacity/Usage
  • Disk Capacity/Usage
  • Overview of Nodes, Pods and Containers

Node Metrics

  • CPU
  • Memory Available
  • Load per CPU
  • Read IOPS
  • Write IOPS
  • %Util
  • Network Traffic/second
  • Network Packets/second
  • Network Errors/second

Pod/Container Metrics

  • Memory Usage
  • Network Traffic
  • CPU Usage
  • Read IOPS
  • Write IOPS

Documentation

Installation

  1. Use the grafana-cli tool to install kubernetes from the commandline:
grafana-cli plugins install kubernetes-app
  1. Restart your Grafana server.

  2. Log into your Grafana instance. Navigate to the Plugins section, found in the Grafana main menu. Click the Apps tabs in the Plugins section and select the newly installed Kubernetes app. To enable the app, click the Config tab and click on the Enable button.

Connecting to your Cluster

  1. Go to the Cluster List page via the Kubernetes app menu.

    Cluster List in main menu

  2. Click the New Cluster button.

  3. Fill in the Auth details for your cluster.

  4. Choose the Prometheus datasource that will be used for reading data in the dashboards.

  5. Click Deploy. This will deploy a Node Exporter DaemonSet, to collect health metrics for every node, and a Deployment that collects cluster metrics.

Feedback and Questions

Please submit any issues with the app on Github.

Installing kubernetes on Grafana Cloud:

For more information, visit the docs on plugin installation.

Installing on a local Grafana:

For local instances, plugins are installed and updated via a simple CLI command. Plugins are not updated automatically, however you will be notified when updates are available right within your Grafana.

1. Install the Application

Use the grafana-cli tool to install kubernetes from the commandline:

grafana-cli plugins install 

The plugin will be installed into your grafana plugins directory; the default is /var/lib/grafana/plugins. More information on the cli tool.

2. Enable it

Next, log into your Grafana instance. Navigate to the Plugins section, found in your Grafana main menu.

Click the Apps tabs in the Plugins section and select the newly installed app.

To enable the app, click the Config tab. Follow the instructions provided with the application and click Enable. The app and any new UI pages are now accessible from within the main menu, as designed by the app creator.

If dashboards have been included with the application, they will attempt to be automatically installed. To view the dashboards, re-import or delete individual dashboards, click the Dashboards tab within the app page.