Skip to content

Commit 2b4f547

Browse files
logging: add README for logging example
1 parent 5e6bbcb commit 2b4f547

4 files changed

Lines changed: 80 additions & 0 deletions

File tree

showcases/logging/README.md

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
# Logging Showcase Example
2+
3+
## Overview
4+
5+
This showcase demonstrates the logging capabilities.
6+
7+
A new **Logging example** has been added to the showcase launcher. When running:
8+
9+
```bash
10+
./score_starter
11+
```
12+
13+
select **Logging example** from the menu to start the application.
14+
15+
The example generates log messages with different severity levels and demonstrates both local and remote logging.
16+
17+
---
18+
19+
## What the Example Shows
20+
21+
The application produces logs for the following levels:
22+
23+
- DEBUG
24+
- INFO
25+
- WARN
26+
- ERROR
27+
- FATAL
28+
29+
These logs can be viewed in the console as well as through remote logging tools.
30+
31+
---
32+
## Remote Logging
33+
34+
The example forwards logs through DataRouter.
35+
36+
For remote logging:
37+
38+
- Log messages are sent to the multicast IP address `239.255.42.99` and port configured in `log-channels.json`.
39+
- Select the appropriate network interface depending on the environment where the showcase is running. For example, if running the showcase in a Linux x86 Docker environment, use the Docker network interface
40+
- DataRouter receives the log stream and exposes it through the default DLT port (`3490`).
41+
- Logs can be viewed by connecting DLT Viewer or Chipmunk to the configured DataRouter endpoint.
42+
43+
44+
### DLT Viewer
45+
46+
DLT Viewer Configuration
47+
48+
<img src="images/dlt-viewer.png" alt="DLT Viewer Configuration" width="800">
49+
50+
### Chipmunk
51+
52+
Configure Chipmunk using the same network settings.
53+
54+
<img src="images/chipmunk.png" alt="Chipmunk Configuration" width="800">
55+
56+
Once connected, the incoming log stream can be monitored in real time.
57+
58+
---
59+
60+
## Verification
61+
62+
Verify that:
63+
64+
- The Logging example starts successfully.
65+
- DEBUG messages are received.
66+
- INFO messages are received.
67+
- WARN messages are received.
68+
- ERROR messages are received.
69+
- FATAL messages are received.
70+
- Logs are visible in DLT Viewer.
71+
- Logs are visible in Chipmunk.
72+
- Remote log forwarding through DataRouter is working correctly.
73+
74+
---
75+
76+
## Example Log Output
77+
78+
### Chipmunk Logs
79+
80+
<img src="images/chipmunk-log.png" alt="Chipmunk Logs" width="800">
316 KB
Loading
46.1 KB
Loading
28.4 KB
Loading

0 commit comments

Comments
 (0)