mirror of https://github.com/dapr/docs.git
Modified the RocketMQ document based on V1.10 (#2951)
* Modified the RocketMQ document based on V1.10 Signed-off-by: jinjianfeng-chn <feng081212@163.com> * Update daprdocs/content/en/reference/components-reference/supported-pubsub/setup-rocketmq.md Co-authored-by: Hannah Hunter <94493363+hhunter-ms@users.noreply.github.com> Signed-off-by: jinjianfeng-chn <feng081212@163.com> * Update daprdocs/content/en/reference/components-reference/supported-pubsub/setup-rocketmq.md Co-authored-by: Hannah Hunter <94493363+hhunter-ms@users.noreply.github.com> Signed-off-by: jinjianfeng-chn <feng081212@163.com> * Update daprdocs/content/en/reference/components-reference/supported-pubsub/setup-rocketmq.md Co-authored-by: Hannah Hunter <94493363+hhunter-ms@users.noreply.github.com> Signed-off-by: jinjianfeng-chn <feng081212@163.com> * Update daprdocs/content/en/reference/components-reference/supported-pubsub/setup-rocketmq.md Co-authored-by: Hannah Hunter <94493363+hhunter-ms@users.noreply.github.com> Signed-off-by: jinjianfeng-chn <feng081212@163.com> * Update daprdocs/content/en/reference/components-reference/supported-pubsub/setup-rocketmq.md Co-authored-by: Hannah Hunter <94493363+hhunter-ms@users.noreply.github.com> Signed-off-by: jinjianfeng-chn <feng081212@163.com> * Update daprdocs/content/en/reference/components-reference/supported-pubsub/setup-rocketmq.md Co-authored-by: Hannah Hunter <94493363+hhunter-ms@users.noreply.github.com> Signed-off-by: jinjianfeng-chn <feng081212@163.com> * Update daprdocs/content/en/reference/components-reference/supported-pubsub/setup-rocketmq.md Co-authored-by: Hannah Hunter <94493363+hhunter-ms@users.noreply.github.com> Signed-off-by: jinjianfeng-chn <feng081212@163.com> * Update daprdocs/content/en/reference/components-reference/supported-pubsub/setup-rocketmq.md Co-authored-by: Hannah Hunter <94493363+hhunter-ms@users.noreply.github.com> Signed-off-by: jinjianfeng-chn <feng081212@163.com> * Update daprdocs/content/en/reference/components-reference/supported-pubsub/setup-rocketmq.md Co-authored-by: Hannah Hunter <94493363+hhunter-ms@users.noreply.github.com> Signed-off-by: jinjianfeng-chn <feng081212@163.com> * Update daprdocs/content/en/reference/components-reference/supported-pubsub/setup-rocketmq.md Co-authored-by: Hannah Hunter <94493363+hhunter-ms@users.noreply.github.com> Signed-off-by: jinjianfeng-chn <feng081212@163.com> * Update daprdocs/content/en/reference/components-reference/supported-pubsub/setup-rocketmq.md Co-authored-by: Hannah Hunter <94493363+hhunter-ms@users.noreply.github.com> Signed-off-by: jinjianfeng-chn <feng081212@163.com> * Update daprdocs/content/en/reference/components-reference/supported-pubsub/setup-rocketmq.md Co-authored-by: Hannah Hunter <94493363+hhunter-ms@users.noreply.github.com> Signed-off-by: jinjianfeng-chn <feng081212@163.com> * Update daprdocs/content/en/reference/components-reference/supported-pubsub/setup-rocketmq.md Co-authored-by: Hannah Hunter <94493363+hhunter-ms@users.noreply.github.com> Signed-off-by: jinjianfeng-chn <feng081212@163.com> * Update daprdocs/content/en/reference/components-reference/supported-pubsub/setup-rocketmq.md Co-authored-by: Hannah Hunter <94493363+hhunter-ms@users.noreply.github.com> Signed-off-by: jinjianfeng-chn <feng081212@163.com> * Update daprdocs/content/en/reference/components-reference/supported-pubsub/setup-rocketmq.md Co-authored-by: Hannah Hunter <94493363+hhunter-ms@users.noreply.github.com> Signed-off-by: jinjianfeng-chn <feng081212@163.com> * Update daprdocs/content/en/reference/components-reference/supported-pubsub/setup-rocketmq.md Co-authored-by: Hannah Hunter <94493363+hhunter-ms@users.noreply.github.com> Signed-off-by: jinjianfeng-chn <feng081212@163.com> * Update daprdocs/content/en/reference/components-reference/supported-pubsub/setup-rocketmq.md Co-authored-by: Hannah Hunter <94493363+hhunter-ms@users.noreply.github.com> Signed-off-by: jinjianfeng-chn <feng081212@163.com> * Update daprdocs/content/en/reference/components-reference/supported-pubsub/setup-rocketmq.md Co-authored-by: Hannah Hunter <94493363+hhunter-ms@users.noreply.github.com> Signed-off-by: jinjianfeng-chn <feng081212@163.com> * Update daprdocs/content/en/reference/components-reference/supported-pubsub/setup-rocketmq.md Co-authored-by: Hannah Hunter <94493363+hhunter-ms@users.noreply.github.com> Signed-off-by: jinjianfeng-chn <feng081212@163.com> * Update daprdocs/content/en/reference/components-reference/supported-pubsub/setup-rocketmq.md Co-authored-by: Hannah Hunter <94493363+hhunter-ms@users.noreply.github.com> Signed-off-by: jinjianfeng-chn <feng081212@163.com> * Update daprdocs/content/en/reference/components-reference/supported-pubsub/setup-rocketmq.md Co-authored-by: Hannah Hunter <94493363+hhunter-ms@users.noreply.github.com> Signed-off-by: jinjianfeng-chn <feng081212@163.com> * Update daprdocs/content/en/reference/components-reference/supported-pubsub/setup-rocketmq.md Co-authored-by: Hannah Hunter <94493363+hhunter-ms@users.noreply.github.com> Signed-off-by: jinjianfeng-chn <feng081212@163.com> * Update daprdocs/content/en/reference/components-reference/supported-pubsub/setup-rocketmq.md Co-authored-by: Hannah Hunter <94493363+hhunter-ms@users.noreply.github.com> Signed-off-by: jinjianfeng-chn <feng081212@163.com> * Update daprdocs/content/en/reference/components-reference/supported-pubsub/setup-rocketmq.md Co-authored-by: Hannah Hunter <94493363+hhunter-ms@users.noreply.github.com> Signed-off-by: jinjianfeng-chn <feng081212@163.com> * Update daprdocs/content/en/reference/components-reference/supported-pubsub/setup-rocketmq.md Co-authored-by: Hannah Hunter <94493363+hhunter-ms@users.noreply.github.com> Signed-off-by: jinjianfeng-chn <feng081212@163.com> * Update daprdocs/content/en/reference/components-reference/supported-pubsub/setup-rocketmq.md Co-authored-by: Hannah Hunter <94493363+hhunter-ms@users.noreply.github.com> Signed-off-by: jinjianfeng-chn <feng081212@163.com> * Update daprdocs/content/en/reference/components-reference/supported-pubsub/setup-rocketmq.md Co-authored-by: Hannah Hunter <94493363+hhunter-ms@users.noreply.github.com> Signed-off-by: jinjianfeng-chn <feng081212@163.com> * Update daprdocs/content/en/reference/components-reference/supported-pubsub/setup-rocketmq.md Co-authored-by: Hannah Hunter <94493363+hhunter-ms@users.noreply.github.com> Signed-off-by: jinjianfeng-chn <feng081212@163.com> * Update daprdocs/content/en/reference/components-reference/supported-pubsub/setup-rocketmq.md Co-authored-by: Hannah Hunter <94493363+hhunter-ms@users.noreply.github.com> Signed-off-by: jinjianfeng-chn <feng081212@163.com> * Grammar/readability pass Signed-off-by: jinjianfeng-chn <feng081212@163.com> Signed-off-by: jinjianfeng-chn <feng081212@163.com> Co-authored-by: Hannah Hunter <94493363+hhunter-ms@users.noreply.github.com>
This commit is contained in:
jinjianfeng-chn
GitHub
parent
6173f14ddb
commit
7d5c4bc626
|
|
@ -19,16 +19,22 @@ spec:
|
|||
type: pubsub.rocketmq
|
||||
version: v1
|
||||
metadata:
|
||||
- name: nameServer
|
||||
value: "http://localhost:9876"
|
||||
- name: accessKey
|
||||
value: "admin"
|
||||
- name: secretKey
|
||||
value: "password"
|
||||
- name: instanceName
|
||||
value: dapr-rocketmq-test
|
||||
- name: consumerGroup
|
||||
value: "GID_0001"
|
||||
value: dapr-rocketmq-test-g-c
|
||||
- name: producerGroup
|
||||
value: dapr-rocketmq-test-g-p
|
||||
- name: nameSpace
|
||||
value: dapr-test
|
||||
- name: nameServer
|
||||
value: "127.0.0.1:9876,127.0.0.2:9876"
|
||||
- name: retries
|
||||
value: 10
|
||||
value: 3
|
||||
- name: consumerModel
|
||||
value: "clustering"
|
||||
- name: consumeOrderly
|
||||
value: false
|
||||
```
|
||||
|
||||
{{% alert title="Warning" color="warning" %}}
|
||||
|
|
@ -36,18 +42,33 @@ The above example uses secrets as plain strings. It is recommended to use a secr
|
|||
{{% /alert %}}
|
||||
|
||||
## Spec metadata fields
|
||||
| Field | Required | Details | Example |
|
||||
| ---------------- | :------: | --------------------------------------------------------------------------------------------------------- | ---------------------------------- |
|
||||
| accessKey | N | Access Key (Username) | `"admin"` |
|
||||
| secretKey | N | Secret Key (Password) | `"password"` |
|
||||
| nameServer | N | Name server address | `"127.0.0.1:9876;127.0.0.2:9877"` |
|
||||
| nameServerDomain | N | Name server domain | `"https://my-app.net:8080/nsaddr"` |
|
||||
| nameSpace | N | Namespace of the producer/consumer | `"namespace"` |
|
||||
| producerGroup | N | Producer group name for RocketMQ publishers | `"my_unique_group_name"` |
|
||||
| consumerGroup | N | Consumer group name for RocketMQ subscribers | `"my_unique_group_name"` |
|
||||
| content-type | N | Message content-type, e.g., `"application/cloudevents+json; charset=utf-8"`, `"application/octet-stream"` | `"text/plain"` |
|
||||
| retries | N | Number of times to retry to connect rocketmq's broker, optional | `0` |
|
||||
| sendTimeOutSec | N | Timeout duration for publishing a message in seconds | `0` |
|
||||
| Field | Required | Details | default | Example |
|
||||
| ------------------------------------- | :------: | ------------------------------------------------------------ | ----------------------------------------------------------- | ------------------------------------------------------------ |
|
||||
| instanceName | N | Instance name | `time.Now().String()` | `dapr-rocketmq-test` |
|
||||
| consumerGroup | N | Consumer group name. Recommend. If `producerGroup` is `null`，`groupName` is used. | | `dapr-rocketmq-test-g-c ` |
|
||||
| producerGroup (consumerID) | N | Producer group name. Recommended. If `producerGroup` is `null`，`consumerID` is used. If `consumerID` also is null, `groupName` is used. | | `dapr-rocketmq-test-g-p` |
|
||||
| groupName | N | Consumer/Producer group name. **Depreciated**. | | `dapr-rocketmq-test-g` |
|
||||
| nameSpace | N | RocketMQ namespace | | `dapr-rocketmq` |
|
||||
| nameServerDomain | N | RocketMQ name server domain | | `https://my-app.net:8080/nsaddr` |
|
||||
| nameServer | N | RocketMQ name server, separated by "," or ";" | | `127.0.0.1:9876;127.0.0.2:9877,127.0.0.3:9877` |
|
||||
| accessKey | N | Access Key (Username) | | `"admin"` |
|
||||
| secretKey | N | Secret Key (Password) | | `"password"` |
|
||||
| securityToken | N | Security Token | | |
|
||||
| retries | N | Number of retries to send a message to broker | `3` | `3` |
|
||||
| producerQueueSelector (queueSelector) | N | Producer Queue selector. There are five implementations of queue selector: `hash`, `random`, `manual`, `roundRobin`, `dapr`. | `dapr` | `hash` |
|
||||
| consumerModel | N | Message model that defines how messages are delivered to each consumer client. RocketMQ supports two message models: `clustering` and `broadcasting`. | `clustering` | `broadcasting` , `clustering` |
|
||||
| fromWhere (consumeFromWhere) | N | Consuming point on consumer booting. There are three consuming points: `CONSUME_FROM_LAST_OFFSET`, `CONSUME_FROM_FIRST_OFFSET`, `CONSUME_FROM_TIMESTAMP` | `CONSUME_FROM_LAST_OFFSET` | `CONSUME_FROM_LAST_OFFSET` |
|
||||
| consumeOrderly | N | Determines if it's an ordered message using FIFO order. | `false` | `false` |
|
||||
| consumeMessageBatchMaxSize | N | Batch consumption size out of range `[1, 1024]` | `512` | `10` |
|
||||
| maxReconsumeTimes | N | Max re-consume times. `-1` means 16 times. If messages are re-consumed more than {@link maxReconsumeTimes} before success, they'll be directed to a deletion queue. | Orderly message is `MaxInt32`; Concurrently message is `16` | `16` |
|
||||
| autoCommit | N | Enable auto commit | `true` | `false` |
|
||||
| pullInterval | N | Message pull interval | `100` | `100` |
|
||||
| pullBatchSize | N | The number of messages pulled from the broker at a time. If `pullBatchSize` is `null`, use `ConsumerBatchSize`. `pullBatchSize` out of range `[1, 1024]` | `32` | `10` |
|
||||
| content-type | N | Message content type. | `"text/plain"` | `"application/cloudevents+json; charset=utf-8"`, `"application/octet-stream"` |
|
||||
| logLevel | N | Log level | `warn` | `info` |
|
||||
| sendTimeOut | N | Send message timeout to connect RocketMQ's broker, measured in nanoseconds. **Deprecated**. | 3 seconds | `10000000000` |
|
||||
| sendTimeOutSec | N | Timeout duration for publishing a message in seconds. If `sendTimeOutSec` is `null`, `sendTimeOut` is used. | 3 seconds | `3` |
|
||||
| mspProperties | N | The RocketMQ message properties in this collection are passed to the APP in Data Separate multiple properties with "," | | `key,mkey` |
|
||||
|
||||
For backwards-compatibility reasons, the following values in the metadata are supported, although their use is discouraged.
|
||||
|
||||
|
|
@ -55,6 +76,7 @@ For backwards-compatibility reasons, the following values in the metadata are su
|
|||
| -------------------------------- | :------: | -------------------------------------------------------- | ------------------------ |
|
||||
| groupName | N | Producer group name for RocketMQ publishers | `"my_unique_group_name"` |
|
||||
| sendTimeOut | N | Timeout duration for publishing a message in nanoseconds | `0` |
|
||||
| consumerBatchSize | N | The number of messages pulled from the broker at a time | `32` |
|
||||
|
||||
## Setup RocketMQ
|
||||
See https://rocketmq.apache.org/docs/quick-start/ to setup a local RocketMQ instance.
|
||||
|
|
@ -65,12 +87,12 @@ See https://rocketmq.apache.org/docs/quick-start/ to setup a local RocketMQ inst
|
|||
|
||||
When invoking the RocketMQ pub/sub, it's possible to provide an optional partition key by using the `metadata` query param in the request url.
|
||||
|
||||
You need to specify `rocketmq-tag`,`"rocketmq-key"` in `metadata`
|
||||
You need to specify `rocketmq-tag` , `"rocketmq-key"` , `rocketmq-shardingkey` , `rocketmq-queue` in `metadata`
|
||||
|
||||
Example:
|
||||
|
||||
```shell
|
||||
curl -X POST http://localhost:3500/v1.0/publish/myRocketMQ/myTopic?metadata.rocketmq-tag=?&metadata.rocketmq-key=? \
|
||||
curl -X POST http://localhost:3500/v1.0/publish/myRocketMQ/myTopic?metadata.rocketmq-tag=?&metadata.rocketmq-key=?&metadata.rocketmq-shardingkey=key&metadata.rocketmq-queue=1 \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{
|
||||
"data": {
|
||||
|
|
@ -79,7 +101,50 @@ curl -X POST http://localhost:3500/v1.0/publish/myRocketMQ/myTopic?metadata.rock
|
|||
}'
|
||||
```
|
||||
|
||||
## QueueSelector
|
||||
|
||||
The RocketMQ component contains a total of five queue selectors. The RocketMQ client provides the following queue selectors:
|
||||
- `HashQueueSelector`
|
||||
- `RandomQueueSelector`
|
||||
- `RoundRobinQueueSelector`
|
||||
- `ManualQueueSelector`
|
||||
|
||||
To learn more about these RocketMQ client queue selectors, read the [RocketMQ documentation](https://rocketmq.apache.org/docs).
|
||||
|
||||
The Dapr RocketMQ component implements the following queue selector:
|
||||
- `DaprQueueSelector`
|
||||
|
||||
This article focuses on the design of `DaprQueueSelector`.
|
||||
|
||||
### DaprQueueSelector
|
||||
|
||||
`DaprQueueSelector` integrates three queue selectors:
|
||||
- `HashQueueSelector`
|
||||
- `RoundRobinQueueSelector`
|
||||
- `ManualQueueSelector`
|
||||
|
||||
`DaprQueueSelector` gets the queue id from the request parameter. You can set the queue id by running the following:
|
||||
|
||||
```
|
||||
http://localhost:3500/v1.0/publish/myRocketMQ/myTopic?metadata.rocketmq-queue=1
|
||||
```
|
||||
|
||||
The `ManualQueueSelector` is implemented using the method above.
|
||||
|
||||
Next, the `DaprQueueSelector` tries to:
|
||||
- Get a `ShardingKey`
|
||||
- Hash the `ShardingKey` to determine the queue id.
|
||||
|
||||
You can set the `ShardingKey` by doing the following:
|
||||
|
||||
```
|
||||
http://localhost:3500/v1.0/publish/myRocketMQ/myTopic?metadata.rocketmq-shardingkey=key
|
||||
```
|
||||
|
||||
If the `ShardingKey` does not exist, the `RoundRobin` algorithm is used to determine the queue id.
|
||||
|
||||
## Related links
|
||||
|
||||
- [Basic schema for a Dapr component]({{< ref component-schema >}})
|
||||
- [Pub/Sub building block]({{< ref pubsub >}})
|
||||
- Read [this guide]({{< ref "howto-publish-subscribe.md#step-2-publish-a-topic" >}}) for instructions on configuring pub/sub components
|
||||
|
|
|
|||
Loading…
Reference in New Issue