Skip to content

docs: add audit logging ADR - #3855

Merged
micbar merged 1 commit into
mainfrom
adr-auditing
Nov 2, 2026
Merged

docs: add audit logging ADR#3855
micbar merged 1 commit into
mainfrom
adr-auditing

Conversation

@micbar

@micbar micbar commented Oct 28, 2026 •
edited
Loading

Copy link
Copy Markdown
Member

Description

Add ADR about audit logging.

This PR has been created with the help of agents but the author took quite some effort to rephrase and shorten every aspect.

The interactions on that proposal should be done by humans directly.

Related Issue

  • Fixes <issue_link>

Motivation and Context

How Has This Been Tested?

  • test environment:
  • test case 1:
  • test case 2:
  • ...

Screenshots (if appropriate):

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Technical debt
  • Tests only (no source changes)

Checklist:

  • Code changes
  • Unit tests added
  • Acceptance tests added
  • Documentation added

@codacy-production

codacy-production Bot commented Oct 28, 2026

Copy link
Copy Markdown

Up to standards ✅

🟢 Issues 0 issues

Results:
0 new issues

View in Codacy

NEW Get contextual insights on your PRs based on Codacy's metrics, along with PR and Jira context, without leaving GitHub. Enable AI reviewer
TIP This summary will be updated as you push new changes.

micbar
micbar commented Oct 28, 2026
View reviewed changes
Comment thread docs/adr/0006-audit-logging.md
after write, stdout and OTLP output, metrics
(`opencloud_audit_events_emitted_total`, `_dropped_total`,
`_sink_errors_total`, consumer lag). Map everything the legacy service writes
today, with the correct actor. In the Helm chart the audit service gets its

@micbar micbar Oct 28, 2026

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@butonic @pbleser-oc @schweigisito
I am not sure about that detail. Maybe it makes more sense to keep it in the api pod

@butonic butonic Oct 29, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the current audit service runs in the backend pods ... because it only listens to events. There is an architectural change by moving the functionality to a package that is then used to emit events (and maybe block operations in strict mode) where they appear. Which is fine IMO.

butonic
butonic approved these changes Oct 29, 2026
View reviewed changes

@butonic butonic left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I want!

@butonic

butonic commented Oct 29, 2026

Copy link
Copy Markdown
Member

related: #3082
@micbar maybe we can clarify #3464 (comment)

@micbar micbar mentioned this pull request Oct 30, 2026
Draft
4 of 9 tasks
@micbar
micbar merged commit 8cf11bf into main Nov 2, 2026
4 checks passed
@micbar
micbar deleted the adr-auditing branch November 2, 2026 15:14
@openclouders openclouders mentioned this pull request Nov 2, 2026
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@butonic butonic butonic approved these changes
@schweigisito schweigisito schweigisito approved these changes

Assignees

No one assigned

Labels

Type:Documentation

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@micbar @butonic @schweigisito