From a937c964e725ff01cd71996d2b87979673a08d9d Mon Sep 17 00:00:00 2001 From: Phil Schneider Date: Sun, 15 Oct 2023 17:12:07 +0200 Subject: [PATCH 1/3] chore: add monitoring documentation Refs: CPLP-3332 --- .../Architecture/operational-concept.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/developer/Technical Documentation/Architecture/operational-concept.md b/developer/Technical Documentation/Architecture/operational-concept.md index a6dedf24..b8276c68 100644 --- a/developer/Technical Documentation/Architecture/operational-concept.md +++ b/developer/Technical Documentation/Architecture/operational-concept.md @@ -27,4 +27,8 @@ Note: will be added soon The portal supports application and db logging. Details are stored here: https://github.com/catenax-ng/tx-portal-assets/blob/945546d91065b8870aa8f69ce94b48eac7a5ade2/docs/Technical%20Details/Auditing.md ## Monitoring -Note: Prometheus and Grafana are planned +Currently all backend services writes log entries as structural data in json format. These logs can easily be monitored. There are several options to provide a stable monitoring solution, one of them is to setup loki and grafana. In this solutions loki is used as a datasource and custom dashboards can be setup in grafana to monitor the services. Some general Properties to query with grafana are: + +- StatusCode - contains the status code of the response +- Elapsed - contains the time a endpoint took to response in milliseconds +- RenderedMessage - contains the log message with possible errors From cb53ee80ff8606241d51c6ab22d510bfa97d0853 Mon Sep 17 00:00:00 2001 From: Phil Schneider Date: Mon, 16 Oct 2023 09:51:52 +0200 Subject: [PATCH 2/3] chore: update dependencies Refs: CPLP-3332 --- DEPENDENCIES | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/DEPENDENCIES b/DEPENDENCIES index 899ee0bd..7828ba0e 100644 --- a/DEPENDENCIES +++ b/DEPENDENCIES @@ -48,7 +48,7 @@ npm/npmjs/-/find-replace/3.0.0, MIT, approved, clearlydefined npm/npmjs/-/follow-redirects/1.15.3, MIT, approved, #10782 npm/npmjs/-/forwarded/0.2.0, MIT, approved, clearlydefined npm/npmjs/-/fresh/0.5.2, MIT, approved, clearlydefined -npm/npmjs/-/function-bind/1.1.1, MIT, approved, clearlydefined +npm/npmjs/-/function-bind/1.1.1, MIT, approved, #11063 npm/npmjs/-/get-caller-file/2.0.5, ISC, approved, clearlydefined npm/npmjs/-/get-intrinsic/1.2.1, MIT, approved, #8453 npm/npmjs/-/has-flag/3.0.0, MIT, approved, clearlydefined From c757efe92486cd180b624a32dcfff874dfd9851a Mon Sep 17 00:00:00 2001 From: Phil Schneider Date: Thu, 19 Oct 2023 08:16:05 +0200 Subject: [PATCH 3/3] chore: fix typo Refs: CPLP-3332 --- .../Technical Documentation/Architecture/operational-concept.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/developer/Technical Documentation/Architecture/operational-concept.md b/developer/Technical Documentation/Architecture/operational-concept.md index b8276c68..668ab572 100644 --- a/developer/Technical Documentation/Architecture/operational-concept.md +++ b/developer/Technical Documentation/Architecture/operational-concept.md @@ -27,7 +27,7 @@ Note: will be added soon The portal supports application and db logging. Details are stored here: https://github.com/catenax-ng/tx-portal-assets/blob/945546d91065b8870aa8f69ce94b48eac7a5ade2/docs/Technical%20Details/Auditing.md ## Monitoring -Currently all backend services writes log entries as structural data in json format. These logs can easily be monitored. There are several options to provide a stable monitoring solution, one of them is to setup loki and grafana. In this solutions loki is used as a datasource and custom dashboards can be setup in grafana to monitor the services. Some general Properties to query with grafana are: +Currently all backend services write log entries as structural data in json format. These logs can easily be monitored. There are several options to provide a stable monitoring solution, one of them is to setup loki and grafana. In this solution loki is used as a datasource and custom dashboards can be setup in grafana to monitor the services. Some general Properties to query with grafana are: - StatusCode - contains the status code of the response - Elapsed - contains the time a endpoint took to response in milliseconds