From a0c06d733d30e60e69f3e1782a0b3d8da3a28490 Mon Sep 17 00:00:00 2001 From: mmattel Date: Wed, 30 Nov 2022 16:24:57 +0100 Subject: [PATCH] update readme --- services/audit/README.md | 24 ++++++++++++++++++------ 1 file changed, 18 insertions(+), 6 deletions(-) diff --git a/services/audit/README.md b/services/audit/README.md index 18ca1cb924..8b17989a68 100644 --- a/services/audit/README.md +++ b/services/audit/README.md @@ -1,18 +1,30 @@ # Audit service -The audit service logs all events of the system as an audit log. Per default, it will be logged to standard out, but can also be configured to a file output. Supported log formats are json or a simple key-value pair like: +The audit service logs all events of the system as an audit log. Per default, it will be logged to standard out, but can also be configured to a file output. Supported log formats are json or a simple key-value pair. +With audit logs, you are able to prove compliance with corporate guidelines as well as to enable reporting and auditing of operations. The audit service takes note of actions conducted by users and administrators. + +Example key-value pairs: +``` file_delete) user 'user_id' trashed file 'item_id' file_trash_delete) user 'user_id' removed file 'item_id' from trashbin +``` -With audit logs you are able to prove compliance with corporate guidelines as well as to enable reporting and auditing of operations. The audit service takes note of actions conducted by users and administrators. +Example json: +``` +{"RemoteAddr":"","User":"user_id","URL":"","Method":"","UserAgent":"","Time":"","App":"admin_audit","Message":"user 'user_id' trashed file 'item_id'","Action":"file_delete","CLI":false,"Level":1,"Path":"path","Owner":"user_id","FileID":"item_id"} +{"RemoteAddr":"","User":"user_id","URL":"","Method":"","UserAgent":"","Time":"","App":"admin_audit","Message":"user 'user_id' removed file 'item_id' from trashbin","Action":"file_trash_delete","CLI":false,"Level":1,"Path":"path","Owner":"user_id","FileID":"item_id"} +``` -The service is not started automatically when running as single binary started via `ocis server` or when running as docker container and must be started and stopped manually on demand. +The autit service is not started automatically when running as single binary started via `ocis server` or when running as docker container and must be started and stopped manually on demand. The audit service logs: -- File system operations (create/delete/move; including actions on the trash bin and versioning) -- User management operations (creation/deletion of users) -- Sharing operations (user/group sharing, sharing via link, changing permissions, calls to sharing API from clients) +- File system operations +(create/delete/move; including actions on the trash bin and versioning) +- User management operations +(creation/deletion of users) +- Sharing operations +(user/group sharing, sharing via link, changing permissions, calls to sharing API from clients)