LogoLogo
WarpStream.comSlackDiscordContact UsCreate Account
  • Overview
    • Introduction
    • Architecture
      • Service Discovery
      • Write Path
      • Read Path
      • Life of a Request (Simplified)
    • Change Log
  • Getting Started
    • Install the WarpStream Agent / CLI
    • Run the Demo
    • "Hello World" for Apache Kafka
  • BYOC
    • Run the Agents Locally
    • Deploy the Agents
      • Object Storage Configuration
      • Kubernetes Known Issues
      • Rolling Restarts and Upgrades
    • Client Configuration
      • Tuning for Performance
      • Configure Clients to Eliminate AZ Networking Costs
        • Force Interzone Load Balancing
      • Configuring Kafka Client ID Features
      • Known Issues
    • Infrastructure as Code
      • Terraform Provider
      • Helm charts
      • Terraform Modules
    • Monitoring
      • Pre-made Datadog Dashboard
      • Pre-made Grafana Dashboard
      • Important Metrics and Logs
      • Recommended List of Alerts
      • Monitoring Consumer Groups
      • Hosted Prometheus Endpoint
    • Authentication
      • SASL Authentication
      • Mutual TLS (mTLS)
      • Basic Authentication
    • Advanced Agent Deployment Options
      • Agent Roles
      • Agent Groups
      • Protect Data in Motion with TLS Encryption
      • Low Latency Clusters
      • Network Architecture Considerations
      • Agent Configuration Reference
      • Reducing Infrastructure Costs
      • Client Configuration Auto-tuning
    • Hosted Metadata Endpoint
    • Managed Data Pipelines
      • Cookbooks
    • Schema Registry
      • WarpStream BYOC Schema Registry
      • Schema Validation
      • WarpStream Schema Linking
    • Orbit
    • Port Forwarding (K8s)
  • Reference
    • ACLs
    • Billing
      • Direct billing
      • AWS Marketplace
    • Benchmarking
    • Compression
    • Protocol and Feature Support
      • Kafka vs WarpStream Configuration Reference
      • Compacted topics
      • Topic Configuration Reference
    • Secrets Overview
    • Security and Privacy Considerations
    • API Reference
      • API Keys
        • Create
        • Delete
        • List
      • Virtual Clusters
        • Create
        • Delete
        • Describe
        • List
        • DescribeConfiguration
        • UpdateConfiguration
      • Virtual Clusters Credentials
        • Create
        • Delete
        • List
      • Monitoring
        • Describe All Consumer Groups
      • Pipelines
        • List Pipelines
        • Create Pipeline
        • Delete Pipeline
        • Describe Pipeline
        • Create Pipeline Configuration
        • Change Pipeline State
      • Invoices
        • Get Pending Invoice
        • Get Past Invoice
    • CLI Reference
      • warpstream agent
      • warpstream demo
      • warpstream cli
      • warpstream cli-beta
        • benchmark-consumer
        • benchmark-producer
        • console-consumer
        • console-producer
        • consumer-group-lag
        • diagnose-record
        • file-reader
        • file-scrubber
      • warpstream playground
    • Integrations
      • Arroyo
      • AWS Lambda Triggers
      • ClickHouse
      • Debezium
      • Decodable
      • DeltaStream
      • docker-compose
      • DuckDB
      • ElastiFlow
      • Estuary
      • Fly.io
      • Imply
      • InfluxDB
      • Kestra
      • Materialize
      • MinIO
      • MirrorMaker
      • MotherDuck
      • Ockam
      • OpenTelemetry Collector
      • ParadeDB
      • Parquet
      • Quix Streams
      • Railway
      • Redpanda Console
      • RisingWave
      • Rockset
      • ShadowTraffic
      • SQLite
      • Streambased
      • Streamlit
      • Timeplus
      • Tinybird
      • Upsolver
    • Partitions Auto-Scaler (beta)
    • Serverless Clusters
    • Enable SAML Single Sign-on (SSO)
    • Trusted Domains
    • Diagnostics
      • GoMaxProcs
      • Small Files
