If you are currently using version 5.x.x, we advise you to upgrade to the latest version before the EOL date. You can find the latest documentation here.
The end of life (EOL) date for this integration is 30 September 2020. This documentation is now archived and is no longer updated. The Collection Agent plugin for Kubernetes now replaces this integration, see Installation in a Kubernetes or OpenShift environment.
Kubernetes Monitoring User Guide
General information
Overview
Kubernetes monitoring is a Gateway configuration file that enables monitoring of the Kubernetes platform through a set of samplers with customised Toolkit plug-in settings.
Kubernetes is a container that consists of an entire environment to automate deployment of applications. These include the libraries, binaries, and configuration files that you can bundle into one package.
Track the following key areas when using Kubernetes monitoring:
| Key Area | Description |
|---|---|
| Cluster | A set of physical or virtual machines, and other infrastructure resources that runs your applications. |
| Node | A physical or virtual machine that runs Kubernetes where it can schedule pods. |
| Pod | A group of containers and volumes. |
This guide discusses the steps to set up the Kubernetes integration on a Gateway. Once the integration is set up, the samplers providing the dataviews become available to that Gateway.
To view the sample metrics and dataviews, see Kubernetes Monitoring Technical Reference.
User requirements
This monitoring template is a Gateway configuration setup that can be included in the Gateway Setup Editor.
To use this template, your configuration must meet the following requirements:
- An Active Console 2 that is connected to the Gateway.
- Kubernetes configuration files extracted to their Gateway set-up.
System requirements
The following requirements must be met prior to the installation and setup of the template:
- Template package: geneos-integration-kubernetes-<version>.zip.
- A Kubernetes client (kubectl) that is connected to the cluster and included in the path.
- Netprobe version 4.5 or higher.
- Python version 2.6 or higher.
Note: This template is verified to be working with Python version 2.7/3.6, and Kubernetes (client and server) version 1.9.3.
Audience
This document is a reference guide to introduce templates and scripts built using the Geneos development toolkit plug-ins.
The template allows you to integrate specific applications and services to collect metrics without having to create a new plug-in.
Install and set up
Ensure that you have read and can follow the system requirements prior to installation and setup of this integration template.
- Download the config file (geneos-integration-Kubernetes-<version>.zip) from the ITRS Downloads site.
- Open Active Console 2.
- Extract the Kubernetes monitoring configuration file into the Gateway Setup directory.
- Click Includes to create a new file in the Navigation panel.
- Enter the location of the file to include in the Location field. In this example, use the include/KubernetesMonitoring.xml.
- Expand the file location in the Includes section.
- Select Click to load...
- Click Yes to load the new Kubernetes include file.
- Click Managed entities in the Navigation panel.
- Add the Kubernetes type to the Managed Entity section that you will use to monitor Kubernetes.
Note: The priority controls the importance of a file when merging. Sections in a higher priority file will take precedence over sections in a lower priority file. This priority setting affects the priority of configuration in the main setup file.
The Validate button allows you to check if there are any errors or warnings in your configuration set-up.
Once the Gateway configuration appears in the Includes section, you can add the samplers and other variables.
Set up the samplers
These are the pre-configured samplers available to use in KubernetesMonitoring.xml.
Configure the required fields by referring to the table below:
| Samplers |
|---|
| Kubernetes-ClusterInfo |
| Kubernetes-Nodes |
| Kubernetes-Pods |
Set up the variables
The KubernetesMonitoring.xml template provides the following variables that are set in the Environments section:
| Variable | Description |
|---|---|
| KUBE_PY_EXE | Full path for python executable file. Default: /usr/bin/python Mandatory: Yes |
| KUBE_CONFIG |
Config file of the cluster to monitor.
Default: ~/.kube/config
Mandatory: Yes
|
| KUBE_SAMPLER_GROUP | Sampler group name. Mandatory: Yes |
After checking and saving the changes, the samplers you have set in the Gateway configuration display in Active Console 2.
Set up the rules
The Kubernetes-SampleRules.xml template also provides a separate sample rules that you can use to configure the Gateway Setup Editor.
Your configuration rules must be in the Includes section.
- Enter the location of the file to include in the Location field. In this example, use the include/Kubernetes-SampleRules.xml.
- Expand the file location in the Includes section.
- Select Click to load...
- Click Yes to load the new Kubernetes include rules file.
- Click Rules in the Navigation panel to create new rules.
Note: The priority controls the importance of a file when merging. Sections in a higher priority file will take precedence over sections in a lower priority file. This priority setting affects the priority of configuration in the main setup file.
The table below shows the sample rules set-up in the configuration file:
| Rules | Description |
|---|---|
| Kubernetes-NodeStatus | Monitors the node status. |
| Kubernetes-PodStatus | Monitors the pod status. |