Topic Retention Plugin

The topic-retention plugin filters out records that fall outside the target topic’s retention period.

When a topic’s restore task starts, the plugin reads the retention.ms property of the target topic and computes a cutoff timestamp as now - retention.ms. Any record with a timestamp before that cutoff is rejected and will not be restored. This is useful when you want to avoid restoring messages that Kafka would immediately discard upon ingestion.

Note

This plugin is automatically configured when using the ApplyTargetTopicRetention retention policy on a Restore. You only need to configure it manually if you require finer control, such as restricting it to specific topics via topicSelectors.

Note

If the target topic has retention.ms=-1 (infinite retention), the plugin accepts all records.

Synopsys

apiVersion: kannika.io/v1alpha
kind: Restore
metadata:
  name: restore-with-topic-retention
spec:
  source: "source"
  sink: "sink"
  config:
    plugins:
      - name: topic-retention
    topics:
      - target: target-topic
        source: source-topic

The plugin takes no configuration options.