Skip to content

Commit

Permalink
docs(auditlogs): add links to appendix A
Browse files Browse the repository at this point in the history
  • Loading branch information
mlenkeit committed Nov 21, 2024
1 parent a5ef343 commit 711dc46
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions projects/audit-logging.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@ Audit Logging is currently not within the scope of OpenTelemetry
- 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.
- OTel collectors may lose audit logs in transit (i.e. no guarantee of delivery)

See [Appendix A: Guarantee of Delivery] for more details

### 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:
Expand All @@ -29,6 +31,8 @@ The goal of this project is to make OTel fit for audit logging purposes that mee
- REQ-APPL-01: Guaranteed delivery of audit logs exported via OpenTelemetry SDK
- REQ-PIPE-01: OTel collector must provide guaranteed delivery of audit logs, including when its process is interrupted

See [Appendix A: Guarantee of Delivery] for more details

## Deliverables

- semantic convention for audit logs
Expand Down Expand Up @@ -188,4 +192,5 @@ An event consists of the event name, event-specific data, and general metadata.
```
<!-- links -->
[Appendix A: Guarantee of Delivery]: #appendix-a-guarantee-of-delivery
[Appendix B: Sample Audit Log Events]: #appendix-b-sample-audit-log-events

0 comments on commit 711dc46

Please sign in to comment.