Apache Kafka Service Availability Test

How often should the test be executed.

The IP address of the target server that is being monitored.

The port number through which the Apache Kafka Message System communicates. The default port is 9092.

Bootstrap Servers is a comma-separated list of host and port pairs that are the addresses of the Kafka brokers in a "bootstrap" Kafka cluster that a Kafka client connects to initially to bootstrap itself. By default, the BOOTSTRAP SERVERS text box will display the value as Host:Port. If a single Kafka Broker is associated with multiple Bootstraps in a Kafka cluster, then specify a comma-separated list of values as Host1:Port1, Host2:Port2,.... in this text box. If Kafka Message system is installed in a container, then the value will be displayed as Container ID:Port in this text box.

In Apache Kafka, a topic is a labeled channel that lets agents (producers and consumers) send and receive messages through the broker. Specify such Topic name in Topic Name text box. A topic is identified by a string name as the examples are eGtopicname1,eGtopicname2.

Specify the name of the listener service associated with the managed Apache Kafka Message System. By default, this parameter is set to PLAINTEXT. This means that by default the test will attempt to connect to and check the status of the 'default listener'. However, if the Apache Kafka Message System has been configured using a 'different listener', then you should select the value of the LISTENER NAME parameter.

This parameter is applicable only if the target Apache Kafka Message System is SSL-enabled, if not, set this parameter to none. TrustStore is used to store certificates from Certified Authorities (CA) that verify and authenticate the certificate presented by the server in an SSL connection. Therefore, the eG agent should have access to the truststore where the certificates are stored to authenticate and connect with the target database and collect metrics. For this, first import the certificates into the following default location <eG_INSTALL_DIR>/lib/security/mytruststore.jks. As an example, to know how to import the certificate into the truststore, refer toPre-requisites for monitoring Oracle Cluster. Then, provide the truststore file name in this text box. For example: mytruststore.jks. By default, none is specified against this text box.

This parameter is applicable only if the target Apache Kafka Message System is SSL-enabled, if not, set this parameter to none. If a Truststore File name is provided, then, in this text box, provide the password that is used to obtain the associated certificate details from the Truststore File. By default, this parameter is set to none. Confirm the password by retyping the password in the Confirm Password text box.

This parameter is applicable only if the target Apache Kafka Message System is SSL-enabled, if not, set this parameter to none.

Keystore contains the private keys for the certificates that the client can provide to the server upon request. eG agent requires access to the keystore where client certificate is stored to send that to the server so that the server validates the certificate against the one contained in its trustore. For this purpose, first create the client certificate in the following default location /opt/egurkha/jre/lib/security/egmqsslstore.jks.

This parameter is applicable only if the target Apache Kafka Message System is SSL-enabled, if not, set this parameter to none.

If a Keystore File name or file path is provided, then, in this text box, provide the password that is used to obtain the associated certificate details from the Keystore File.

Confirm the Password for Keystore by retyping it here.

This parameter is applicable only if the target Apache Kafka Message System is SSL-enabled, if not, set this parameter to none.

SASL SSL Username parameter generally refers to the configuration of authentication and encryption protocols in Apache Kafka Message System, where SASL (Simple Authentication and Security Layer) is layered over SSL to provide secure, authenticated connections.

Specify the password in the SASL SSL Password text box for authenticated connection and confirm the password by retyping the password in the Confirm Password text box.

SASL SSL Mechanism in Apache Kafka Message System refers to the username and credential authentication methods supported through the SASL (Simple Authentication and Security Layer) framework, with communication secured via SSL/TLS encryption The two different types of authentication methods are SCRAM-SHA-256 and SCRAM-SHA-512. Select the required authentication method from the SASL SSL Mechanism list.

Refers to the frequency with which detailed diagnosis measures are to be generated for this test. The default is 1:1. This indicates that, by default, detailed measures will be generated every 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.