You are viewing a plain text version of this content. The canonical link for it is here.
Posted to reviews@iotdb.apache.org by GitBox <gi...@apache.org> on 2022/11/25 11:18:55 UTC
[GitHub] [iotdb] caozj1011 opened a new pull request, #8161: add mqtt broker and rest service document
caozj1011 opened a new pull request, #8161:
URL: https://github.com/apache/iotdb/pull/8161
## Description
### Content1 ...
### Content2 ...
### Content3 ...
<!--
In each section, please describe design decisions made, including:
- Choice of algorithms
- Behavioral aspects. What configuration values are acceptable? How are corner cases and error
conditions handled, such as when there are insufficient resources?
- Class organization and design (how the logic is split between classes, inheritance, composition,
design patterns)
- Method organization and design (how the logic is split between methods, parameters and return types)
- Naming (class, method, API, configuration, HTTP endpoint, names of emitted metrics)
-->
<!-- It's good to describe an alternative design (or mention an alternative name) for every design
(or naming) decision point and compare the alternatives with the designs that you've implemented
(or the names you've chosen) to highlight the advantages of the chosen designs and names. -->
<!-- If there was a discussion of the design of the feature implemented in this PR elsewhere
(e. g. a "Proposal" issue, any other issue, or a thread in the development mailing list),
link to that discussion from this PR description and explain what have changed in your final design
compared to your original proposal or the consensus version in the end of the discussion.
If something hasn't changed since the original discussion, you can omit a detailed discussion of
those aspects of the design here, perhaps apart from brief mentioning for the sake of readability
of this PR description. -->
<!-- Some of the aspects mentioned above may be omitted for simple and small changes. -->
<hr>
This PR has:
- [ ] been self-reviewed.
- [ ] concurrent read
- [ ] concurrent write
- [ ] concurrent read and write
- [ ] added documentation for new or modified features or behaviors.
- [ ] added Javadocs for most classes and all non-trivial methods.
- [ ] added or updated version, __license__, or notice information
- [ ] added comments explaining the "why" and the intent of the code wherever would not be obvious
for an unfamiliar reader.
- [ ] added unit tests or modified existing tests to cover new code paths, ensuring the threshold
for code coverage.
- [ ] added integration tests.
- [ ] been tested in a test IoTDB cluster.
<!-- Check the items by putting "x" in the brackets for the done things. Not all of these items
apply to every PR. Remove the items which are not done or not relevant to the PR. None of the items
from the checklist above are strictly necessary, but it would be very helpful if you at least
self-review the PR. -->
<hr>
##### Key changed/added classes (or packages if there are too many classes) in this PR
--
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: reviews-unsubscribe@iotdb.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [iotdb] qiaojialin merged pull request #8161: add mqtt broker and rest service document
Posted by GitBox <gi...@apache.org>.
qiaojialin merged PR #8161:
URL: https://github.com/apache/iotdb/pull/8161
--
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: reviews-unsubscribe@iotdb.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [iotdb] qiaojialin commented on a diff in pull request #8161: add mqtt broker and rest service document
Posted by GitBox <gi...@apache.org>.
qiaojialin commented on code in PR #8161:
URL: https://github.com/apache/iotdb/pull/8161#discussion_r1032406483
##########
docs/UserGuide/Reference/Common-Config-Manual.md:
##########
@@ -965,10 +965,182 @@ IoTDB common files for ConfigNode and DataNode are under `conf`.
| Default | 800 |
| Effective | After restarting system |
+
### MQTT Broker Configuration
+* enable\_mqtt\_service
+
+| Name | enable\_mqtt\_service。 |
+|:-----------:|:------------------------------------|
+| Description | Whether to enable the MQTT service |
+| Type | Boolean |
+| Default | False |
+| Effective | Trigger |
+
+* mqtt\_host
+
+| Name | mqtt\_host |
+|:-----------:|:---------------------------------------------|
+| Description | The host to which the MQTT service is bound |
+| Type | String |
+| Default | 0.0.0.0 |
+| Effective | Trigger |
+
+* mqtt\_port
+
+| Name | mqtt\_port |
+|:-----------:|:--------------------------------------------|
+| Description | The port to which the MQTT service is bound |
+| Type | int32 |
+| Default | 1883 |
+| Effective | Trigger |
+
+* mqtt\_handler\_pool\_size
+
+|Name| mqtt\_handler\_pool\_size |
+|:---:|:------------------------------------------------------------|
+|Description| The size of the handler pool used to process MQTT messages |
+|Type| int32 |
+|Default| 1 |
+|Effective| Trigger |
+
+* mqtt\_payload\_formatter
+
+| Name | mqtt\_payload\_formatter |
+|:-----------:|:-------------------------------|
+| Description | MQTT message payload formatter |
+| Type | String |
+| Default | JSON |
+| Effective | Trigger |
+
+* mqtt\_max\_message\_size
+
+| Name | mqtt\_max\_message\_size |
+|:------:|:-----------------------------------------|
+| Description | Maximum length of MQTT message in bytes |
+| Type | int32 |
+| Default | 1048576 |
+| Effective | Trigger |
+
### REST Service Configuration
+* enable_rest_service
+
+|Name| enable_rest_service |
+|:---:|:--------------------------------------|
+|Description| Whether to enable the Rest service |
+|Type| Boolean |
+|Default| false |
+|Effective| After restarting system |
+
+* rest_service_port
+
+|Name| rest_service_port |
+|:---:|:------------------|
+|Description| The Rest service listens to the port number |
+|Type| int32 |
+|Default| 18080 |
+|Effective| After restarting system |
+
+* enable_swagger
+
+|Name| enable_swagger |
+|:---:|:-----------------------|
+|Description| Whether to enable swagger to display rest interface information |
+|Type| Boolean |
+|Default| false |
+|Effective| After restarting system |
+
+* rest_query_default_row_size_limit
+
+|Name| rest_query_default_row_size_limit |
+|:---:|:------------------------------------------------------------------------------------------|
+|Description| The maximum number of rows in a result set that can be returned by a query |
+|Type| int32 |
+|Default| 10000 |
+|Effective| After restarting system |
+
+* cache_expire
+
+|Name| cache_expire |
+|:---:|:--------------------------------------------------------|
+|Description| Expiration time for caching customer login information |
+|Type| int32 |
+|Default| 28800 |
+|Effective| After restarting system |
+
+* cache_max_num
+
+|Name| cache_max_num |
+|:---:|:--------------|
+|Description| The maximum number of users stored in the cache |
+|Type| int32 |
+|Default| 100 |
+|Effective| After restarting system |
+
+* cache_init_num
+
+|Name| cache_init_num |
+|:---:|:---------------|
+|Description| Initial cache capacity |
+|Type| int32 |
+|Default| 10 |
+|Effective| After restarting system |
+
+* enable_https
Review Comment:
cache\_init\_num
##########
docs/UserGuide/Reference/Common-Config-Manual.md:
##########
@@ -965,10 +965,182 @@ IoTDB common files for ConfigNode and DataNode are under `conf`.
| Default | 800 |
| Effective | After restarting system |
+
### MQTT Broker Configuration
+* enable\_mqtt\_service
+
+| Name | enable\_mqtt\_service。 |
+|:-----------:|:------------------------------------|
+| Description | Whether to enable the MQTT service |
+| Type | Boolean |
+| Default | False |
+| Effective | Trigger |
+
+* mqtt\_host
+
+| Name | mqtt\_host |
+|:-----------:|:---------------------------------------------|
+| Description | The host to which the MQTT service is bound |
+| Type | String |
+| Default | 0.0.0.0 |
+| Effective | Trigger |
+
+* mqtt\_port
+
+| Name | mqtt\_port |
+|:-----------:|:--------------------------------------------|
+| Description | The port to which the MQTT service is bound |
+| Type | int32 |
+| Default | 1883 |
+| Effective | Trigger |
+
+* mqtt\_handler\_pool\_size
+
+|Name| mqtt\_handler\_pool\_size |
+|:---:|:------------------------------------------------------------|
+|Description| The size of the handler pool used to process MQTT messages |
+|Type| int32 |
+|Default| 1 |
+|Effective| Trigger |
+
+* mqtt\_payload\_formatter
+
+| Name | mqtt\_payload\_formatter |
+|:-----------:|:-------------------------------|
+| Description | MQTT message payload formatter |
+| Type | String |
+| Default | JSON |
+| Effective | Trigger |
+
+* mqtt\_max\_message\_size
+
+| Name | mqtt\_max\_message\_size |
+|:------:|:-----------------------------------------|
+| Description | Maximum length of MQTT message in bytes |
+| Type | int32 |
+| Default | 1048576 |
+| Effective | Trigger |
+
### REST Service Configuration
+* enable_rest_service
+
+|Name| enable_rest_service |
+|:---:|:--------------------------------------|
+|Description| Whether to enable the Rest service |
+|Type| Boolean |
+|Default| false |
+|Effective| After restarting system |
+
+* rest_service_port
+
+|Name| rest_service_port |
+|:---:|:------------------|
+|Description| The Rest service listens to the port number |
+|Type| int32 |
+|Default| 18080 |
+|Effective| After restarting system |
+
+* enable_swagger
+
+|Name| enable_swagger |
+|:---:|:-----------------------|
+|Description| Whether to enable swagger to display rest interface information |
+|Type| Boolean |
+|Default| false |
+|Effective| After restarting system |
+
+* rest_query_default_row_size_limit
+
+|Name| rest_query_default_row_size_limit |
+|:---:|:------------------------------------------------------------------------------------------|
+|Description| The maximum number of rows in a result set that can be returned by a query |
+|Type| int32 |
+|Default| 10000 |
+|Effective| After restarting system |
+
+* cache_expire
+
+|Name| cache_expire |
+|:---:|:--------------------------------------------------------|
+|Description| Expiration time for caching customer login information |
+|Type| int32 |
+|Default| 28800 |
+|Effective| After restarting system |
+
+* cache_max_num
+
+|Name| cache_max_num |
Review Comment:
```suggestion
|Name| cache\_max\_num |
```
--
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: reviews-unsubscribe@iotdb.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org