rust: add the display example

Add a log parser,
a mqtt client
and a web server.

Signed-off-by: Frédéric Gardes <frederic.gardes@orange.com>

Author: tigroo

rust/README.md

@@ -404,6 +404,31 @@ it requires an OTLP collector as mentioned in the telemetry example section.
 cargo run --example collector --features telemetry
 ```
 
+### display
+
+Minimal viewer pipeline to parse logs or read live MQTT into a SQLite DB and display tiles on a map.
+
+Parse historical logs (handles .log, .log.gz, .tar.gz); it takes three positional
+arguments: the input directory, the quadkey zoom level and the output database path:
+
+```shell
+cargo run --example display_log_reader -- /logs 18 /tmp/display.db
+```
+
+Ingest from MQTT messages:
+
+```shell
+cargo run --example display_mqtt_reader -- --config examples/config.ini
+```
+
+Serve the map UI:
+
+```shell
+cargo run --example display_server -- --config examples/config.ini
+```
+
+Open the map at http://localhost:3000/ and zoom to display the message metrics.
+
 [1]: https://github.com/Orange-OpenSource/its-client/actions/workflows/rust.yml
 
 [2]: https://crates.io/crates/libits-client

rust/examples/config.ini

@@ -7,7 +7,7 @@
 #username = username
 #password = password
 
-# mqtt settings
+# MQTT client
 [mqtt]
 # broker host to connect to
 host = test.mosquitto.org
@@ -19,6 +19,8 @@ use_tls = true
 use_websocket = false
 # client id to provide at the connection
 client_id = com_app_its-client-1
+# optional, path to a CA bundle (PEM). Default: system store
+#ca_path = /etc/ssl/certs/ca-certificates.crt
 # optional, connection timeout
 connection_timeout = 60
 # optional, ACL username
@@ -61,15 +63,14 @@ use_tls = false
 # optional, basic auth password
 #password = password
 
-# collector example custom settings
-# See: Configuration:custom_settings
-# See: Configuration:get
+# receiver (subscription) settings
 [receiver]
 # optional, list of topic (with a comma ',' separator) to subscribe to, default to "#"
 #topic_list = "test/topic1","test/topic2"
 # optional, topic level number to put together into the router
 #route_level = 2
 
+# collector example custom settings
 [exporter]
 # optional, true to export the received messages to the console, default to false
 #stdout = true
@@ -99,7 +100,14 @@ client_id = com_app_its-exporter-1
 #username = username
 # optional, ACL password
 #password = password
-# optional, list of topic level to update with its new value.
-# e.g. with "1=another/source","3=replaced":
-# "/my/specific/original/topic" => "another/source/specific/replaced/topic`
-topic_level_update_list = "1=collector"
+# optional, list of topic levels to rewrite
+#topic_level_update_list = "1=collector"
+
+# display example custom settings
+[display]
+# path to the SQLite database
+db_path = examples/display.db
+# quadkey zoom (ingestor only)
+zoom = 18
+# web server port (server only)
+port = 3000