Skip to content

Commit

Permalink
docs(auditlogs): use OTel over OTEL
Browse files Browse the repository at this point in the history
Co-authored-by: Reiley Yang <[email protected]>
  • Loading branch information
mlenkeit and reyang authored Nov 19, 2024
1 parent 75f2c57 commit f81c2f4
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions projects/audit-logging.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,24 +16,24 @@ Examples of audit logs include:

Audit Logging is currently not within the scope of OpenTelemetry

- no semantic conventions for audit logs in OTEL
- 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)
- no semantic conventions for audit logs in OTel
- 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)

### 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:
The goal of this project is to make OTel fit for audit logging purposes that meet compliance requirements of enterprise software providers, in particular:

- REQ-CONV-01: Semantic conventions for application-level audit logs are defined

Check warning on line 27 in projects/audit-logging.md

View workflow job for this annotation

GitHub Actions / spelling-check

Unknown word (CONV)
- REQ-CONV-02: Semantic conventions for infrastructure-level audit logs are defined

Check warning on line 28 in projects/audit-logging.md

View workflow job for this annotation

GitHub Actions / spelling-check

Unknown word (CONV)
- REQ-APPL-01: Guaranteed delivery of audit logs exported via OpenTelemetry SDK.

Check warning on line 29 in projects/audit-logging.md

View workflow job for this annotation

GitHub Actions / spelling-check

Unknown word (APPL)
- REQ-PIPE-01: OTEL collector must provide guaranteed delivery of audit logs, including when its process is interrupted
- REQ-PIPE-01: OTel collector must provide guaranteed delivery of audit logs, including when its process is interrupted

## 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)
- 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)

## Staffing / Help Wanted

Expand Down

0 comments on commit f81c2f4

Please sign in to comment.