You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@eventmesh.apache.org by "fabian4 (via GitHub)" <gi...@apache.org> on 2023/12/19 15:49:34 UTC
[PR] [ISSUE #4683] Documentation Needed for eventmesh-connector-rabbitmq (eventmesh)
fabian4 opened a new pull request, #4684:
URL: https://github.com/apache/eventmesh/pull/4684
<!--
### Contribution Checklist
- Name the pull request in the form "[ISSUE #XXXX] Title of the pull request",
where *XXXX* should be replaced by the actual issue number.
Skip *[ISSUE #XXXX]* if there is no associated github issue for this pull request.
- Fill out the template below to describe the changes contributed by the pull request.
That will give reviewers the context they need to do the review.
- Each pull request should address only one issue.
Please do not mix up code from multiple issues.
- Each commit in the pull request should have a meaningful commit message.
- Once all items of the checklist are addressed, remove the above text and this checklist,
leaving only the filled out template below.
(The sections below can be removed for hotfixes of typos)
-->
<!--
(If this PR fixes a GitHub issue, please add `Fixes #<XXX>` or `Closes #<XXX>`.)
-->
Fixes #4683.
### Motivation
*Explain the content here.*
*Explain why you want to make the changes and what problem you're trying to solve.*
### Modifications
*Describe the modifications you've done.*
### Documentation
- Does this pull request introduce a new feature? (yes / no)
- If yes, how is the feature documented? (not applicable / docs / JavaDocs / not documented)
- If a feature is not applicable for documentation, explain why?
- If a feature is not documented yet in this PR, please create a followup issue for adding the documentation
--
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.
To unsubscribe, e-mail: dev-unsubscribe@eventmesh.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@eventmesh.apache.org
For additional commands, e-mail: dev-help@eventmesh.apache.org
Re: [PR] [ISSUE #4683] Documentation Needed for eventmesh-connector-redis (eventmesh)
Posted by "pandaapo (via GitHub)" <gi...@apache.org>.
pandaapo commented on code in PR #4684:
URL: https://github.com/apache/eventmesh/pull/4684#discussion_r1433311076
##########
eventmesh-connectors/eventmesh-connector-rabbitmq/README_CN.md:
##########
@@ -1,10 +1,13 @@
# RabbitMQ
+Connector 通过 `main()` 作为一个独立服务运行在 [eventmesh-connectors#connector](https://github.com/apache/eventmesh/tree/master/eventmesh-connectors#connector)
Review Comment:
这里读起来似乎也不通顺。能否将`在`换成`。`从而把前后分开？或者直接去掉`在 [eventmesh-connectors#connector](https://github.com/apache/eventmesh/tree/master/eventmesh-connectors#connector)`？
--
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.
To unsubscribe, e-mail: issues-unsubscribe@eventmesh.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@eventmesh.apache.org
For additional commands, e-mail: issues-help@eventmesh.apache.org
Re: [PR] [ISSUE #4683] Documentation Needed for eventmesh-connector-redis (eventmesh)
Posted by "pandaapo (via GitHub)" <gi...@apache.org>.
pandaapo commented on code in PR #4684:
URL: https://github.com/apache/eventmesh/pull/4684#discussion_r1432886000
##########
eventmesh-connectors/eventmesh-connector-mongodb/README.md:
##########
@@ -1,10 +1,13 @@
# MongoDB
+Connector runs as a standalone service by `main()` in [eventmesh-connectors#connector](https://github.com/apache/eventmesh/tree/master/eventmesh-connectors#connector)
+
## MongoDBSinkConnector: From EventMesh to MongoDB
1. launch your MongoDB server and EventMesh Runtime.
2. enable sinkConnector and check `sink-config.yml`.
-3. send a message to EventMesh with the topic defined in `pubSubConfig.subject`
+3. start your MongoDBConnectorServer, it will subscribe to the topic defined in `pubSubConfig.subject` of EventMesh Runtime and send data to `connectorConfig.collection` in your MongoDB.
+4. send a message to EventMesh with the topic defined in `pubSubConfig.subject`.
Review Comment:
I didn't understand the meaning of this sentence in your Sink document. Because Sink doesn't have such a feature.
--
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.
To unsubscribe, e-mail: issues-unsubscribe@eventmesh.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@eventmesh.apache.org
For additional commands, e-mail: issues-help@eventmesh.apache.org
Re: [PR] [ISSUE #4683] Documentation Needed for eventmesh-connector-redis (eventmesh)
Posted by "codecov[bot] (via GitHub)" <gi...@apache.org>.
codecov[bot] commented on PR #4684:
URL: https://github.com/apache/eventmesh/pull/4684#issuecomment-1865384225
## [Codecov](https://app.codecov.io/gh/apache/eventmesh/pull/4684?src=pr&el=h1&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache) Report
All modified and coverable lines are covered by tests :white_check_mark:
> Comparison is base [(`e056d7a`)](https://app.codecov.io/gh/apache/eventmesh/commit/e056d7a56f349a000611e92aa457b51b782dbfee?el=desc&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache) 17.39% compared to head [(`8c83064`)](https://app.codecov.io/gh/apache/eventmesh/pull/4684?src=pr&el=desc&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache) 17.38%.
<details><summary>Additional details and impacted files</summary>
```diff
@@ Coverage Diff @@
## master #4684 +/- ##
============================================
- Coverage 17.39% 17.38% -0.02%
Complexity 1759 1759
============================================
Files 797 797
Lines 29844 29839 -5
Branches 2579 2577 -2
============================================
- Hits 5192 5188 -4
+ Misses 24171 24168 -3
- Partials 481 483 +2
```
</details>
[:umbrella: View full report in Codecov by Sentry](https://app.codecov.io/gh/apache/eventmesh/pull/4684?src=pr&el=continue&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache).
:loudspeaker: Have feedback on the report? [Share it here](https://about.codecov.io/codecov-pr-comment-feedback/?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=apache).
--
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.
To unsubscribe, e-mail: issues-unsubscribe@eventmesh.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@eventmesh.apache.org
For additional commands, e-mail: issues-help@eventmesh.apache.org
Re: [PR] [ISSUE #4683] Documentation Needed for eventmesh-connector-redis (eventmesh)
Posted by "pandaapo (via GitHub)" <gi...@apache.org>.
pandaapo commented on code in PR #4684:
URL: https://github.com/apache/eventmesh/pull/4684#discussion_r1433311076
##########
eventmesh-connectors/eventmesh-connector-rabbitmq/README_CN.md:
##########
@@ -1,10 +1,13 @@
# RabbitMQ
+Connector 通过 `main()` 作为一个独立服务运行在 [eventmesh-connectors#connector](https://github.com/apache/eventmesh/tree/master/eventmesh-connectors#connector)
Review Comment:
这里读起来似乎也不通顺。能否将`在`换成`。`从而把前后分开？或者直接去掉`在 [eventmesh-connectors#connector](https://github.com/apache/eventmesh/tree/master/eventmesh-connectors#connector)`？
--
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.
To unsubscribe, e-mail: issues-unsubscribe@eventmesh.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@eventmesh.apache.org
For additional commands, e-mail: issues-help@eventmesh.apache.org
Re: [PR] [ISSUE #4683] Documentation Needed for eventmesh-connector-redis (eventmesh)
Posted by "pandaapo (via GitHub)" <gi...@apache.org>.
pandaapo commented on code in PR #4684:
URL: https://github.com/apache/eventmesh/pull/4684#discussion_r1432894231
##########
eventmesh-connectors/eventmesh-connector-mongodb/README.md:
##########
@@ -1,10 +1,13 @@
# MongoDB
+Connector runs as a standalone service by `main()` in [eventmesh-connectors#connector](https://github.com/apache/eventmesh/tree/master/eventmesh-connectors#connector)
+
## MongoDBSinkConnector: From EventMesh to MongoDB
1. launch your MongoDB server and EventMesh Runtime.
2. enable sinkConnector and check `sink-config.yml`.
-3. send a message to EventMesh with the topic defined in `pubSubConfig.subject`
+3. start your MongoDBConnectorServer, it will subscribe to the topic defined in `pubSubConfig.subject` of EventMesh Runtime and send data to `connectorConfig.collection` in your MongoDB.
+4. send a message to EventMesh with the topic defined in `pubSubConfig.subject`.
Review Comment:
I didn't understand the meaning of this sentence in your Sink document. Because Sink doesn't have such a feature.
##########
eventmesh-connectors/eventmesh-connector-mongodb/README.md:
##########
@@ -1,10 +1,13 @@
# MongoDB
+Connector runs as a standalone service by `main()` in [eventmesh-connectors#connector](https://github.com/apache/eventmesh/tree/master/eventmesh-connectors#connector)
Review Comment:
Could you replace `in` with a period to separate the front and back? This will seem more smooth.
--
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.
To unsubscribe, e-mail: issues-unsubscribe@eventmesh.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@eventmesh.apache.org
For additional commands, e-mail: issues-help@eventmesh.apache.org
Re: [PR] [ISSUE #4683] Documentation Needed for eventmesh-connector-redis (eventmesh)
Posted by "pandaapo (via GitHub)" <gi...@apache.org>.
pandaapo commented on code in PR #4684:
URL: https://github.com/apache/eventmesh/pull/4684#discussion_r1433320737
##########
eventmesh-connectors/eventmesh-connector-mongodb/README_CN.md:
##########
@@ -1,10 +1,13 @@
# MongoDB
+Connector 通过 `main()` 作为一个独立服务运行在 [eventmesh-connectors#connector](https://github.com/apache/eventmesh/tree/master/eventmesh-connectors#connector)
Review Comment:
其实我原本这条评论https://github.com/apache/eventmesh/pull/4684#issuecomment-1864182005 的意思是希望您能帮忙在这个文档https://github.com/apache/eventmesh/tree/master/eventmesh-connectors#connector 中加上“Connector runs as a standalone service by `main()`.”这句话。当然您现在加到具体的Connector文档中也没问题。
只是现在这里读起来似乎不通顺。能否像英文版一样将`在`换成`。`从而把前后分开？或者直接去掉`在 [eventmesh-connectors#connector](https://github.com/apache/eventmesh/tree/master/eventmesh-connectors#connector)`？
--
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.
To unsubscribe, e-mail: issues-unsubscribe@eventmesh.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@eventmesh.apache.org
For additional commands, e-mail: issues-help@eventmesh.apache.org
Re: [PR] [ISSUE #4683] Documentation Needed for eventmesh-connector-redis (eventmesh)
Posted by "pandaapo (via GitHub)" <gi...@apache.org>.
pandaapo commented on code in PR #4684:
URL: https://github.com/apache/eventmesh/pull/4684#discussion_r1432484425
##########
eventmesh-connectors/eventmesh-connector-redis/README.md:
##########
@@ -0,0 +1,32 @@
+# Redis
+
+## RedisSinkConnector: From EventMesh to Redis topic queue
+
+1. start your redis instance if needed and EventMesh Runtime.
+2. enable sinkConnector and check `sink-config.yml`.
+3. send a message to EventMesh with the topic defined in `pubSubConfig.subject`
+
+```yaml
+pubSubConfig:
+ # default port 10000
+ meshAddress: your.eventmesh.server:10000
+ subject: TopicTest
+ idc: FT
+ env: PRD
+ group: redisSink
+ appId: 5031
+ userName: redisSinkUser
+ passWord: redisPassWord
+connectorConfig:
+ connectorName: redisSink
+ server: redis://127.0.0.1:6379
+ # the topic in redis
+ topic: SinkTopic
+```
+
+## RedisSourceConnector: From Redis topic queue to EventMesh
+
+1. start your redis instance if needed and EventMesh Runtime.
+2. enable sourceConnector and check `source-config.yml` (Basically the same as `sink-config.yml`)
+3. start your `RedisConnectorServer` and you will subscribe to a topic in redis.
Review Comment:
It should be `RedisConnectServer`.
##########
eventmesh-connectors/eventmesh-connector-redis/README.md:
##########
@@ -0,0 +1,32 @@
+# Redis
+
+## RedisSinkConnector: From EventMesh to Redis topic queue
+
+1. start your redis instance if needed and EventMesh Runtime.
+2. enable sinkConnector and check `sink-config.yml`.
+3. send a message to EventMesh with the topic defined in `pubSubConfig.subject`
Review Comment:
The description of point 3 seems to be incorrect. Could you change it to something similar to the following statement? “start your `RedisConnectServer`, it will subscribe to the topic defined in `pubSubConfig.subject` of EventMesh Runtime and send data to `connectorConfig.topic` in your redis".
Please also check the Sink documents you previously wrote.
##########
eventmesh-connectors/eventmesh-connector-redis/README_CN.md:
##########
@@ -0,0 +1,32 @@
+# Redis
+
+## RedisSinkConnector：从 EventMesh 到 Redis 的消息队列
+
+1. 启动你的 redis 实例和 EventMesh Runtime。
+2. 启用 sinkConnector 并检查 `sink-config.yml`。
+3. 使用在 `pubSubConfig.subject` 中指定的 Topic，向 EventMesh 发送消息。
+
+```yaml
+pubSubConfig:
+ # 默认端口 10000
+ meshAddress: your.eventmesh.server:10000
+ subject: TopicTest
+ idc: FT
+ env: PRD
+ group: redisSink
+ appId: 5031
+ userName: redisSinkUser
+ passWord: redisPassWord
+connectorConfig:
+ connectorName: redisSink
+ server: redis://127.0.0.1:6379
+ # redis 中的主题
+ topic: SinkTopic
+```
+
+## RedisSourceConnector：从 Redis 的消息队列 到 EventMesh
+
+1. 启动你的 redis 实例和 EventMesh Runtime。
+2. 启用 sourceConnector 并检查 `source-config.yml`（与 sink-config.yml 基本相同）。
+3. 启动你的 RabbitMQConnectorServer，你会自动订阅 redis 中的主题。
Review Comment:
It should be `RedisConnectServer`.
--
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.
To unsubscribe, e-mail: issues-unsubscribe@eventmesh.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@eventmesh.apache.org
For additional commands, e-mail: issues-help@eventmesh.apache.org
Re: [PR] [ISSUE #4683] Documentation Needed for eventmesh-connector-redis (eventmesh)
Posted by "Pil0tXia (via GitHub)" <gi...@apache.org>.
Pil0tXia commented on PR #4684:
URL: https://github.com/apache/eventmesh/pull/4684#issuecomment-1864809513
I have a small suggestion. It would be better to use `RabbitMQ` instead of `rabbitmq`, and the same applies to `MongoDB` and `Redis`.
--
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.
To unsubscribe, e-mail: issues-unsubscribe@eventmesh.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@eventmesh.apache.org
For additional commands, e-mail: issues-help@eventmesh.apache.org
Re: [PR] [ISSUE #4683] Documentation Needed for eventmesh-connector-redis (eventmesh)
Posted by "pandaapo (via GitHub)" <gi...@apache.org>.
pandaapo commented on code in PR #4684:
URL: https://github.com/apache/eventmesh/pull/4684#discussion_r1432886000
##########
eventmesh-connectors/eventmesh-connector-mongodb/README.md:
##########
@@ -1,10 +1,13 @@
# MongoDB
+Connector runs as a standalone service by `main()` in [eventmesh-connectors#connector](https://github.com/apache/eventmesh/tree/master/eventmesh-connectors#connector)
+
## MongoDBSinkConnector: From EventMesh to MongoDB
1. launch your MongoDB server and EventMesh Runtime.
2. enable sinkConnector and check `sink-config.yml`.
-3. send a message to EventMesh with the topic defined in `pubSubConfig.subject`
+3. start your MongoDBConnectorServer, it will subscribe to the topic defined in `pubSubConfig.subject` of EventMesh Runtime and send data to `connectorConfig.collection` in your MongoDB.
+4. send a message to EventMesh with the topic defined in `pubSubConfig.subject`.
Review Comment:
I didn't understand the meaning of this sentence in your Sink document. Because Sink doesn't have such a feature.
--
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.
To unsubscribe, e-mail: issues-unsubscribe@eventmesh.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@eventmesh.apache.org
For additional commands, e-mail: issues-help@eventmesh.apache.org
Re: [PR] [ISSUE #4683] Documentation Needed for eventmesh-connector-redis (eventmesh)
Posted by "mxsm (via GitHub)" <gi...@apache.org>.
mxsm merged PR #4684:
URL: https://github.com/apache/eventmesh/pull/4684
--
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.
To unsubscribe, e-mail: dev-unsubscribe@eventmesh.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@eventmesh.apache.org
For additional commands, e-mail: dev-help@eventmesh.apache.org
Re: [PR] [ISSUE #4683] Documentation Needed for eventmesh-connector-redis (eventmesh)
Posted by "pandaapo (via GitHub)" <gi...@apache.org>.
pandaapo commented on PR #4684:
URL: https://github.com/apache/eventmesh/pull/4684#issuecomment-1864182005
Could you help add a sentence "Connector runs as a standalone service by `main()`." here https://github.com/apache/eventmesh/tree/master/eventmesh-connectors#connector? Because I found that new users may not know how to start Connector https://github.com/apache/eventmesh/issues/4600#issuecomment-1838702676.
--
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.
To unsubscribe, e-mail: issues-unsubscribe@eventmesh.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@eventmesh.apache.org
For additional commands, e-mail: issues-help@eventmesh.apache.org