Kubernetes

• Overview
• Setup
  • Prerequisites
  • Configuration
• Metrics and Tags
  • Pod Metrics
  • Pod Metrics Tags
  • Container Metrics
  • Container Metric Tags
  • Node Metrics
  • Node Metric Tags
  • Deployment Metrics
  • Deployment Metric Tags
  • Events Metrics

Overview

This plugin collects runtime metrics from Kubernetes masters and nodes within its cluster. It gathers information about resource usage and performance characteristics.

Setup

The kubernetes plugin is included with the SolarWinds Snap Agent by default, please follow the directions below to enable it on a given host (each Kubernetes Master).

Prerequisites

This plugin requires that the agent user solarwinds has access to a valid kubeconfig and kube-apiserver.

There are different ways to give the agent access to Kubernetes clusters (to the Kubernetes API). One method is to copy your ~/.kube folder to /opt/SolarWinds/Snap/etc:

$ cd /opt/SolarWinds/Snap/etc
$ sudo cp -r ~/.kube .
$ sudo chown -R solarwinds:solarwinds .kube

To check that the agent has access to the Kubernetes API, you can run the following command as the solarwinds user, which retrieves the list of all pods in the current namespace:

$ sudo -u solarwinds kubectl get pods --kubeconfig /opt/SolarWinds/Snap/etc/.kube/config

If the command does not execute successfully, ensure:

1. both the symlinks and source files are owned by the solarwinds group and user.
2. the configured kubeconfigpath is valid.

Configuration

The agent provides an example configuration file to help you get started quickly. It defines the plugin and task file to be loaded by the agent, but requires you to provide the correct settings for your Kubernetes deployment. To enable the plugin:

1. Make a copy of the kubernetes example configuration file /opt/SolarWinds/Snap/etc/plugins.d/kubernetes.yaml.example, renaming it to /opt/SolarWinds/Snap/etc/plugins.d/kubernetes.yaml:

   Copy

   $ sudo cp /opt/SolarWinds/Snap/etc/plugins.d/kubernetes.yaml.example /opt/SolarWinds/Snap/etc/plugins.d/kubernetes.yaml

2. Update the /opt/SolarWinds/Snap/etc/plugins.d/kubernetes.yaml configuration file with settings specific to your Kubernetes deployment, for example:

   Copy

   1
   2
   3
   4
   5
   6
   7
   8
   9
   10
   11
   12
   13
   14
   15
   collector:
     kubernetes:
       all:
         incluster: false
         kubeconfigpath: "/opt/SolarWinds/Snap/etc/.kube/config"
         interval: "60s"
         events: |
           # Embedded YAML (as a multiline string literal)
           filters:
           - namespace: default
             type: warning
             count: 2
           - namespace: kube-system
             type: warning
           file: /var/log/SolarWinds/Snap/events.log

   • incluster has to be set to false unless when running as a pod or daemonset.

   • kubeconfigpath a valid path to Kubernetes config files (e.g. ~/.kube/config).

   • interval sets time interval between subsequent metrics submissions (optional, defaults to 60s).

   • events enables Kubernetes Cluster Events collection (together with filters subfield). It’s an embedded YAML dictionary as string literal. It consists of:

     • filters list of dictionaries that allows for events filtering based on equality check on following fields:

       • action
       • count
       • host
       • kind
       • namespace
       • reason
       • reportingController
       • reportingInstance
       • type

     • file specifies filepath where the events will be written to, defaults to /var/log/SolarWinds/Snap/events.log.

3. Restart the agent:

   Copy

   $ sudo service swisnapd restart

4. Enable the Kubernetes plugin in the AppOptics UI

   On the Integrations Page you will see the Kubernetes available if the previous steps were successful. If you do not see the plugin, see Troubleshooting Linux.

   Select the Kubernetes plugin to open the configuration menu in the UI, and enable the plugin.

   You should soon see the kubernetes metrics reported to your dashboard.

Metrics and Tags

All the metrics are fetched via the Kubernetes API. The tables below outline the default set of metrics collected by the kubernetes plugin along with the optional metrics available.

Pod Metrics

Pod Metrics Tags

Container Metrics

Container Metric Tags

Node Metrics

Node Metric Tags

Deployment Metrics

Deployment Metric Tags

Events Metrics

The scripts are not supported under any SolarWinds support program or service. The scripts are provided AS IS without warranty of any kind. SolarWinds further disclaims all warranties including, without limitation, any implied warranties of merchantability or of fitness for a particular purpose. The risk arising out of the use or performance of the scripts and documentation stays with you. In no event shall SolarWinds or anyone else involved in the creation, production, or delivery of the scripts be liable for any damages whatsoever (including, without limitation, damages for loss of business profits, business interruption, loss of business information, or other pecuniary loss) arising out of the use of or inability to use the scripts or documentation.