Merge branch 'add_diagram_to_readme' into 'no-masters'

add graph to README, visualizing the pipeline

See merge request !9

README.md

@@ -2,6 +2,41 @@
 
 This repository contains several services for parsing and evaluating field test results put together in a docker compose setup. The _dashboard_ service runs a plotly dashboard on port 8050. Before starting up, it will parse all logs saved in the directory that's specified as an environment variable (`LOG_DIRECTORY`) and mounted as a docker volume. The results are saved to a csv-file in the `results` subdirectory. This file is the basis of the plotly dashboard. It is updated by the _file-monitor_ service that checks for changes in this directory, parses new logs that have been uploaded, and next to writing the results in the csv file, also pushes them to _prometheus_ using the _prometheus-pushgateway_. They are then scraped by _grafana_ and visualized in a dashboard that runs on port 3000.
 
+```mermaid
+graph LR;
+
+    subgraph A [Field Tests]
+        A1[contains raw logs of stdout and stderr]
+    end
+
+    subgraph S [ ]
+
+    subgraph B [logs/*.txt]
+        B1[saved to storage]
+    end
+
+    subgraph C [parse_log.py]
+        C1[parses metrics from raw data]
+    end
+
+    subgraph D [metrics_all_logs.csv]
+        D1[metric data in a reusable CSV fromat]
+    end
+
+    subgraph E [Prometheus Metrics]
+        E1[source for monitoring visualization]
+    end
+    end
+
+    A --> B;
+    B --> C;
+    C --> E;
+    C --> D;
+    E --> F[Grafana];
+    D --> G[Plotly]
+```
+
+
 ## 1. Prerequisites
 
 You need to have docker (including docker compose) installed.