Repository navigation
docs(logging): add class, data subject and level to the personal-data table - #664
Conversation
… table Every row of "Fields that can hold personal data" now names the personal-data class (tenant-pii, customer-data), the data subject (operator, tenant-user, end-customer) and the least verbose level that logs the key. go test ./hack/logref checks the values and the level against the logger call sites. The key pattern now also catches object names (name, objectName), node names (node, targetNode) and namespace label values (value, existingValue, inheritedValue, oldValue, newValue, removedValue). Closes #663 Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Signed-off-by: MaxRink <maximilian.rink@telekom.de>
There was a problem hiding this comment.
🟡 Changes recommended
The log reference check silently skips rows missing required columns, allowing malformed entries to pass validation.
1 open issue
What changed in this PR
This PR addresses #663 by expanding Auth Operator’s personal-data logging reference and adding checks that keep its classifications and log levels aligned with logger call sites. It does not change runtime logging behavior.
Changes:
- Add personal-data class, data subject, and least verbose logging level to the table.
- Expand key coverage to object names, node names, and namespace label values.
- Validate class and subject values and compare documented levels with call sites.
| File | Description |
|---|---|
hack/logref/logref_test.go |
Expand personal-data key matching and add column and log-level validation. |
docs/logging-reference.md |
Document classifications, subjects, levels, and additional personal-data keys. |
Review effort: Balanced
Security scan reportCommit: Security findings are advisory, not merge blockers. Build, test and licensing checks remain blocking. A successful job is not proof of a clean scan; findings and scanner errors are called out below.
See the linked logs for complete findings and any scanner setup failures. |
Output DeltaOutput differences were detected. The full diff is posted below in 2 bot comment(s).
The compare job downloads artifacts only; it does not checkout or execute pull-request code. |
📊 Output Delta ReportFull output diff from Trusted main baseline -> PRMetrics
|
📊 Output Delta Report (cont.)Full output diff from Latest release tag -> PRMetrics
|
A row of the personal-data table with fewer than five columns was skipped, so a row without class, subject or level passed. Report it instead. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Signed-off-by: MaxRink <maximilian.rink@telekom.de>
…ttern checkPersonalData only required a row for keys that matched a name pattern, so a new key such as "email" passed unclassified, and keys that carry tenant data without matching the pattern were missing: the names of RestrictedBindDefinitions and RestrictedRoleDefinitions, which tenants create, the Roles and bindings generated from them, external ServiceAccount references, policy violation texts (they quote namespaces) and the free-text keys reason, detail and error. Every logged key must now be in the personal-data table or in notPersonalKeys, and neither list may name a key that is not logged. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Signed-off-by: MaxRink <maximilian.rink@telekom.de>

Closes #663
Description
The table "Fields that can hold personal data" in
docs/logging-reference.mdlisted keys and content only. Each row now also states:tenant-piiorcustomer-data);operator,tenant-userorend-customer; the highest one when a key can hold several);go test ./hack/logref(checkPersonalDataColumns) now fails when a row has a class or subject outside these values, or when its level differs from the least verbose level at which the logger call sites log the key. The existing check that every matching logged key has a row stays. The key pattern now also catches:name,objectName;node,targetNode;value,existingValue,inheritedValue,oldValue,newValue,removedValue.Results:
tenant-pii/tenant-user;pathiscustomer-data/tenant-user;remoteAddriscustomer-data/end-customer, because any client that reaches/authorizeis logged atV(2);reason,detail,error,msg) is stated in prose astenant-pii/tenant-userfromerror.Keys that name auth-operator resources (
bindDefinition,rbd,owner, ...) are documented as platform configuration and are not listed. "Never logged" is unchanged.Type of Change
Checklist
make lint: 0 issues)make test;hack/benchmarkfails locally on main as well, because macOS/tmpis a symlink)API Changes
🤖 Generated with Claude Code