cosmetic fixes.

Signed-off-by: Tomoya.Fujita <[email protected]>
fujitatomoya · Sep 6, 2024 · ca17d85 · ca17d85
1 parent 6e2d7be
commit ca17d85
Show file tree

Hide file tree

Showing 2 changed files with 34 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -24,8 +24,18 @@ So that user can choose the logging configuration depending on the application r
 
 See how it works 🔥
 
+- rsyslog / FluebtBit
+
 https://github.com/user-attachments/assets/bdb05bf7-92b2-4b9a-8f20-3d3b803a7a86
 
+- rsyslog / Fluentd / Loki / Grafana
+
+https://github.com/user-attachments/assets/4a1aae42-5c55-4f31-9198-8c7c246244ca
+
+## Tutorials
+
+- [How to integrate with Fluentd / Loki / Grafana](./doc/tutorials/Fluentd_Loki_Grafana.md)
+
 ## Supported [ROS Distribution](https://docs.ros.org/en/rolling/Releases.html)
 
 | Distribution      | Supported | Note |

diff --git a/doc/tutorials/Fluentd_Loki_Grafana.md b/doc/tutorials/Fluentd_Loki_Grafana.md
@@ -1,5 +1,29 @@
 # How to forward the ros2 log data to [Fluentd](https://www.fluentd.org/) / [Loki](https://grafana.com/oss/loki/) / [Grafana](https://grafana.com/oss/grafana/)
 
+## Overview
+
+```text
+                   +------------------------------------------------+
+                   |                                                |
+                   |   +---------+                                  |
++--------+ 514/udp |   |         |                                  |
+| client +------------->         |                                  |
++--------+         |   |         |                                  |
+                   |   | rsyslog |                                  |
++--------+ 514/udp |   |         |                                  |
+| client +------------->         |                                  |
++--------+         |   |         |                                  |
+                   |   +----+----+                                  |
+                   |        |                                       |
+                   |        | 5514/tcp                              |
+                   |        |                                   http/3000
+                   |   +----v-----+  +----------+  +------------+   |  +-----------+
+                   |   | fluentd  +-->   loki   +-->  grafana   +------>  Browser  |
+                   |   +----------+  +----------+  +------------+   |  +-----------+
+                   |                   http/3100                    |
+                   +------------------------------------------------+
+```
+
 ## Installation
 
 - [Loki](https://grafana.com/oss/loki/) / [Grafana](https://grafana.com/oss/grafana/)