docs: Add Audit logs usage and internal develop guide #786
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
zubeydecivelek
approved these changes
Jun 20, 2025
carlinmack
reviewed
Jun 20, 2025
carlinmack
reviewed
Jun 20, 2025
|
|
||
| ### Storage | ||
|
|
||
| To maintain consistency across storage backends, such as the database and the configured search backend (e.g., OpenSearch), the Unit of Work (UoW) pattern is used. This ensures that all operations, including creation, updates, and indexing, are handled transactionally, keeping the database and search indexes synchronized. |
There was a problem hiding this comment.
Suggested change
| To maintain consistency across storage backends, such as the database and the configured search backend (e.g., OpenSearch), the Unit of Work (UoW) pattern is used. This ensures that all operations, including creation, updates, and indexing, are handled transactionally, keeping the database and search indexes synchronized. | |
| The Unit of Work (UoW) pattern is used to maintain consistency across storage backends, such as the database and the configured search backend (e.g., OpenSearch). This ensures that all operations, including creation, updates, and indexing, are handled transactionally, keeping the database and search indexes synchronized. |
carlinmack
reviewed
Jun 20, 2025
|
|
||
| ### Permissions | ||
|
|
||
| Access to audit logs is controlled via the Invenio permissions system. Currently only the System User can create the audit log and administrators can read. The permissions can be updated in the permission policy class to extended, for example, providing read access to the logs to other user roles. |
There was a problem hiding this comment.
Suggested change
| Access to audit logs is controlled via the Invenio permissions system. Currently only the System User can create the audit log and administrators can read. The permissions can be updated in the permission policy class to extended, for example, providing read access to the logs to other user roles. | |
| Access to audit logs is controlled via the Invenio permissions system. Currently only the System User can create audit logs and administrators can read them. The permissions can be updated in the permission policy class to, for example, provide read access to other user roles. |
carlinmack
reviewed
Jun 20, 2025
carlinmack
reviewed
Jun 20, 2025
carlinmack
approved these changes
Jun 20, 2025
kpsherva
approved these changes
Jun 20, 2025
ntarocco
force-pushed
the
docs/add-audit-logs
branch
from
ce5bb9c to
b803fd8
Compare
fenekku
reviewed
Jun 25, 2025
| uow.register(AuditLogOp(CustomActionAuditLog.build(identity, resource_id, ...))) | ||
| ``` | ||
|
|
||
| By following these steps, you can extend the audit logging system to include custom actions tailored to your instance's needs. |
There was a problem hiding this comment.
placement notes: If the "How to track more actions" section is directed at instance operators, then it should be moved to the "Operate an Instance" section. Otherwise this can be reworded to tailored to your module's needs.
|
|
||
| ``` | ||
|
|
||
| 4. **Use the action in your module** |
There was a problem hiding this comment.
The numbered list resets to 1. for each paragraph when the page is rendered. There is some spacing that needs to be fixed to address that.
|
|
||
| The feature can be enabled by setting the `AUDIT_LOGS_ENABLED` flag to `True`. | ||
|
|
||
| ## Adminstration panel |
There was a problem hiding this comment.
placement: This should be moved and merged with the audit logs section in the "Use" section since it's really what this is about.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.