Skip to content

[Doc]--Restore clusterDispatchRate policy for compatibility #7380

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Jennifer88huang-zz merged 1 commit into from
Jun 29, 2020
Merged

[Doc]--Restore clusterDispatchRate policy for compatibility #7380

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 9 additions & 2 deletions site2/docs/admin-api-namespaces.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -554,11 +554,18 @@ admin.namespaces().getRetention(namespace)

#### set dispatch throttling

It sets message dispatch rate for all the topics under a given namespace.
It sets message dispatch rate for all the topics under a given namespace.
Dispatch rate can be restricted by number of message per X seconds (`msg-dispatch-rate`) or by number of message-bytes per X second (`byte-dispatch-rate`).
dispatch rate is in second and it can be configured with `dispatch-rate-period`. Default value of `msg-dispatch-rate` and `byte-dispatch-rate` is -1 which
disables the throttling.

#### Note
> - If neither `clusterDispatchRate` nor `topicDispatchRate` is configured, dispatch throttling is disabled.
> >
> - If `topicDispatchRate` is not configured, `clusterDispatchRate` takes effect.
> >
> - If `topicDispatchRate` is configured, `topicDispatchRate` takes effect.

###### CLI

```
Expand Down Expand Up @@ -669,7 +676,7 @@ $ pulsar-admin namespaces get-subscription-dispatch-rate test-tenant/ns1
admin.namespaces().getSubscriptionDispatchRate(namespace)
```

#### set dispatch throttling for subscription
#### set dispatch throttling for replicator

It sets message dispatch rate for all the replicator between replication clusters under a given namespace.
Dispatch rate can be restricted by number of message per X seconds (`msg-dispatch-rate`) or by number of message-bytes per X second (`byte-dispatch-rate`).
Expand Down