Project Proposal: Audit Logging SIG #2409
There are no files selected for viewing
This file contains 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
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,68 @@ | ||||||
| # Audit Logging | ||||||
|
|
||||||
| ## Background and description | ||||||
|
|
||||||
| Audit logging describes the capability of capturing audit-trail relevant events of a system to meet compliance requirements. Such events may originate from the infrastructure (e.g. a Kubernetes cluster) up to the application-level. It is a capability that is particularly relevant for providers of enterprise software. | ||||||
|
|
||||||
| Unlike regular application logs, audit logs are usually subject to long retention periods and software providers must guarantee their completeness (i.e. guarantee of delivery). | ||||||
|
|
||||||
| Examples of audit logs include: | ||||||
| - permission changes (e.g. of a service account or application user) | ||||||
| - modification of data | ||||||
| - accessing sensitive information | ||||||
| - failed login attempts | ||||||
|
|
||||||
| ### Current challenges | ||||||
|
|
||||||
| Audit Logging is currently not within the scope of OpenTelemetry | ||||||
mlenkeit marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
|
|
||||||
| - no semantic conventions for audit logs in OTEL | ||||||
|
There was a problem hiding this comment.
Suggested change
mlenkeit marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
| - OTEL APIs/SDKs do not provide feedback to the application level whether data (in particular logs) have been successfully delivered to a remote endpoint. To guarantee delivery, either the SDK has to give those guarantees, or provide feedback to the application so that it can take care of guaranteed delivery itself. | ||||||
mlenkeit marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
| - OTEL collectors may lose audit logs in transit (i.e. no guarantee of delivery) | ||||||
mlenkeit marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
|
|
||||||
| ### Goals, objectives, and requirements | ||||||
|
|
||||||
| The goal of this project is to make OTEL fit for audit logging purposes that meet compliance requirements of enterprise software providers, in particular: | ||||||
mlenkeit marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
|
|
||||||
| - REQ-CONV-01: Semantic conventions for application-level audit logs are defined | ||||||
| - REQ-CONV-02: Semantic conventions for infrastructure-level audit logs are defined | ||||||
| - REQ-APPL-01: Guaranteed delivery of audit logs exported via OpenTelemetry SDK. | ||||||
mlenkeit marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
| - REQ-PIPE-01: OTEL collector must provide guaranteed delivery of audit logs, including when its process is interrupted | ||||||
mlenkeit marked this conversation as resolved.
Show resolved
Hide resolved
mlenkeit marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
|
|
||||||
| ## Deliverables | ||||||
|
|
||||||
| - semantic convention for audit logs | ||||||
| - extend OTEL APIs/SDKs for audit logging purposes (in collaboration with the respective SIG) | ||||||
| - extend OTEL collector for audit logging purposes (in collaboration with the respective SIG) | ||||||
mlenkeit marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
|
|
||||||
| ## Staffing / Help Wanted | ||||||
|
|
||||||
| The following vendors are interested in improving this area: | ||||||
| - SAP | ||||||
mlenkeit marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
|
|
||||||
| Other vendors are invited to join the discussion. | ||||||
|
|
||||||
| ### Required staffing | ||||||
|
|
||||||
| * Project lead: SAP (name tbd) | ||||||
| * Sponsors: tbd | ||||||
mlenkeit marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
| * GC liaison: tbd | ||||||
mlenkeit marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
| * Engineers: | ||||||
| * SAP will provide a prototype in two languages (tbd; likely two of Java, JavaScript, Go) | ||||||
|
There was a problem hiding this comment. I think we need prototype in two parts:
There was a problem hiding this comment. Thanks for pointing this out! It's clear to us, but I'll work on making this clearer in the doc... |
||||||
| * Maintainers/approvers: tbd | ||||||
|
|
||||||
| ## Timeline | ||||||
|
|
||||||
| TBD based on community involvement. | ||||||
|
|
||||||
| ## Labels | ||||||
|
|
||||||
| - audit-logging (tbc) | ||||||
|
|
||||||
| ## Project Board | ||||||
|
|
||||||
| TODO: add link | ||||||
|
|
||||||
| ## SIG Meetings and Other Info | ||||||
|
|
||||||
| TODO: add information | ||||||
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good points! In addition, these are something we might want to consider:
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@reyang thanks for mentioning these points.
Especially the API behavior is something that we had thought about initially. However, when we first pitched audit logging on Slack, we received the following comment from Ted Young:
Based on this initial feedback, we decided to file this SIG proposal without proposing such API changes.