Skip to content

Readme: add reference to OTel project proposal #13

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 20, 2025
Merged

Readme: add reference to OTel project proposal #13

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b7896fc
docs(readme): use title case
mlenkeit May 20, 2025
942f083
docs(readme): add reference to OTel project proposal
mlenkeit May 20, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 7 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
[![REUSE status](https://api.reuse.software/badge/github.com/apeirora/audit-log-poc-for-otel)](https://api.reuse.software/info/github.com/apeirora/audit-log-poc-for-otel)

# Audit Log proof of concept for OpenTelemetry
# Audit Log Proof of Concept for OpenTelemetry

Audit-logging with OTel - how could this work?
This proof of concept is part of an effort to make OpenTelemetry fit for audit logging purposes. We are building an end-to-end scenario to refine the challenges and requirements for audit logging in OTel and to showcase potential solutions.

## About this project
Read about the entire idea at [open-telemetry/community#2409](https://github.com/open-telemetry/community/pull/2409).

## About This Project

This PoC scenario provides an easy setup of an [OpenTelemetry Demo](https://opentelemetry.io/docs/demo/) environment to test how log messages are delivered through multiple different systems.

Expand All @@ -15,7 +17,7 @@ This PoC scenario provides an easy setup of an [OpenTelemetry Demo](https://open
* [task](https://taskfile.dev/)
* optional: [k9s](https://k9scli.io/)

### quick start linux
### Quick Start Linux

```bash
git clone https://github.com/apeirora/otel-audit-log-poc.git
Expand All @@ -26,7 +28,7 @@ task otel:demo
task otel:port-forward
```

### demo endpoints
### Demo Endpoints

With the frontend-proxy port-forward set up, you can access:

Expand Down