Monitoring Kafka Bridges

There are a number of Solace Event Broker CLI show commands that you can use to validate and monitor the Kafka bridge configuration and connections on Solace event brokers.

Any Kafka bridging configuration made in BETA versions (earlier than 10.6.1) used in standalone deployments will be discarded upon upgrade to version 10.6.1 and later. In addition, you must remove any BETA Kafka bridging configuration used in a redundant (HA) deployment before attempting to upgrade to 10.6.1 or later.

Displaying System Level Kafka Bridging Information

To monitor the system level status for your Kafka bridging deployment, enter the following command:

solace> show kafka
Number of Kafka Broker Connections : 100 (of max 300)
Number of Configured Kafka Bridges : 6 (of max 10)
 
Kafka Receivers
  Configured     : 4
  Operational    : 4
 
Kafka Senders
  Configured     : 2
  Operational    : 1

Displaying Message VPN Level Kafka Bridging Information

To monitor the Message VPN level status for your Kafka bridging deployment, enter the following command:

solace> show message-vpn <vpn-name> kafka
Message VPN : blue
 
Number of Kafka Broker Connections : 34 (of max 123)
 
Kafka Receivers
  Configured     : 2
  Operational    : 2
 
Kafka Senders
  Configured     : 1
  Operational    : 0

Displaying Kafka Receiver Information

To monitor Kafka receiver configuration and status, enter the following User EXEC command:

show message-vpn <vpn-name> kafka kafka-receiver <receiver-name> [detail | stats | client-certificate | keytab | remote-broker <broker-name> | topic-binding <kafka-topic-name> [detail]]

Where:

<vpn-name> is the name of the Message VPN where the Kafka receiver is configured.

<receiver-name> is the name of the Kafka receiver you want to display information for.

stats displays statistics information, including the total number of requests and messages passed through the Kafka receiver.

client-certificate displays client certificate information for the specified Kafka receiver.

keytab displays keytab information for the specified Kafka receiver.

remote-broker <broker-name> displays information about the specified remote Kafka broker connected to the specified Kafka receiver.

topic-binding <kafka-topic-name> displays information about the specified topic binding associated with the Kafka receiver.

For example:

To display summary information for all Kafka receivers, enter the following command:

solace> show message-vpn kafka-bridging-vpn kafka kafka-receiver *

To display statistics for a Kafka receiver, enter the following command:

solace> show message-vpn kafka-bridging-vpn kafka kafka-receiver abc stats

To display information about topic bindings associated with a Kafka receiver, enter the following command:

solace> show message-vpn kafka-bridging-vpn kafka kafka-receiver abc topic-binding *

Displaying Kafka Sender Information

To monitor Kafka sender configuration and status, enter the following User EXEC command:

show message-vpn <vpn-name> kafka kafka-sender <sender-name> [detail | stats | client-certificate | keytab | remote-broker <broker-name> | queue-binding <queue-name> [detail]]

Where:

<vpn-name> is the name of the Message VPN where the Kafka sender is configured.

<sender-name> is the name of the Kafka sender you want to display information for.

stats displays statistics information, including the total number of requests and messages passed through the Kafka sender.

client-certificate displays client certificate information for the specified Kafka sender.

keytab displays keytab information for the specified Kafka sender.

remote-broker <broker-name> displays information about the specified remote Kafka broker connected to the specified Kafka sender.

queue-binding <queue-name> displays information about the specified queue binding associated with the Kafka sender.

For example:

To display detailed information for a Kafka sender, enter the following command:

solace> show message-vpn kafka-bridging-vpn kafka kafka-sender abc detail

To display information about the remote Kafka brokers a Kafka sender is connected to, enter the following command:

solace> show message-vpn kafka-bridging-vpn kafka kafka-sender abc remote-broker *

To display detailed information about a specific queue binding associated with a Kafka sender, enter the following command:

solace> show message-vpn kafka-bridging-vpn kafka kafka-sender abc queue-binding q1 detail

Clearing Kafka Bridging Statistics

To clear the statistics for Kafka receivers and senders, enter the following command:

solace# clear message-vpn <vpn-name> {kafka {kafka-receiver <receiver-name> | kafka-sender <sender-name>} stats}

Where:

<vpn-name> is the name of the Message VPN where the Kafka sender or receiver is configured.

<sender-name> is the name of the Kafka sender you want to clear statistics for.

<receiver-name> is the name of the Kafka receiver you want to clear statistics for.