Skip to content

Commit e89fa3d

Browse files
committed
rust: enhance README.md
Signed-off-by: Nicolas Buffon <nicolas.buffon@orange.com>
1 parent 9fe0273 commit e89fa3d

1 file changed

Lines changed: 29 additions & 8 deletions

File tree

rust/README.md

Lines changed: 29 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,22 @@
1-
libits
2-
======
1+
libits-client
2+
=============
33

44
[![Build Status](https://github.com/Orange-OpenSource/its-client/workflows/Rust/badge.svg)][1]
55
[![crates.io](https://img.shields.io/crates/v/its-client)][2]
66

7-
The Intelligent Transportation Systems (ITS) [MQTT][3] Rust package based on
8-
the [JSON][4] [ETSI][5] specification transcription.
7+
MQTv5
8+
TELEMETRY
9+
910

1011
Examples
1112
--------
1213

13-
By default, all example logs into `./log/<example>_rCURRENT.log`
14-
You can inspect the logs using `tail -F log/its-client_rCURRENT.log`
15-
1614
### json_counter
1715

18-
Subscribes to `test.mosquitto.org` and yields how much messages were received and the number of them that had JSON payload
16+
Demonstrates how to use the IoT3 message exchange feature.
17+
18+
Subscribes to `test.mosquitto.org` and yields how much messages were received
19+
and the number of them whose payload is in JSON.
1920

2021
```
2122
cargo run --example json_counter
@@ -26,10 +27,30 @@ Logs are redirected to a file
2627
tail -F log/json_counter_rCURRENT.log
2728
```
2829

30+
### telemetry
31+
32+
This example describes how to send OpenTelemetry traces and how to transmit W3C context to link spans between traces.
33+
34+
We don't expose any public OTLP collector (yet?), so you either have to:
35+
- use one of your own already available
36+
or
37+
- spawn one
38+
```
39+
docker run ... TODO
40+
```
41+
In any case, before running the example, you must edit the `[telemetry]` section of configuration
42+
with the proper values.
43+
Then you can run the example:
44+
```
45+
cargo run --example telemetry --features telemetry
46+
```
47+
2948
### copycat
3049

3150
Subscribes to ITS CAM and CPM messages, stores them and sends a copy 3 seconds later
3251

52+
TODO telemetry link propagation through user properties
53+
3354
[1]: https://github.com/Orange-OpenSource/its-client/actions/workflows/rust.yml
3455
[2]: https://crates.io/crates/its-client
3556
[3]: https://mqtt.org/

0 commit comments

Comments
 (0)