Powered by GitBook
On this page
  • message.timestamp.type
  • cleanup.policy
  • retention.ms
  • min.compaction.lag.ms
  • delete.retention.ms
  • warpstream.compression.type.fetch
  • warpstream.schema.registry.type
  • warpstream.schema.validation.warning.only
  • warpstream.key.schema.validation
  • warpstream.key.subject.name.strategy
  • warpstream.value.schema.validation
  • warpstream.value.subject.name.strategy
  • warpstream.partitions_auto_scaler.enabled
  • warpstream.partitions_auto_scaler.per_partition_throughput_uncompressed_bytes_per_second
  • warpstream.partitions_auto_scaler.max_partition_count
  • warpstream.deletion.protection.enabled

Was this helpful?

  1. Reference
  2. Protocol and Feature Support

Topic Configuration Reference

This page lists the supported configuration for WarpStream topics. Configuration not listed here will be silently ignored by the WarpStream Kafka API.

Configuration items that start with warpstream. are WarpStream specific configurations, native Kafka tooling like the kafka-configs CLI may not be able to set these configurations. It is recommended to set these configurations using our REST API for topics, WarpStream terraform provider, or a non-Java library like franz-go to manage these configurations.

message.timestamp.type

Define whether the timestamp in the message is message create time or log append time. The value should be either CreateTime or LogAppendTime

Type:
string

Default:

CreateTime

Valid Values:

[CreateTime, LogAppendTime]

cleanup.policy

This config designates the retention policy to use on topics. The “delete” policy (which is the default) will discard old message when their retention time or size limit has been reached. The “compact” policy will enable topic compaction, which retains the latest value for each key. It is also possible to specify both policies in a comma-separated list (e.g. “delete,compact”). In this case, old messages will be discarded per the retention time and size configuration, while retained messages will be compacted.

In WarpStream cleanup.policy cannot be changed after a topic is created.

Type:
list

Default:

delete

Valid Values:

[compact, delete]

retention.ms

This configuration controls the maximum time we will retain messages in a topic partition. This represents an SLA on how soon consumers must read their data. If set to -1, no time limit is applied.

Type:
long

Default:

86400000 (1 day)

Valid Values:

[-1,3600000…,3153600000000]

min.compaction.lag.ms

The minimum time a message will remain uncompacted in the topic partition. Only applicable for topics that are being compact.

Type:
long

Default:

0

Valid Values:

[0,…,3153600000000]

delete.retention.ms

The amount of time to retain delete tombstone markers for compacted topics. This setting also gives a bound on the time in which a consumer must complete a read if they begin from offset 0 to ensure that they get a valid snapshot of the final stage (otherwise delete tombstones may be collected before they complete their scan).

Type:
long

Default:

86400000 (1 day)

Valid Values:

[-1,3600000,…,3153600000000]

warpstream.compression.type.fetch

The compression algorithm that is used to return compressed batches to consumers for this topic.

Type:
string

Default:

agent (lz4)

Valid Values:

[agent, lz4, zstd]

warpstream.schema.registry.type

The schema registry type to use when schema validation is enabled.

Type:
string

Default:

STANDARD

Valid Values:

[STANDARD, AWS_GLUE]

warpstream.schema.validation.warning.only

Should schema validations only return warnings and not block producing of messages to the topic.

Type:
string

Default:

true

Valid Values:

[true, false]

warpstream.key.schema.validation

Should message key schemas be validated when messages are being produced to the topic.

Type:
string

Default:

false

Valid Values:

[true, false]

warpstream.key.subject.name.strategy

warpstream.value.schema.validation

Should message value schemas be validated when messages are being produced to the topic.

Type:
string

Default:

false

Valid Values:

[true, false]

warpstream.value.subject.name.strategy

warpstream.partitions_auto_scaler.enabled

Type:
string

Default:

false

Valid Values:

[true, false]

warpstream.partitions_auto_scaler.per_partition_throughput_uncompressed_bytes_per_second

The maximum thoughput per partition a topic should have before more partitions are added through autoscaling.

Type:
long

Default:

0

Valid Values:

[0,…]

warpstream.partitions_auto_scaler.max_partition_count

The maximum number of partitions that the topic can autoscale to.

Type:
long

Default:

0

Valid Values:

[0,…,3153600000000]

warpstream.deletion.protection.enabled

Should the topic have delete protection enabled. If enabled the topic cannot be deleted until disabled.

Type:
string

Default:

false

Valid Values:

[true, false]

PreviousCompacted topicsNextSecrets Overview

Last updated 2 days ago

Was this helpful?

Should the be enabled for the topic.

partition autoscaler