-
Epic
-
Resolution: Unresolved
-
Normal
-
None
-
None
-
None
-
Alignment of Tekton-Results logs with ADR-6 Logging Conventions
-
False
-
None
-
False
-
To Do
-
50% To Do, 0% In Progress, 50% Done
-
-
Epic Goal
- Standardize and improve Tekton-Results logs in compliance with Appstudio's ADR-6 logging conventions. This involves directing as many messages as possible to stdout or stderr through our logging framework (zap) for both the apiserver and the watcher, using a ConfigMap to configure zap.
Why is this important?
- Standardization: The ADR-6 logs convention provides a uniform structure for logging information, promoting consistent and efficient ways of logs collection, interpretation, and usage. This simplifies debugging and allows easier communication between different systems or components.
- Audit and Compliance: With well-structured and consistent logs, it's easier to perform audits, ensure compliance, and maintain a high level of security. Logs are often the first place to check in case of a security breach or malfunction, making them an essential aspect of any reliable system.
Scenarios
- Rerouting stdout and stderr messages through zap for both apiserver and watcher.
- Adapting ConfigMap for zap configuration similar to the Tekton Pipelines' within our system.
- Collaborating with other Pipelines teams to comprehend how the logging configuration operates along with research on knative logging.
Acceptance Criteria (Mandatory)
- CI - MUST be running successfully with tests automated
- Release Technical Enablement - Provide necessary release enablement details and documents.
- ...
Dependencies (internal and external)
- ...
Previous Work (Optional):
- Review logs of Tekton Results Watcher & APIServer - https://issues.redhat.com/browse/PLNSRVCE-1223
- Implement ADR-6 for Tekton Results watcher logs - https://issues.redhat.com/browse/PLNSRVCE-1308
Open questions::
- …
Done Checklist
- Acceptance criteria are met
- Non-functional properties of the Feature have been validated (such as performance, resource, UX, security or privacy aspects)
- Support and SRE teams are provided with enough skills to support the feature in production environment