Skip to content

Commit 0119cc9

Browse files
authored
Readme: add reference to OTel project proposal (#13)
* docs(readme): use title case see https://en.wikipedia.org/wiki/Title_case * docs(readme): add reference to OTel project proposal
1 parent e3ebc7c commit 0119cc9

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

README.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
11
[![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)
22

3-
# Audit Log proof of concept for OpenTelemetry
3+
# Audit Log Proof of Concept for OpenTelemetry
44

5-
Audit-logging with OTel - how could this work?
5+
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.
66

7-
## About this project
7+
Read about the entire idea at [open-telemetry/community#2409](https://github.com/open-telemetry/community/pull/2409).
8+
9+
## About This Project
810

911
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.
1012

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

18-
### quick start linux
20+
### Quick Start Linux
1921

2022
```bash
2123
git clone https://github.com/apeirora/otel-audit-log-poc.git
@@ -26,7 +28,7 @@ task otel:demo
2628
task otel:port-forward
2729
```
2830

29-
### demo endpoints
31+
### Demo Endpoints
3032

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

0 commit comments

Comments
 (0)