Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

chore: add monitoring documentation #173

Merged
merged 3 commits into from
Oct 19, 2023
Merged

chore: add monitoring documentation #173

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a937c96
chore: add monitoring documentation
Phil91 Oct 15, 2023
cb53ee8
chore: update dependencies
Phil91 Oct 16, 2023
c757efe
chore: fix typo
Phil91 Oct 19, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion DEPENDENCIES
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 5 additions & 1 deletion developer/Technical Documentation/Architecture/operational-concept.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
evegufy marked this conversation as resolved.
Show resolved Hide resolved

- 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