Using the environment checker utility

The environment checker utility is a tool that helps you identify the connectivity issues between the PATROL Agent, the communication channel, and the JAVA process. This utility communicates with the JAVA process without the need to connect to a PATROL Agent.

When you face issues while connecting to the Apache Kafka environment, it is difficult to identify the exact problem. It takes some time to understand if the issue is related to the PATROL Agent and the channel between the PATROL Agent and the JAVA process, or the issue is related to the JAVA process and the connection between the monitoring environment.

The environment checker tool acts like a JAVA client and connects directly to the Apache Kafka environment. When you provide the connection details to this utility, it tries to connect and discover the Apache Kafka system. Based on the result you can know if the issue was related to the environment configuration or the PATROL Agent.

The environment checker utility is located at:

• <<Patrol home>>/Patrol3/kfk/envChecker.sh (UNIX)

• <<Patrol home>>\Patrol3\kfk\envChecker.bat (Windows)

Using the environment checker utility

• Before you begin
• Apache Kafka remote UNIX monitoring
• Apache Kafka remote Windows monitoring

Before you begin

• Ensure that the PATROL_HOME environment variable is defined
• Ensure that the JAVA_HOME environment variable is defined and set to JRE 1.8 and later versions

1. Open command prompt or shell
2. Run the script <<Patrol home>>\Patrol3\kfk\envChecker.bat (Use .sh script file for UNIX)
3. Provide the inputs to connect to the Apache Kafka system

Apache Kafka remote UNIX monitoring

1. ZooKeeper Host/IP: Enter the host name or an IP address of the ZooKeeper.
2. ZooKeeper Port: Enter the port number. The default port number is 2181.
3. Topic: Enter the Kafka topic details. This topic is used for monitoring. You can enter an existing topic name. If the topic does not exist, a new topic is created with the given name.
4. Security Protocol: Enter the protocol name that will be used to communicate with the brokers.
   • Valid values:
     1. PLAINTEXT
     2. SASL_PLAINTEXT
        
5. SASL Kerberos service name: Enter the Kerberos principal name. This value can be defined either in the Kafka JAAS config or in Kafka config. For information about how to configure the KM with Kerberos Kafka environment, see  Configuring the KM to work with Kerberos Kafka server environment.
6. Kerberos krb5 configuration file path (this will show up if the security protocol is SASL_PLAINTEXT): Enter the path to the folder where the krb5 files reside. For information about how to configure the KM with Kerberos Kafka environment, see  Configuring the KM to work with Kerberos Kafka server environment.

7. Kerberos JAAS configuration file path (this will show up if the security protocol is SASL_PLAINTEXT): Enter the path to the folder where the JAAS config files reside. For information about how to configure the KM with Kerberos Kafka environment, see  Configuring the KM to work with Kerberos Kafka server environment.

    

   

Apache Kafka remote Windows monitoring

1. ZooKeeper Host/IP: Enter the host name or an IP address of the ZooKeeper.
2. ZooKeeper Port: Enter the port number. The default port number is 2181.
3. Topic: Enter the Kafka topic details. This topic is used for monitoring. You can enter an existing topic name. If the topic does not exist, a new topic is created with the given name.
4. Security Protocol: Enter the protocol name that will be used to communicate with the brokers.
   Valid values:
   • PLAINTEXT
   • SASL_PLAINTEXT
5. SASL Kerberos service name: Enter the Kerberos principal name. This value can be defined either in the Kafka JAAS config or in Kafka config. For information about how to configure the KM with Kerberos Kafka environment, see  Configuring the KM to work with Kerberos Kafka server environment.
6. Kerberos krb5 configuration file path (this will show up if the security protocol is SASL_PLAINTEXT): Enter the path to the folder where the krb5 files reside. For information about how to configure the KM with Kerberos Kafka environment, see  Configuring the KM to work with Kerberos Kafka server environment.

7. Kerberos JAAS configuration file path (this will show up if the security protocol is SASL_PLAINTEXT): Enter the path to the folder where the JAAS config files reside. For information about how to configure the KM with Kerberos Kafka environment, see  Configuring the KM to work with Kerberos Kafka server environment.