Skip to content

[docs] Document audit logging #306

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

Draft
Dimfacion wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

[docs] Document audit logging #306

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
171c579
[docs] Document audit logging
Dimfacion Jun 5, 2026
4c613d0
[docs] Document audit logging
Dimfacion Jun 5, 2026
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
15 changes: 15 additions & 0 deletions docs/deployment/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,21 @@ certificates in the folder are public PEM-armoured (*.pem), DER-encoded X509 cer
| logging.logback.rollingpolicy.max-file-size | LOGGING_LOGBACK_ROLLINGPOLICY_MAX-FILE-SIZE | 10MB | Rolling max file size |
| logging.logback.rollingpolicy.max-history | LOGGING_LOGBACK_ROLLINGPOLICY_MAX-HISTORY | 7 | Rolling max days |

{% if "audit-log" not in (config.extra.feature_flags.disabled|string|lower|replace(" ", "")).split(",") %}
#### Audit Logging

Audit logging will allow you to have a trace of the actions performed using API calls.
⚠️ **Important**: Please note that only modifying actions are logged (creating, updating, deleting) and not reading actions.

| Parameter | Environment variable | Default value | Description |
|:-----------------------------------|:-----------------------------------|:-----------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------|
| openaev.audit-logs.transports | OPENAEV_AUDIT-LOGS_TRANSPORTS | | Lists of transports to use for audit logging separated by comma. No transports means audit logging is disabled. The transports usable are : file,console |
| openaev.audit-logs.halt-on-failure | OPENAEV_AUDIT-LOGS_HALT-ON-FAILURE | false | Parameter to stop the platform if audit logging is failing. |
| logging.level.io.openaev.utils.log | LOGGING_LEVEL_IO_OPENAEV_UTILS_LOG | | Audit logging is using the global OpenAEV log level but to lower the log level of the audit logging, this parameter can be used |
| | AUDIT_LOG_DIR | ./logs | If file transport is used, this parameter is used to set the path of the log file. |
| | AUDIT_LOG_FILE | ./logs/audit.log | If file transport is used, this parameter is used to set the file path. |
{% endif %}

### Dependencies

#### XTM Suite: OpenCTI
Expand Down
3 changes: 3 additions & 0 deletions mkdocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,8 @@ extra_css:

# Extra
extra:
feature_flags:
disabled: !ENV [DOCS_FEATURE_FLAGS, "audit-log"]
version:
provider: mike
analytics:
Expand All @@ -60,6 +62,7 @@ plugins:
alias_type: symlink
canonical_version: latest
- search
- macros
- git-committers:
repository: OpenAEV-Platform/docs
branch: main
Expand Down
1 change: 1 addition & 0 deletions requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,6 @@ mkdocs-git-authors-plugin
mkdocs-git-committers-plugin-2
mkdocs-git-revision-date-localized-plugin
mkdocs-glightbox
mkdocs-macros-plugin
mike
lxml