Configuring in the TrueSight or the Central Monitoring Administration console

Before you can begin using the Kafka KM, you must configure it. You can use the information in this topic if you are using TrueSight Infrastructure Management or the Central Monitoring Administration console. 

The following monitor types that are part of Apache Kafka are also loaded when you configure the KM.

  • Apache Kafka
  • Apache Kafka Environment
  • Apache Kafka System
  • Kafka Broker
  • Kafka Broker Producer Metrics
  • Kafka Consumer Metrics
  • Kafka Message
  • Kafka Producer Metrics
  • Kafka Zookeeper

A Monitor Profile is the name of the profile to which the monitor types that you want to enable are associated.

On the policy configuration of the Apache Kafka KM, click Add to configure a new environment for monitoring.

FieldDescription
Environment Configuration
Environment name

Enter a logical unique name for the environment. A container will be created with the environment name. BMC recommends to provide alphanumeric characters in environment name.

The following characters can be used in the environment name:

A-Z a-z 0-9 -_

Kafka home

Enter the path to the folder where the Kafka files reside.

For example:

Windows: C:\kafka_2.11-0.10.0.1

Unix\LINUX: /usr/kafka_2.11-0.10.0.1

Java Home Details
Java home

Specify the path to the JAVA home directory.

For example, if your JAVA executable exists in the /usr/java/jdk1.8.0_45/jre/bin/java path, specify /usr/java/jdk1.8.0_45/jre as the value in this field.

Local admin OS Credentials
User NameEnter the name of the local admin user with permission to run the JAVA process.
PasswordEnter a password for the local admin user.
Confirm PasswordRe-enter the password for confirmation.
ZooKeeper Connection Details
Host/IPEnter the host name or an IP address of the ZooKeeper.
PortEnter the port number. The default port number is 2181.
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.

Monitor Data
Collection level

Select the collection level for monitoring the instance.

  • Infrastructure Availability
  • Static topic monitoring
Kerberos Security Details
Security protocol

Enter the protocol name that will be used to communicate with the brokers.

Valid values:

  • PLAINTEXT
  • SASL_PLAINTEXT

Default:

  • PLAINTEXT
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.

Krb5 config path

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.

Jaas config path

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.

KM Administration
Optional KVM argsEnter JVM arguments for the JAVA collector.
LoggingSelect this checkbox to enable PSL and JAVA debug.
Availability collection time (min)Enter the availability collection time in minutes for the JAVA collector. Default value is 1 minute.
Data collection time (min)Enter the data collection time in minutes for the JAVA collector. Default value is 5 minutes.
Device mapping

Clear this checkbox to disable the device mapping on the TrueSight or the BPPM user console. By default, device mapping is enabled (check box selected).

 Enabling device mapping consolidates Elasticsearch monitoring at device level. 

OKClick to save and close the configuration window.
CancelClick this option to exit without saving any changes.
Was this page helpful? Yes No Submitting... Thank you

Comments