Skip to main content
Version: Preview

Redpanda

Experimental
Creates:
Assets

Configure in the UI

This plugin can be configured directly in the Marmot UI with a step-by-step wizard.

View Guide

The Redpanda plugin discovers topics from Redpanda clusters. It uses the same discovery engine as the Kafka plugin since Redpanda is Kafka API-compatible.

Because it is the same engine, topics are catalogued under the Kafka provider and addressed as mrn://topic/kafka/<topic>, not under a Redpanda provider. Running Kafka, Redpanda and Confluent Cloud against clusters that share a topic name will therefore land them on one asset.

Connection

Redpanda Cloud

bootstrap_servers: "seed-xxxxx.cloud.redpanda.com:9092"
client_id: "marmot-discovery"
authentication:
type: "sasl_ssl"
username: "your-username"
password: "your-password"
mechanism: "SCRAM-SHA-256"
tls:
enabled: true

Self-Hosted Redpanda

bootstrap_servers: "redpanda-0.example.com:9092,redpanda-1.example.com:9092"
client_id: "marmot-discovery"

Example Configuration


bootstrap_servers: "kafka-1.prod.com:9092,kafka-2.prod.com:9092"
client_id: "marmot-discovery"
authentication:
type: "sasl_ssl"
username: "your-api-key"
password: "your-api-secret"
mechanism: "PLAIN"
tls:
enabled: true
tags:
- "kafka"
- "streaming"

Configuration

The following configuration options are available:

PropertyTypeRequiredDescription
authenticationAuthConfigfalseAuthentication configuration
bootstrap_serversstringfalseComma-separated list of bootstrap servers
client_idstringfalseClient ID for the consumer
client_timeout_secondsintfalseRequest timeout in seconds
consumer_configmap[string]stringfalseAdditional consumer configuration
external_links[]ExternalLinkfalseExternal links to show on all assets
filterFilterfalseFilter discovered assets by name (regex)
include_partition_infoboolfalseWhether to include partition information in metadata
include_topic_configboolfalseWhether to include topic configuration in metadata
schema_registrySchemaRegistryConfigfalseSchema Registry configuration
tagsTagsConfigfalseTags to apply to discovered assets
tlsTLSConfigfalseTLS configuration

Available Metadata

The following metadata fields are available:

FieldTypeDescription
cleanup_policystringTopic cleanup policy
delete_retention_msstringTime to retain deleted segments in milliseconds
key_schemastringKey schema definition
key_schema_idintID of the key schema in Schema Registry
key_schema_typestringType of the key schema (AVRO, JSON, etc.)
key_schema_versionintVersion of the key schema
max_message_bytesstringMaximum message size in bytes
min_insync_replicasstringMinimum number of in-sync replicas
partition_countint32Number of partitions
replication_factorint16Replication factor
retention_bytesstringMaximum size of the topic in bytes
retention_msstringMessage retention period in milliseconds
segment_bytesstringSegment file size in bytes
segment_msstringSegment file roll time in milliseconds
topic_namestringName of the Kafka topic
value_schemastringValue schema definition
value_schema_idintID of the value schema in Schema Registry
value_schema_typestringType of the value schema (AVRO, JSON, etc.)
value_schema_versionintVersion of the value schema