The kafkaCluster() GraphQL query will return information on a Kafka cluster.

For information on Kafka, see the Kafka Configuration documentation page. You may also want to look at the Kafka Configuration reference page. For information on clusters in general, see the Cluster Management documentation page. Also, look at the LogScale Logical Architecture page in the Training section.


Below is the syntax for the kafkaCluster() query field:

kafkaCluster: KafkaClusterDescription!

Given Datatypes

For the given datatype, KafkaClusterDescription, there are several parameters that may be given. Below is a list of them along with their datatypes and a description of each:

Table: KafkaClusterDescription

clusterIDstringyes The unique identifier of the cluster.
nodes[KafkaNode]yes The list of Kafka nodes in the cluster (see KafkaNode Table).
controllerKafkaNodeyes The Kafka node that is the controller of the cluster (see KafkaNode Table).
logDirDescriptions[KafkaLogDir]yes Descriptons of the Kafka log directories (see KafkaLogDir Table).
globalEventsTopicKafkaTopicDescriptionyes The global Kafka events topic (see KafkaTopicDescription Table).
ingestTopicKafkaTopicDescriptionyes A description of the Kafka ingest topic (see KafkaTopicDescription Table).
chatterTopicKafkaTopicDescriptionyes Any chatter topic associated with the Kafka cluster (see KafkaTopicDescription Table).

[a] Some arguments may be required, as indicated in this column. For some fields, this column indicates that a result will always be returned for it.