Skip to main content

What does Atlan crawl from Apache Kafka?

Atlan crawls and maps the following assets and properties from Apache Kafka. Once you've crawled Apache Kafka, you can use connector-specific filters for quick asset discovery.

Cluster

Atlan maps the Kafka cluster to its KafkaCluster asset type. One cluster asset is created per connection. You can filter clusters by bootstrap servers, cluster type, and authentication type.

Source propertyAtlan property
Cluster namename
Bootstrap server addressesbootstrapServers
Total topic counttopicCount
Total partition countpartitionCount
Total broker countbrokerCount
Distribution typeclusterType
Authentication mechanismauthenticationType
Schema Registry URL (if configured)schemaRegistryUrl

Topics

Atlan maps topics from Apache Kafka to its KafkaTopic asset type. You can filter topics by message count, size (MB), partition count, and cleanup policy.

Source propertyAtlan property
Topicname
PartitionCountkafkaTopicPartitionsCount
ReplicationFactorkafkaTopicReplicationFactor
segment.byteskafkaTopicSegmentBytes
compression.typekafkaTopicCompressionType
cleanup.policykafkaTopicLogCleanupPolicy
isInternalkafkaTopicIsInternal
sizeInByteskafkaTopicSizeInBytes
recordCountkafkaTopicRecordCount
retention.mskafkaTopicRetentionTimeInMs
retention.byteskafkaTopicRetentionBytes
Schema Registry subject name (if Schema Registry configured)topicSchemaRegistrySubjectName
Whether topic is governed by a schema registrytopicIsSchemaManaged
Number of active consumer groupstopicConsumerCount
Parent cluster qualified nametopicClusterQualifiedName

Consumer groups

Atlan maps consumer groups from Apache Kafka to its KafkaConsumerGroup asset type. You can filter consumer groups by member count and topic name. Consumer groups appear only when they're active at the time of crawling. If a topic isn't being consumed actively, Apache Kafka purges the consumer group and it won't be cataloged as an asset.

Source propertyAtlan property
GROUPname
memberCountkafkaConsumerGroupMemberCount
topic_nameskafkaTopicNames
TOPICkafkaConsumerGroupTopicConsumptionProperties.topicName
PARTITIONkafkaConsumerGroupTopicConsumptionProperties.topicPartition
LAGkafkaConsumerGroupTopicConsumptionProperties.topicLag
CURRENT-OFFSETkafkaConsumerGroupTopicConsumptionProperties.topicCurrentOffset
Consumer group stateconsumerGroupState
Assigned topic-partition pairsconsumerGroupAssignedPartitions

The consumerGroupState property reflects the current state of the consumer group at the time of crawling. Possible values are:

ValueDescription
StableThe group has active members with all partitions assigned.
EmptyThe group exists but has no active members.
PreparingRebalanceThe group is collecting member join requests ahead of a rebalance.
CompletingRebalanceThe group is waiting for members to receive their partition assignments.
DeadThe group has no members and its metadata has been removed.

Schema subjects

Atlan maps subjects from a connected Schema Registry to its SchemaRegistrySubject asset type. Schema subjects are crawled only when Schema Registry credentials are provided. You can filter schema subjects by schema type and compatibility.

Source propertyAtlan property
subjectname
schemaTypeschemaRegistrySchemaType
idschemaRegistrySchemaId
subject (base name without -key/-value suffix)schemaRegistrySubjectBaseName
subject ends with -keyschemaRegistrySubjectIsKeySchema
compatibilityLevelschemaRegistrySubjectSchemaCompatibility
version (latest)schemaRegistrySubjectLatestSchemaVersion
schema (latest definition)schemaRegistrySubjectLatestSchemaDefinition

Schema versions

Atlan maps each schema version to its SchemaRegistryVersion asset type, allowing you to track the full version history of a subject. Schema versions are crawled only when Schema Registry credentials are provided. You can filter schema versions by version number and schema type.

Source propertyAtlan property
version numberversionNumber
schema definitionversionSchemaDefinition
schema type (AVRO, JSON, PROTOBUF)versionSchemaType
parent subject qualified namesubjectQualifiedName

Schema fields

Atlan maps fields from schema definitions to its KafkaField asset type, enabling field-level lineage between Kafka topics and downstream assets. Schema fields are crawled only when Schema Registry credentials are provided. You can filter schema fields by data type and whether they're optional or required.

Source propertyAtlan property
field namename
field data typefieldDataType
field is optionalfieldIsOptional
default valuefieldDefaultValue
schema version where field was introducedfieldVersionIntroduced
field position in schema (0-based)fieldOrder
parent topic qualified nametopicQualifiedName
schema type (key or value schema)fieldSchemaType