fix lint issues

hilmarf · hilmarf · commit 1627d418d06d · 2025-06-20T13:02:38.000+02:00
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -2,23 +2,27 @@
 
 ## Code of Conduct
 
-All members of the project community must abide by the [SAP Open Source Code of Conduct](https://github.com/SAP/.github/blob/main/CODE_OF_CONDUCT.md).
-Only by respecting each other we can develop a productive, collaborative community.
-Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting [a project maintainer](REUSE.toml).
+All members of the project community must abide by the
+[SAP Open Source Code of Conduct](https://github.com/SAP/.github/blob/main/CODE_OF_CONDUCT.md). Only by respecting each other we can develop
+a productive, collaborative community. Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting
+[a project maintainer](REUSE.toml).
 
 ## Engaging in Our Project
 
 We use GitHub to manage reviews of pull requests.
 
 - If you are a new contributor, see: [Steps to Contribute](#steps-to-contribute)
 
-- Before implementing your change, create an issue that describes the problem you would like to solve or the code that should be enhanced. Please note that you are willing to work on that issue.
+- Before implementing your change, create an issue that describes the problem you would like to solve or the code that should be enhanced.
+  Please note that you are willing to work on that issue.
 
-- The team will review the issue and decide whether it should be implemented as a pull request. In that case, they will assign the issue to you. If the team decides against picking up the issue, the team will post a comment with an explanation.
+- The team will review the issue and decide whether it should be implemented as a pull request. In that case, they will assign the issue to
+  you. If the team decides against picking up the issue, the team will post a comment with an explanation.
 
 ## Steps to Contribute
 
-Should you wish to work on an issue, please claim it first by commenting on the GitHub issue that you want to work on. This is to prevent duplicated efforts from other contributors on the same issue.
+Should you wish to work on an issue, please claim it first by commenting on the GitHub issue that you want to work on. This is to prevent
+duplicated efforts from other contributors on the same issue.
 
 If you have questions about one of the issues, please comment on them, and one of the maintainers will clarify.
 
@@ -29,10 +33,13 @@ You are welcome to contribute code in order to fix a bug or to implement a new f
 The following rule governs code contributions:
 
 - Contributions must be licensed under the [Apache 2.0 License](./LICENSE)
-- Due to legal reasons, contributors will be asked to accept a Developer Certificate of Origin (DCO) when they create the first pull request to this project. This happens in an automated fashion during the submission process. SAP uses [the standard DCO text of the Linux Foundation](https://developercertificate.org/).
+- Due to legal reasons, contributors will be asked to accept a Developer Certificate of Origin (DCO) when they create the first pull request
+  to this project. This happens in an automated fashion during the submission process. SAP uses
+  [the standard DCO text of the Linux Foundation](https://developercertificate.org/).
 
 ## Issues and Planning
 
 - We use GitHub issues to track bugs and enhancement requests.
 
-- Please provide as much context as possible when you open an issue. The information you provide must be comprehensive enough to reproduce that issue for the assignee.
+- Please provide as much context as possible when you open an issue. The information you provide must be comprehensive enough to reproduce
+  that issue for the assignee.
diff --git a/README.md b/README.md
@@ -1,14 +1,18 @@
+<!-- markdownlint-disable-file MD041 -->
+
 [![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
 
-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.
+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.
 
 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.
+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.
 
 ## Requirements and Setup
 
@@ -51,24 +55,33 @@ task kind:start otel:demo-install
 
 With the frontend-proxy port-forward set up, you can access:
 
-Web store: http://localhost:8080/
-Grafana: http://localhost:8080/grafana/
-Load Generator UI: http://localhost:8080/loadgen/
-Jaeger UI: http://localhost:8080/jaeger/ui/
-Flagd configurator UI: http://localhost:8080/feature
+- Web store: <http://localhost:8080/>
+- Grafana: <http://localhost:8080/grafana/>
+- Load Generator UI: <http://localhost:8080/loadgen/>
+- Jaeger UI: <http://localhost:8080/jaeger/ui/>
+- Flagd configurator UI: <http://localhost:8080/feature>
 
 ## Support, Feedback, Contributing
 
-This project is open to feature requests/suggestions, bug reports etc. via [GitHub issues](https://github.com/apeirora/audit-log-poc-for-otel/issues). Contribution and feedback are encouraged and always welcome. For more information about how to contribute, the project structure, as well as additional contribution information, see our [Contribution Guidelines](CONTRIBUTING.md).
+This project is open to feature requests/suggestions, bug reports etc. via
+[GitHub issues](https://github.com/apeirora/audit-log-poc-for-otel/issues). Contribution and feedback are encouraged and always welcome. For
+more information about how to contribute, the project structure, as well as additional contribution information, see our
+[Contribution Guidelines](CONTRIBUTING.md).
 
 ## Security / Disclosure
 
-If you find any bug that may be a security problem, please follow our instructions at [in our security policy](https://github.com/apeirora/audit-log-poc-for-otel/security/policy) on how to report it. Please do not create GitHub issues for security-related doubts or problems.
+If you find any bug that may be a security problem, please follow our instructions at
+[in our security policy](https://github.com/apeirora/audit-log-poc-for-otel/security/policy) on how to report it. Please do not create
+GitHub issues for security-related doubts or problems.
 
 ## Code of Conduct
 
-We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone. By participating in this project, you agree to abide by its [Code of Conduct](https://github.com/apeirora/.github/blob/main/CODE_OF_CONDUCT.md) at all times.
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone. By
+participating in this project, you agree to abide by its [Code of Conduct](https://github.com/apeirora/.github/blob/main/CODE_OF_CONDUCT.md)
+at all times.
 
 ## Licensing
 
-Copyright 2025 SAP SE or an SAP affiliate company and ApeiroRA contributors. Please see our [LICENSE](LICENSE) for copyright and license information. Detailed information including third-party components and their licensing/copyright information is available [via the REUSE tool](https://api.reuse.software/info/github.com/apeirora/audit-log-poc-for-otel).
+Copyright 2025 SAP SE or an SAP affiliate company and ApeiroRA contributors. Please see our [LICENSE](LICENSE) for copyright and license
+information. Detailed information including third-party components and their licensing/copyright information is available
+[via the REUSE tool](https://api.reuse.software/info/github.com/apeirora/audit-log-poc-for-otel).
diff --git a/acd.md b/acd.md
@@ -7,7 +7,6 @@
 3. [BUSINESS CASE](#3-business-case)
 4. [ARCHITECTURE OVERVIEW](#4-architecture-overview)
    - 4.1 [System Components](#41-system-components)
-   - 4.2 [Data Flow](#42-data-flow)
    - 4.3 [Architecture Diagram](#43-architecture-diagram)
 5. [ARCHITECTURE DECISIONS](#5-architecture-decisions)
 6. [OPEN POINTS](#6-open-points)
@@ -19,19 +18,27 @@
 
 ## 1. EXECUTIVE SUMMARY
 
-This Architectural Concept Document (ACD) presents a Proof of Concept (POC) for implementing OpenTelemetry (Otel) SDK’s logging features in a distributed architecture. The POC centers on a Recommendation Service generating log data, which traverses several processing layers en route to Audit Log Services V3. The objective is to test logging message integrity, identify data loss points, and optimize telemetry flows for robust observability.
+This Architectural Concept Document (ACD) presents a Proof of Concept (POC) for implementing OpenTelemetry (Otel) SDK’s logging features in
+a distributed architecture. The POC centers on a Recommendation Service generating log data, which traverses several processing layers en
+route to Audit Log Services V3. The objective is to test logging message integrity, identify data loss points, and optimize telemetry flows
+for robust observability.
 
 ---
 
 ## 2. INTRODUCTION
 
-This document details a technical blueprint for leveraging OpenTelemetry’s logging SDK within a cloud-native architecture. The focus is to assess potential logging message loss and performance bottlenecks, primarily within the Recommendation Service and its downstream audit log pipeline.
+This document details a technical blueprint for leveraging OpenTelemetry’s logging SDK within a cloud-native architecture. The focus is to
+assess potential logging message loss and performance bottlenecks, primarily within the Recommendation Service and its downstream audit log
+pipeline.
 
 ---
 
 ## 3. BUSINESS CASE
 
-Ensuring audit logs are reliably captured and transmitted is critical for compliance, troubleshooting, and operational visibility. The adoption of OpenTelemetry promises unified observability but raises questions regarding potential data loss and reliability, particularly when logs traverse complex or unreliable network paths. This POC provides a structured method to evaluate, optimize, and ultimately standardize audit logging practices.
+Ensuring audit logs are reliably captured and transmitted is critical for compliance, troubleshooting, and operational visibility. The
+adoption of OpenTelemetry promises unified observability but raises questions regarding potential data loss and reliability, particularly
+when logs traverse complex or unreliable network paths. This POC provides a structured method to evaluate, optimize, and ultimately
+standardize audit logging practices.
 
 ---
 
@@ -49,44 +56,37 @@ Ensuring audit logs are reliably captured and transmitted is critical for compli
 
 ### 4.3 Architecture Diagram
 
-lucid chart link : https://lucid.app/lucidchart/7a9fa1de-2640-4a2d-a038-0f7284a0800f/edit?page=p92ebrH0iSU9r&invitationId=inv_812faa02-bebb-4df2-aec3-882d5b027543#
+lucid chart link :
+<https://lucid.app/lucidchart/7a9fa1de-2640-4a2d-a038-0f7284a0800f/edit?page=p92ebrH0iSU9r&invitationId=inv_812faa02-bebb-4df2-aec3-882d5b027543#>
 
 ## 5. ARCHITECTURE DECISIONS
 
-Use OpenTelemetry SDK within application code for cross-vendor and standardized telemetry generation.
-Externalize processing to Otel Collector for operational flexibility without code deployment.
-Employ processors (filtering, batching) for scaling and compliance with remote API limits.
-Decouple network transmission from application code, handing over all egress responsibilities to Otel Collector.
-Instrument with checkpoints and monitoring at each component boundary for reliability assessment.
-Select AuditLog Services V3 Exporter due to organizational integration requirements.
+Use OpenTelemetry SDK within application code for cross-vendor and standardized telemetry generation. Externalize processing to Otel
+Collector for operational flexibility without code deployment. Employ processors (filtering, batching) for scaling and compliance with
+remote API limits. Decouple network transmission from application code, handing over all egress responsibilities to Otel Collector.
+Instrument with checkpoints and monitoring at each component boundary for reliability assessment. Select AuditLog Services V3 Exporter due
+to organizational integration requirements.
 
 ## 6. OPEN POINTS
 
-Otel SDK & Collector Version Compatibility: Need to validate if all required features and data formats are supported.
-API Rate Limits & Back-pressure: How will surges and API slowdowns/throttling be gracefully handled?
-Data Privacy & Security: Ensure logging data is sanitized/encrypted as required before egress.
-Collector Failure Modes: What happens to logs if Otel Collector crashes or network partition occurs?
-Lossy Operations in Processors: Need clear bounds on filtering/batching impacts to log completeness.
+Otel SDK & Collector Version Compatibility: Need to validate if all required features and data formats are supported. API Rate Limits &
+Back-pressure: How will surges and API slowdowns/throttling be gracefully handled? Data Privacy & Security: Ensure logging data is
+sanitized/encrypted as required before egress. Collector Failure Modes: What happens to logs if Otel Collector crashes or network partition
+occurs? Lossy Operations in Processors: Need clear bounds on filtering/batching impacts to log completeness.
 
 ## 7. CONCLUSION AND NEXT STEPS
 
 This POC will validate the comprehensive logging flow’s reliability and highlight improvements for audit log delivery. Next steps include:
 
-Building and deploying test harnesses for each stage.
-Executing validation and stress tests.
-Analyzing end-to-end message integrity/loss metrics.
-Tuning collector/processors for optimal throughput and minimal loss.
-Compiling a findings and recommendations report for broader system rollout.
+Building and deploying test harnesses for each stage. Executing validation and stress tests. Analyzing end-to-end message integrity/loss
+metrics. Tuning collector/processors for optimal throughput and minimal loss. Compiling a findings and recommendations report for broader
+system rollout.
 
 ## 8. DECISION PROTOCOL
 
-Decisions Tracked: All key design changes/choices documented in versioned change log.
-Review Frequency: Weekly checkpoints during POC, rolling up to steering committee.
+Decisions Tracked: All key design changes/choices documented in versioned change log. Review Frequency: Weekly checkpoints during POC,
+rolling up to steering committee.
 
 ## 9. APPENDIX
 
-References to OpenTelemetry documentation
-Diagrams (link/attachments)
-API schemas and configs
-Example log events
-Test plans and scripts
+References to OpenTelemetry documentation Diagrams (link/attachments) API schemas and configs Example log events Test plans and scripts
