API Server Etcd Request 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 API Server sends these requests to etcd, which stores the data reliably. Etcd provides consistency, ensuring that cluster data is synchronized across all nodes, even in the event of failures, enabling high availability and fault tolerance.

Monitoring API Server etcd requests 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 requests and reveals key metrics related to API Server requests which are crucial to ensuring communication between API Server and Etcd. By analyzing the metrics the administrators can ensure that API Server are able to connect to Etcd and take preemptive actions if any there are any issues.

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.

DD Frequency

Refers to the frequency with which detailed diagnosis measures are to be generated for this test. The default is 3:1. This indicates that, by default, detailed measures will be generated every third time this test runs, and also every time the test detects a problem. You can modify this frequency, if you so desire. Also, if you intend to disable the detailed diagnosis capability for this test, you can do so by specifying none against DD frequency.

Detailed Diagnosis

To make diagnosis more efficient and accurate, the eG Enterprise embeds an optional detailed diagnostic capability. With this capability, the eG agents can be configured to run detailed, more elaborate tests as and when specific problems are detected. To enable the detailed diagnosis capability of this test for a particular server, choose the On option. To disable the capability, click on the Off option.

The option to selectively enable/disable the detailed diagnosis capability will be available only if the following conditions are fulfilled:

  • The eG manager license should allow the detailed diagnosis capability
  • Both the normal and abnormal frequencies configured for the detailed diagnosis measures should not be 0.
Measurements made by the test

Measurement

Description

Measurement Unit

Interpretation

Requests

Indicates the total number of etcd requests received by API Server.

Number

 

Total request duration

Indicates the total time taken by API server to respond to all the requests.

Days

The time from when a Etcd sends a requestuntil the API Server responds with the requested data or status.

Average request duration

Indicates the mean time taken for the API Server to process requests from Etcd.

Days

The average request duration is calculated by summing up the total time for all requests within a given time window and dividing by the number of requests during that period.