[GitHub] [pulsar] vzhikserg commented on a change in pull request #6890: [Docs] Document cli commands for publish rate feature

[GitBox <gi...@apache.org>]

vzhikserg commented on a change in pull request #6890:
URL: https://github.com/apache/pulsar/pull/6890#discussion_r420736103



##########
File path: site2/docs/reference-pulsar-admin.md
##########
@@ -1641,6 +1641,27 @@ Options
 |`-c`, `--compatibility`|Compatibility level required for new schemas created via a Producer. Possible values (Full, Backward, Forward, None).|Full|
 |`-d`, `--disabled`|Disable automatic schema updates.|false|
 
+### `get-publish-rate`
+Get the message publish rate for each topic in a namespace, in bytes as well as messages per second 
+
+Usage
+```bash
+$ pulsar-admin namespaces get-publish-rate tenant/namespace
+```
+
+### `set-publish=rate`

Review comment:
       Should not it be `set-publish-rate`? 🤔 

##########
File path: site2/docs/reference-pulsar-admin.md
##########
@@ -1641,6 +1641,27 @@ Options
 |`-c`, `--compatibility`|Compatibility level required for new schemas created via a Producer. Possible values (Full, Backward, Forward, None).|Full|
 |`-d`, `--disabled`|Disable automatic schema updates.|false|
 
+### `get-publish-rate`
+Get the message publish rate for each topic in a namespace, in bytes as well as messages per second 
+
+Usage
+```bash
+$ pulsar-admin namespaces get-publish-rate tenant/namespace
+```
+
+### `set-publish=rate`
+Set the message publish rate for each topic in a namespace
+
+Usage
+```bash
+$ pulsar-admin namespaces set-publish-rate tenant/namespace options
+```
+
+Options
+|Flag|Description|Default|
+|----|---|---|
+|`-m`, `--msg-publish-rate`|Threshold for number of messages per topic in the namespace (-1 implies not set, 0 for no limit).|-1|
+|`-b`, `--byte-publish-rate`|Threshold for number of messages per topic in the namespace (-1 implies not set, 0 for no limit).|-1|

Review comment:
       The comment is copied from the line above and doesn't explain correctly what this parameter does




----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org