diff --git a/README.md b/README.md index b1befef99ae06ecc28324536ba87af69e813011b..fefea7245373fab546387e72bdab7751453db4ec 100644 --- a/README.md +++ b/README.md @@ -42,6 +42,33 @@ sudo docker run -d -p 5003:5003 xpokorn8/sprachschulsystem:mail ~~~ +# Metrics and Monitoring Dashboards +Our application uses Prometheus and Grafana to collect metrics and display them. +By running the app using commands for Running the modules using docker-compose mentioned above +Prometheus and Grafana containers are also launched. + +You can find the **Prometheus** interface on +http://localhost:9090 + +You can find **Grafana** interface on http://localhost:3000<br /> +The credentials are:<br /> +**username:** admin <br /> +**password:** admin <br /> + +In Grafana interface, you can import various dashboards. Our team used and tested https://grafana.com/grafana/dashboards/3662-prometheus-2-0-overview/ board.<br /> +To import the dashboard, follow steps bellow: + + +Select **+** and **Import** in left menu of the Grafana interface. + + +Insert **3662** into **Import via grafana.com** and click **Load**. + + +Select **Prometheus** in the **prometheus** combo box and click **Import**. + + +The dashboard with metrics data will be displayed. # Project Description diff --git a/docs/grafana01.png b/docs/grafana01.png new file mode 100644 index 0000000000000000000000000000000000000000..8e58621aadab9eb69f2e6e92edec636586d51c64 Binary files /dev/null and b/docs/grafana01.png differ diff --git a/docs/grafana02.png b/docs/grafana02.png new file mode 100644 index 0000000000000000000000000000000000000000..1884374cb3557c3f796f9af6a431b0e80bd3d251 Binary files /dev/null and b/docs/grafana02.png differ diff --git a/docs/grafana03.png b/docs/grafana03.png new file mode 100644 index 0000000000000000000000000000000000000000..bae807f9c718fb1510e6069267d832d4ce325d94 Binary files /dev/null and b/docs/grafana03.png differ diff --git a/docs/grafana04.png b/docs/grafana04.png new file mode 100644 index 0000000000000000000000000000000000000000..21f3f2e3fcc95f420b5e320227f409c0aec8fd7c Binary files /dev/null and b/docs/grafana04.png differ