Skip to main content

Message retention and expiry

Pulsar brokers are responsible for handling messages that pass through Pulsar, including persistent storage of messages. By default, for each topic, brokers only retain messages that are in at least one backlog. A backlog is the set of unacknowledged messages for a particular subscription. As a topic can have multiple subscriptions, a topic can have multiple backlogs.

As a consequence, no messages are retained (by default) on a topic that has not had any subscriptions created for it.

(Note that messages that are no longer being stored are not necessarily immediately deleted, and may in fact still be accessible until the next ledger rollover. Because clients cannot predict when rollovers may happen, it is not wise to rely on a rollover not happening at an inconvenient point in time.)

In Pulsar, you can modify this behavior, with namespace granularity, in two ways:

  • You can persistently store messages that are not within a backlog (because they've been acknowledged by on every existing subscription, or because there are no subscriptions) by setting retention policies.
  • Messages that are not acknowledged within a specified timeframe can be automatically acknowledged, by specifying the time to live (TTL).

Pulsar's admin interface enables you to manage both retention policies and TTL with namespace granularity (and thus within a specific tenant and either on a specific cluster or in the global cluster).

Retention and TTL solve two different problemsโ€‹

  • Message retention: Keep the data for at least X hours (even if acknowledged)
  • Time-to-live: Discard data after some time (by automatically acknowledging)

Most applications will want to use at most one of these.

Retention policiesโ€‹

By default, when a Pulsar message arrives at a broker, the message is stored until it has been acknowledged on all subscriptions, at which point it is marked for deletion. You can override this behavior and retain messages that have already been acknowledged on all subscriptions by setting a retention policy for all topics in a given namespace. Retention is based on both a size limit and a time limit.

Retention policies are useful when you use the Reader interface. The Reader interface does not use acknowledgements, and messages do not exist within backlogs. It is required to configure retention for Reader-only use cases.

When you set a retention policy on topics in a namespace, you must set both a size limit and a time limit. You can refer to the following table to set retention policies in pulsar-admin and Java.

Time limitSize limitMessage retention
-1-1Infinite retention
-1>0Based on the size limit
>0-1Based on the time limit
00Disable message retention (by default)
0>0Invalid
>00Invalid
>0>0Acknowledged messages or messages with no active subscription will not be retained when either time or size reaches the limit.

The retention settings apply to all messages on topics that do not have any subscriptions, or to messages that have been acknowledged by all subscriptions. The retention policy settings do not affect unacknowledged messages on topics with subscriptions. The unacknowledged messages are controlled by the backlog quota.

When a retention limit on a topic is exceeded, the oldest message is marked for deletion until the set of retained messages falls within the specified limits again.

Defaultsโ€‹

You can set message retention at instance level with the following two parameters: defaultRetentionTimeInMinutes and defaultRetentionSizeInMB. Both parameters are set to 0 by default.

For more information of the two parameters, refer to the broker.conf configuration file.

Set retention policyโ€‹

You can set a retention policy for a namespace by specifying the namespace, a size limit and a time limit in pulsar-admin, REST API and Java.

You can use the set-retention subcommand and specify a namespace, a size limit using the -s/--size flag, and a time limit using the -t/--time flag.

In the following example, the size limit is set to 10 GB and the time limit is set to 3 hours for each topic within the my-tenant/my-ns namespace.

  • When the size of messages reaches 10 GB on a topic within 3 hours, the acknowledged messages will not be retained.
  • After 3 hours, even if the message size is less than 10 GB, the acknowledged messages will not be retained.

$ pulsar-admin namespaces set-retention my-tenant/my-ns \
--size 10G \
--time 3h

In the following example, the time is not limited and the size limit is set to 1 TB. The size limit determines the retention.


$ pulsar-admin namespaces set-retention my-tenant/my-ns \
--size 1T \
--time -1

In the following example, the size is not limited and the time limit is set to 3 hours. The time limit determines the retention.


$ pulsar-admin namespaces set-retention my-tenant/my-ns \
--size -1 \
--time 3h

To achieve infinite retention, set both values to -1.


$ pulsar-admin namespaces set-retention my-tenant/my-ns \
--size -1 \
--time -1

To disable the retention policy, set both values to 0.


$ pulsar-admin namespaces set-retention my-tenant/my-ns \
--size 0 \
--time 0

Get retention policyโ€‹

You can fetch the retention policy for a namespace by specifying the namespace. The output will be a JSON object with two keys: retentionTimeInMinutes and retentionSizeInMB.

pulsar-adminโ€‹

Use the get-retention subcommand and specify the namespace.

Exampleโ€‹

$ pulsar-admin namespaces get-retention my-tenant/my-ns
{
"retentionTimeInMinutes": 10,
"retentionSizeInMB": 500
}

REST APIโ€‹

GET /admin/v2/namespaces/:tenant/:namespace/retention

Javaโ€‹


admin.namespaces().getRetention(namespace);

Backlog quotasโ€‹

Backlogs are sets of unacknowledged messages for a topic that have been stored by bookies. Pulsar stores all unacknowledged messages in backlogs until they are processed and acknowledged.

You can control the allowable size of backlogs, at the namespace level, using backlog quotas. Setting a backlog quota involves setting:

TODO: Expand on is this per backlog or per topic?

  • an allowable size threshold for each topic in the namespace
  • a retention policy that determines which action the broker takes if the threshold is exceeded.

The following retention policies are available:

PolicyAction
producer_request_holdThe broker will hold and not persist produce request payload
producer_exceptionThe broker will disconnect from the client by throwing an exception
consumer_backlog_evictionThe broker will begin discarding backlog messages

Beware the distinction between retention policy typesโ€‹

As you may have noticed, there are two definitions of the term "retention policy" in Pulsar, one that applies to persistent storage of messages not in backlogs, and one that applies to messages within backlogs.

Backlog quotas are handled at the namespace level. They can be managed via:

Set size/time thresholds and backlog retention policiesโ€‹

You can set a size and/or time threshold and backlog retention policy for all of the topics in a namespace by specifying the namespace, a size limit and/or a time limit in second, and a policy by name.

pulsar-adminโ€‹

Use the set-backlog-quota subcommand and specify a namespace, a size limit using the -l/--limit flag, and a retention policy using the -p/--policy flag.

Exampleโ€‹

$ pulsar-admin namespaces set-backlog-quota my-tenant/my-ns \
--limit 2G \
--limitTime 36000 \
--policy producer_request_hold

REST APIโ€‹

POST /admin/v2/namespaces/:tenant/:namespace/backlogQuota

Javaโ€‹


long sizeLimit = 2147483648L;
BacklogQuota.RetentionPolicy policy = BacklogQuota.RetentionPolicy.producer_request_hold;
BacklogQuota quota = new BacklogQuota(sizeLimit, policy);
admin.namespaces().setBacklogQuota(namespace, quota);

Get backlog threshold and backlog retention policyโ€‹

You can see which size threshold and backlog retention policy has been applied to a namespace.

pulsar-adminโ€‹

Use the get-backlog-quotas subcommand and specify a namespace. Here's an example:


$ pulsar-admin namespaces get-backlog-quotas my-tenant/my-ns
{
"destination_storage": {
"limit" : 2147483648,
"policy" : "producer_request_hold"
}
}

REST APIโ€‹

GET /admin/v2/namespaces/:tenant/:namespace/backlogQuotaMap

Javaโ€‹


Map<BacklogQuota.BacklogQuotaType,BacklogQuota> quotas =
admin.namespaces().getBacklogQuotas(namespace);

Remove backlog quotasโ€‹

pulsar-adminโ€‹

Use the remove-backlog-quota subcommand and specify a namespace. Here's an example:


$ pulsar-admin namespaces remove-backlog-quota my-tenant/my-ns

REST APIโ€‹

DELETE /admin/v2/namespaces/:tenant/:namespace/backlogQuota

Javaโ€‹


admin.namespaces().removeBacklogQuota(namespace);

Clear backlogโ€‹

pulsar-adminโ€‹

Use the clear-backlog subcommand.

Exampleโ€‹

$ pulsar-admin namespaces clear-backlog my-tenant/my-ns

By default, you will be prompted to ensure that you really want to clear the backlog for the namespace. You can override the prompt using the -f/--force flag.

Time to live (TTL)โ€‹

By default, Pulsar stores all unacknowledged messages forever. This can lead to heavy disk space usage in cases where a lot of messages are going unacknowledged. If disk space is a concern, you can set a time to live (TTL) that determines how long unacknowledged messages will be retained.

Set the TTL for a namespaceโ€‹

pulsar-adminโ€‹

Use the set-message-ttl subcommand and specify a namespace and a TTL (in seconds) using the -ttl/--messageTTL flag.

Exampleโ€‹

$ pulsar-admin namespaces set-message-ttl my-tenant/my-ns \
--messageTTL 120 # TTL of 2 minutes

REST APIโ€‹

POST /admin/v2/namespaces/:tenant/:namespace/messageTTL

Javaโ€‹


admin.namespaces().setNamespaceMessageTTL(namespace, ttlInSeconds);

Get the TTL configuration for a namespaceโ€‹

pulsar-adminโ€‹

Use the get-message-ttl subcommand and specify a namespace.

Exampleโ€‹

$ pulsar-admin namespaces get-message-ttl my-tenant/my-ns
60

REST APIโ€‹

GET /admin/v2/namespaces/:tenant/:namespace/messageTTL

Javaโ€‹


admin.namespaces().getNamespaceMessageTTL(namespace)

Remove the TTL configuration for a namespaceโ€‹

pulsar-adminโ€‹

Use the remove-message-ttl subcommand and specify a namespace.

Exampleโ€‹

$ pulsar-admin namespaces remove-message-ttl my-tenant/my-ns

REST APIโ€‹

DELETE /admin/v2/namespaces/:tenant/:namespace/messageTTL

Javaโ€‹


admin.namespaces().removeNamespaceMessageTTL(namespace)

Delete messages from namespacesโ€‹

If you do not have any retention period and that you never have much of a backlog, the upper limit for retaining messages, which are acknowledged, equals to the Pulsar segment rollover period + entry log rollover period + (garbage collection interval * garbage collection ratios).

  • Segment rollover period: basically, the segment rollover period is how often a new segment is created. Once a new segment is created, the old segment will be deleted. By default, this happens either when you have written 50,000 entries (messages) or have waited 240 minutes. You can tune this in your broker.

  • Entry log rollover period: multiple ledgers in BookKeeper are interleaved into an entry log. In order for a ledger that has been deleted, the entry log must all be rolled over. The entry log rollover period is configurable, but is purely based on the entry log size. For details, see here. Once the entry log is rolled over, the entry log can be garbage collected.

  • Garbage collection interval: because entry logs have interleaved ledgers, to free up space, the entry logs need to be rewritten. The garbage collection interval is how often BookKeeper performs garbage collection. which is related to minor compaction and major compaction of entry logs. For details, see here.