Jingga/User-Guide
1
0
Fork 0
mirror of https://github.com/Karaka-Management/User-Guide.git synced 2026-01-11 12:28:40 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Monitoring draft

Browse Source
This commit is contained in:
Dennis Eichhorn 2016-07-29 16:56:20 +02:00
parent 9221dddf2f
commit 0944eb0869
1 changed files with 15 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
maintenance/monitoring.md
View File

@ -0,0 +1,15 @@
# Monitoring
## Internal
The application provides activity monitoring through error logging as well as activity logging.
### Error Logging
The error logging creates log entries whenever an error occures. These error logs contain specific information about what, when, where and who caused the error. These error messages indicate that something is not working as intended and require immediate attention. These errors however are not known to the development team since they are application specific; in order to inform the development team that there is an error it's possible to forward this error via a simple click of a button. This error can now get inspected and fixed. Make sure to report all errors so that they can get fixed. Errors that appear because of changes in the source code will be ignored since customer or third party code changes are not supported or allowed.
### Activity Logging
The activity logging is used by modules in order to log user and system activities such as changes/updates to existing elements or the creation and deletion of elements. Elements in this context referes to all database data and state changes. These logs are important in order to investigate changes by certain people or to certain elements. Activity logs can be an important factor for audits as they prove that all changes can be inspected, supervised and tracked back. These log files can be used for complience reports as well as approval reports where certain activities need to be approved. While there are modules like the `Workflow` module which allow pre-approval in some cases a post-approval may be necessary and in these situations these logs can be used to generate a report which then can be approved.
## External