API Server Etcd Status Test

The Kubernetes API Server interacts with etcd, a key-value store, to manage cluster data and maintain the desired state of the system. When a request is made to the API Server (e.g., to create, update, or delete a resource), the server performs a series of operations on etcd to store or retrieve the current state of the requested resource (e.g., Pods, Services, ConfigMaps). The status of the communication between API Server and Etcd is key to the performance of the system.

Monitoring API Server etcd status is crucial for ensuring the health and performance of a Kubernetes cluster. It helps detect issues like slow response times, bottlenecks, or data inconsistencies. Timely detection of failures or misconfiguration in etcd ensures high availability, reliability, and proper functioning of the entire cluster.

This test monitors the Etcd status and reveals key metrics related toEtcd status which are crucial to ensuring uninterrupted connectivity to the server. By analyzing the metrics the administrators can ensure that API Server is able to connect to Etcd and any performance issues are handled within appropriate time..

Target of the test : A Kubernetes Master Node

Agent deploying the test : A remote agent

Outputs of the test : One set of results for target Kubernetes Master node being monitored.

Configurable parameters for the test

Parameter	Description
Test Period	How often should the test be executed.
Host	The IP address of the host for which this test is to be configured.
Port	Specify the port at which the specified Host listens. By default, this is 6443.
Timeout	Specify the duration (in seconds) beyond which the test will timeout in the Timeout text box. The default value is 10 seconds.
Metric URL	Each of the Kubernetes system components expose monitoring metrics through /metrics endpoint of the HTTP server. For components that don't expose endpoint by default, refer official Kubernetes distribution documentation site. Specify the metric URL textbox.

Measurements made by the test

Measurement	Description	Measurement Unit	Interpretation
Number of stored lease objects	Indicates how many lease objects are stored in your Kubernetes cluster's etcd database	Number	Lease object is a resource in etcd that is primarily used to coordinate leader election or to track the lifetime of specific resources (e.g., to determine if a resource is still "alive"). These lease objects are part of the coordination between API Server and Etcd.
Size of the etcd database file physically allocated	Indicates the actual disk space used by the files where etcd stores its data.	MB	Monitoring the file size ensures that administrators are aware of running out of space much before disk is full.