dlt_log 0.1.0

Log crate adapter for integrating with the Diagnostic Log and Trace (DLT) system
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61

# `log` crate adapter for DLT

`dlt_log` is a `log` crate adapter for integrating with the Diagnostic Log and Trace (DLT) system. It provides functionality to register applications and contexts with the DLT daemon and implements a logger that sends log messages to the DLT system. The library is designed to be used with the standard `log` crate, which provides a flexible logging API for Rust applications.

The DLT system is a flexible and scalable logging framework that is widely used in the automotive industry for logging and tracing in embedded systems. It provides features such as log level filtering, message formatting, and log message buffering. For more information about DLT, see the [DLT project on GitHub](https://github.com/COVESA/dlt-daemon).

![Example logs in DLT viewer](https://github.com/rusty-projects/dlt_log-rs/blob/main/doc/dlt-viewer-example.png)

## Usage

To use this library, you need to initialize it with your application and context information. This will register your application and context with the DLT daemon and set up the logger.

```rust
fn main() {
    let _ = dlt_log::init("APID", "Application Description", "CTID", "Context Description");

    log::info!("This is an info message");
}
```

## Log levels

The log levels and logging backend are configured by the DLT system. For configuration, follow the [DLT documentation](https://github.com/COVESA/dlt-daemon/blob/master/doc/dlt_for_developers.md).

For example, to enable all log levels, set the `DLT_INITIAL_LOG_LEVEL` environment variable to `::6`.

```bash
DLT_INITIAL_LOG_LEVEL="::6" cargo run --example simple
```

## Output

By default, the log messages are sent to the DLT daemon. To view the logs, you can use the DLT viewer tool provided by the DLT daemon. The logs can also be redirected to the console by setting the `DLT_LOCAL_PRINT_MODE` environment variable to `FORCE_ON`.

```bash
DLT_LOCAL_PRINT_MODE=FORCE_ON DLT_INITIAL_LOG_LEVEL="::6" cargo run --example simple
```

The output will look like this:

```text
2025/01/21 19:12:22.090974   28995094 000 ECU1 TEST EXPL log verbose V 1 [Tracing the untraceable!]
2025/01/21 19:12:22.091176   28995096 001 ECU1 TEST EXPL log debug V 1 [Debugging the debugger!]
2025/01/21 19:12:22.091248   28995097 002 ECU1 TEST EXPL log info V 1 [Information overload: 2 + 2 = 4]
2025/01/21 19:12:22.091284   28995097 003 ECU1 TEST EXPL log warn V 1 [Warning: Low on coffee!]
2025/01/21 19:12:22.091336   28995097 004 ECU1 TEST EXPL log error V 1 [Error: Something went terribly right!]
```

## Errors

The library defines an `InitializeError` enum to represent possible errors that can occur during initialization. These include conversion errors, logger errors, and DLT library errors.

## Integration

The integration with the DLT system is achieved through the `libdlt` module, which provides FFI (Foreign Function Interface) bindings to the underlying C library for DLT. The `bindgen` tool is used to generate these bindings. The bindings are generated during the build process in order to ensure that the Rust code remains in sync with the system's DLT library.

## License

This project is licensed under the MIT License - see the [LICENSE](https://github.com/rusty-projects/dlt_log-rs/blob/main/LICENSE) file for details.

License information for DLT daemon and library can be found at [Diagnostic Log and Trace](https://github.com/COVESA/dlt-daemon#license).