|
|
@@ -47,15 +47,30 @@ In out tutorial, we will use [Random Integer Device Service](https://github.com/
|
|
|
After the EdgeX Geneva is offcially released, you can just follow steps in [this doc](https://fuji-docs.edgexfoundry.org/Ch-QuickStart.html) to start the service. But now since Kuiper has not been official released yet, you have to download Docker composer file from [here](https://github.com/edgexfoundry/developer-scripts/blob/master/releases/nightly-build/compose-files/docker-compose-nexus-mongo-no-secty.yml), and then bring up EdgeX Docker instances.
|
|
|
|
|
|
```shell
|
|
|
-# wget https://github.com/edgexfoundry/developer-scripts/raw/master/releases/nightly-build/compose-files/docker-compose-nexus-mongo-no-secty.yml
|
|
|
+$ wget https://github.com/edgexfoundry/developer-scripts/raw/master/releases/nightly-build/compose-files/docker-compose-nexus-mongo-no-secty.yml
|
|
|
|
|
|
-# docker-compose -f ./docker-compose-nexus-redis-no-secty.yml up -d --build
|
|
|
+$ docker-compose -f ./docker-compose-nexus-redis-no-secty.yml up -d --build
|
|
|
```
|
|
|
|
|
|
After all of the Docker instances are started, you can use ``docker ps`` command to verify all of services are runnings correctly.
|
|
|
|
|
|
-```
|
|
|
-TODO: The docker instance list
|
|
|
+```shell
|
|
|
+$ docker ps
|
|
|
+CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
|
|
|
+5618c93027a9 nexus3.edgexfoundry.org:10004/docker-device-virtual-go:master "/device-virtual --p…" 37 minutes ago Up 37 minutes 0.0.0.0:49990->49990/tcp edgex-device-virtual
|
|
|
+fabe6b9052f5 nexus3.edgexfoundry.org:10004/docker-edgex-ui-go:master "./edgex-ui-server" 37 minutes ago Up 37 minutes 0.0.0.0:4000->4000/tcp edgex-ui-go
|
|
|
+83ef687fe546 emqx/kuiper:0.2.1 "/usr/bin/docker-ent…" 37 minutes ago Up 37 minutes 0.0.0.0:9081->9081/tcp, 0.0.0.0:20498->20498/tcp, 9801/tcp edgex-kuiper
|
|
|
+c49b0d6f9347 nexus3.edgexfoundry.org:10004/docker-support-scheduler-go:master "/support-scheduler …" 37 minutes ago Up 37 minutes 0.0.0.0:48085->48085/tcp edgex-support-scheduler
|
|
|
+4265dcc2bb48 nexus3.edgexfoundry.org:10004/docker-core-command-go:master "/core-command -cp=c…" 37 minutes ago Up 37 minutes 0.0.0.0:48082->48082/tcp edgex-core-command
|
|
|
+4667160e2f41 nexus3.edgexfoundry.org:10004/docker-app-service-configurable:master "/app-service-config…" 37 minutes ago Up 37 minutes 48095/tcp, 0.0.0.0:48100->48100/tcp edgex-app-service-configurable-rules
|
|
|
+9bbfe95993f5 nexus3.edgexfoundry.org:10004/docker-core-metadata-go:master "/core-metadata -cp=…" 37 minutes ago Up 37 minutes 0.0.0.0:48081->48081/tcp, 48082/tcp edgex-core-metadata
|
|
|
+2e342a3aae81 nexus3.edgexfoundry.org:10004/docker-support-notifications-go:master "/support-notificati…" 37 minutes ago Up 37 minutes 0.0.0.0:48060->48060/tcp edgex-support-notifications
|
|
|
+3cfc628e013a nexus3.edgexfoundry.org:10004/docker-sys-mgmt-agent-go:master "/sys-mgmt-agent -cp…" 37 minutes ago Up 37 minutes 0.0.0.0:48090->48090/tcp edgex-sys-mgmt-agent
|
|
|
+f69e9c4d6cc8 nexus3.edgexfoundry.org:10004/docker-core-data-go:master "/core-data -cp=cons…" 37 minutes ago Up 37 minutes 0.0.0.0:5563->5563/tcp, 0.0.0.0:48080->48080/tcp edgex-core-data
|
|
|
+9e5091928409 nexus3.edgexfoundry.org:10004/docker-support-logging-go:master "/support-logging -c…" 37 minutes ago Up 37 minutes 0.0.0.0:48061->48061/tcp edgex-support-logging
|
|
|
+74e8668f892c redis:5.0.7-alpine "docker-entrypoint.s…" 37 minutes ago Up 37 minutes 0.0.0.0:6379->6379/tcp edgex-redis
|
|
|
+9b341bb217f9 consul:1.3.1 "docker-entrypoint.s…" 37 minutes ago Up 37 minutes 0.0.0.0:8400->8400/tcp, 8300-8302/tcp, 8301-8302/udp, 8600/tcp, 8600/udp, 0.0.0.0:8500->8500/tcp edgex-core-consul
|
|
|
+ed7ad5ae08b2 nexus3.edgexfoundry.org:10004/docker-edgex-volume:master "/bin/sh -c '/usr/bi…" 37 minutes ago Up 37 minutes edgex-files
|
|
|
```
|
|
|
|
|
|
### Create a stream
|
|
|
@@ -64,11 +79,11 @@ There are two approaches to manage stream, you can use your preferred approach.
|
|
|
|
|
|
#### Option 1: Use Rest API
|
|
|
|
|
|
-The next step is to create a stream that can consume data from EdgeX message bus. Please change ``$your_server`` to Kuiper docker instance IP address.
|
|
|
+The next step is to create a stream that can consume data from EdgeX message bus. Please change ``$kuiper_docker`` to Kuiper docker instance IP address.
|
|
|
|
|
|
```shell
|
|
|
curl -X POST \
|
|
|
- http://$TODO:9081/streams \
|
|
|
+ http://$kuiper_docker:9081/streams \
|
|
|
-H 'Content-Type: application/json' \
|
|
|
-d '{
|
|
|
"sql": "create stream demo() WITH (FORMAT=\"JSON\", TYPE=\"edgex\")"
|
|
|
@@ -82,7 +97,7 @@ For other Rest APIs, please refer to [this doc](../restapi/overview.md).
|
|
|
Run following command to enter the running Kuiper docker instance.
|
|
|
|
|
|
```shell
|
|
|
-docker exec -it kuiper /bin/sh
|
|
|
+docker exec -it edgex-kuiper /bin/sh
|
|
|
```
|
|
|
|
|
|
Use following command to create a stream named ``demo``.
|
|
|
@@ -114,17 +129,17 @@ For more detailed information of configuration file, please refer to [this doc](
|
|
|
|
|
|
Let's create a rule that send result data to an MQTT broker, for detailed information of MQTT sink, please refer to [this link](../rules/sinks/mqtt.md). Similar to create a stream, you can also choose REST or CLI to manage rules.
|
|
|
|
|
|
-So the below rule will filter all of ``randomnumber`` that is less than 31. The sink result will be published to topic ``result`` of public MQTT broker ``broker.emqx.io``.
|
|
|
+So the below rule will get all of values from ``event`` topic. The sink result will be published to topic ``result`` of public MQTT broker ``broker.emqx.io``.
|
|
|
|
|
|
#### Option 1: Use Rest API
|
|
|
|
|
|
```shell
|
|
|
curl -X POST \
|
|
|
- http://$TODO:9081/rules \
|
|
|
+ http://$kuiper_docker:9081/rules \
|
|
|
-H 'Content-Type: application/json' \
|
|
|
-d '{
|
|
|
"id": "rule1",
|
|
|
- "sql": "SELECT * FROM demo WHERE randomnumber > 30",
|
|
|
+ "sql": "SELECT * FROM demo",
|
|
|
"actions": [
|
|
|
{
|
|
|
"mqtt": {
|
|
|
@@ -159,7 +174,7 @@ You can create a rule file with any text editor, and copy following contents int
|
|
|
In the running Kuiper instance, and execute following command.
|
|
|
|
|
|
```shell
|
|
|
-# bin/cli create rule rule1 -f rule.txt
|
|
|
+$ bin/cli create rule rule1 -f rule.txt
|
|
|
Connecting to 127.0.0.1:20498...
|
|
|
Creating a new rule from file rule.txt.
|
|
|
Rule rule1 was created, please use 'cli getstatus rule $rule_name' command to get rule status.
|
|
|
@@ -172,7 +187,23 @@ If you want to send analysis result to another sink, please refer to [other sink
|
|
|
Now you can also take a look at the log file under ``log/stream.log``, see detailed info of rule.
|
|
|
|
|
|
```
|
|
|
-//TODO
|
|
|
+time="2020-04-07T03:33:28Z" level=info msg="db location is /kuiper/data/"
|
|
|
+time="2020-04-07T03:33:28Z" level=info msg="Starting rules"
|
|
|
+time="2020-04-07T03:33:28Z" level=info msg="Serving kuiper (version - 0.2.1) on port 20498, and restful api on port 9081. \n"
|
|
|
+time="2020-04-07T03:35:35Z" level=info msg="Rule rule1 is created."
|
|
|
+time="2020-04-07T03:35:35Z" level=info msg="Init rule with options {isEventTime: false, lateTolerance: 0, concurrency: 1, bufferLength: 1024"
|
|
|
+time="2020-04-07T03:35:35Z" level=info msg="Opening stream" rule=rule1
|
|
|
+time="2020-04-07T03:35:35Z" level=info msg="open source node demo with option map[FORMAT:JSON TYPE:edgex]" rule=rule1
|
|
|
+time="2020-04-07T03:35:35Z" level=info msg="open sink node 1 instances" rule=rule1
|
|
|
+time="2020-04-07T03:35:35Z" level=info msg="open source node 1 instances" rule=rule1
|
|
|
+time="2020-04-07T03:35:35Z" level=info msg="Opening mqtt sink for rule rule1." rule=rule1
|
|
|
+time="2020-04-07T03:35:35Z" level=info msg="Connect to value descriptor service at: http://edgex-core-data:48080/api/v1/valuedescriptor \n"
|
|
|
+time="2020-04-07T03:35:35Z" level=info msg="Use configuration for edgex messagebus {{ 0 } {edgex-core-data 5563 tcp} zero map[]}\n"
|
|
|
+time="2020-04-07T03:35:35Z" level=info msg="Start source demo instance 0 successfully" rule=rule1
|
|
|
+time="2020-04-07T03:35:35Z" level=info msg="The connection to edgex messagebus is established successfully." rule=rule1
|
|
|
+time="2020-04-07T03:35:35Z" level=info msg="Connect MQTT broker with username and password." rule=rule1
|
|
|
+time="2020-04-07T03:35:35Z" level=info msg="Successfully subscribed to edgex messagebus topic events." rule=rule1
|
|
|
+time="2020-04-07T03:35:35Z" level=info msg="The connection to server tcp://broker.emqx.io:1883 was established successfully" rule=rule1
|
|
|
```
|
|
|
|
|
|
### Monitor analysis result
|
|
|
@@ -180,12 +211,23 @@ Now you can also take a look at the log file under ``log/stream.log``, see detai
|
|
|
Since all of the analysis result are published to ``tcp://broker.emqx.io:1883``, so you can just use below ``mosquitto_sub`` command to monitor the result. You can also use other [MQTT client tools](https://www.emqx.io/blog/mqtt-client-tools).
|
|
|
|
|
|
```shell
|
|
|
-# mosquitto_sub -h broker.emqx.io -t result
|
|
|
-//TODO
|
|
|
+$ mosquitto_sub -h broker.emqx.io -t result
|
|
|
+[{"bool":true}]
|
|
|
+[{"bool":false}]
|
|
|
+[{"bool":true}]
|
|
|
+[{"randomvalue_int16":3287}]
|
|
|
+[{"float64":8.41326e+306}]
|
|
|
+[{"randomvalue_int32":-1872949486}]
|
|
|
+[{"randomvalue_int8":-53}]
|
|
|
+[{"int64":-1829499332806053678}]
|
|
|
+[{"int32":-1560624981}]
|
|
|
+[{"int16":8991}]
|
|
|
+[{"int8":-4}]
|
|
|
+[{"bool":true}]
|
|
|
+[{"bool":false}]
|
|
|
+[{"float64":1.737076e+306}]
|
|
|
```
|
|
|
|
|
|
-You'll find that only those randomnumber larger than 30 will be published to ``result`` topic.
|
|
|
-
|
|
|
You can also type below command to look at the rule execution status. The corresponding REST API is also available for getting rule status, please check [related document](../restapi/overview.md).
|
|
|
|
|
|
```shell
|
|
|
@@ -231,16 +273,7 @@ In this tutorial, we introduce a very simple use of EdgeX Kuiper rule engine. I
|
|
|
|
|
|
### More Excecise
|
|
|
|
|
|
-Current rule does not filter any data that are sent to Kuiper, so how to filter data? For example, if you only concern ``Int32`` field value that are great than 30. Please [drop rule](../cli/rules.md) and change the SQL in previous rule file as following.
|
|
|
-
|
|
|
-```
|
|
|
-{
|
|
|
- "sql": "SELECT * from demo WHERE Int32 > 30",
|
|
|
- "actions": [...]
|
|
|
-}
|
|
|
-```
|
|
|
-
|
|
|
-After update the rule file, and then deploy the rule again. Please monitor the result topic of MQTT broker, you will find that only ``Int32`` field value that are great than 30 will be sent out.
|
|
|
+Current rule does not filter any data that are sent to Kuiper, so how to filter data? Please [drop rule](../cli/rules.md) and change the SQL in previous rule accordingly. After update the rule file, and then deploy the rule again. Please monitor the result topic of MQTT broker, and please verify see if the rule works or not.
|
|
|
|
|
|
#### Extended Reading
|
|
|
|
RockyJin