eclipse-tractusx / eclipse-tractusx/traceability-foss

Alignment and implementation of comprehensive Logging Concept

Open
#488 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

backend
Dominant language
Java
Stars
17
Forks
28
PR merge metrics
No merged PRs in 30d

Description

**As** team
**I want** a comprehensive and consistent logging strategy (reflecting the current application)
**so that** this will improve my dev work in the best case

## Hints / Details
Log message:

- Incoming requests (Be aware of sensitive information - obfuscate sensitive information)
- Outgoing requests including all parameters (Be aware of sensitive information - obfuscate sensitive information)
- Stopwatch (Duration of request / response)
- Comprehensive logging in context of the EDC
- Using {} and varargs log.info("Error during starting of server: with name {} - response with status {}." , name, status )
- Think about adequate log level
- Using metrics where possible (time metrics, )
- Unique log messages for each log
- Meaningful log messages. Perspective, an external contributor which has to debug the code.

## Acceptance Criteria
- [ ] Alignment of common and comprehensive logging concept
- [ ] Short alignment in the team
- [ ] Alignment is written down in the Code Standards for BE
- [ ] Adapt changes to dev guideline (Github WIKI + Contribution.md)
- [ ] Check what is necessary to adapt in our product
- [ ] Optimize the logging in the application

## Out of Scope
- ...

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading the Code Standards for BE, Github WIKI, and Contribution.md, then inspect the application's existing logging and metrics usage. Define the agreed logging concept, document it in those guidance locations, and identify and apply the necessary product changes while protecting sensitive information and using appropriate levels and messages.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
backend, documentation, observability-sre
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.