Skip to content
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

Jump to bottom

Replace "XXX" in log messages with meaningful descriptions #4521

Open
OhmSpectator opened this issue Jan 14, 2025 · 0 comments
Open

Replace "XXX" in log messages with meaningful descriptions #4521

OhmSpectator opened this issue Jan 14, 2025 · 0 comments
Labels
enhancement New feature or request good first issue Good for newcomers

Comments

@OhmSpectator
Copy link
Member

Replace "XXX" in log messages with meaningful descriptions to improve clarity and maintainability. I see at least 15 places in code, where this pattern is used. For example, in checkmaxtime.go, the message:

log.Errorf("StillRunning(%s) XXX took a long time: %d", agentName, elapsed/time.Second)

can be updated to:

log.Errorf("StillRunning(%s) took a long time (longer than the error threshold): %d", agentName, elapsed/time.Second)

The current use of "XXX" is unclear and does not convey meaningful information, making logs harder to understand and debug. Updating these messages will enhance readability and consistency across the codebase.
OhmSpectator added a commit to OhmSpectator/eve that referenced this issue Jan 14, 2025
@OhmSpectator
pillar: Refine log messages for threshold-based timing warnings.
8a29188 
Update log messages in `StillRunning` and `CheckMaxTimeTopic` functions to clarify
the context of timing warnings and errors. Replace ambiguous phrases with more
explicit references to exceeding warning and error thresholds.

Issue: lf-edge#4521

Signed-off-by: Nikolay Martyanov <[email protected]>
@OhmSpectator OhmSpectator mentioned this issue Jan 14, 2025
Merged
OhmSpectator added a commit that referenced this issue Jan 15, 2025
@OhmSpectator
pillar: Refine log messages for threshold-based timing warnings.
d31ef12 
Update log messages in `StillRunning` and `CheckMaxTimeTopic` functions to clarify
the context of timing warnings and errors. Replace ambiguous phrases with more
explicit references to exceeding warning and error thresholds.

Issue: #4521

Signed-off-by: Nikolay Martyanov <[email protected]>
OhmSpectator added a commit to OhmSpectator/eve that referenced this issue Jan 15, 2025
@OhmSpectator
pillar: Refine log messages for threshold-based timing warnings.
6272db1 
Update log messages in `StillRunning` and `CheckMaxTimeTopic` functions to clarify
the context of timing warnings and errors. Replace ambiguous phrases with more
explicit references to exceeding warning and error thresholds.

Issue: lf-edge#4521

Signed-off-by: Nikolay Martyanov <[email protected]>
(cherry picked from commit d31ef12)
OhmSpectator added a commit to OhmSpectator/eve that referenced this issue Jan 15, 2025
@OhmSpectator
pillar: Refine log messages for threshold-based timing warnings.
0dcf46f 
Update log messages in `StillRunning` and `CheckMaxTimeTopic` functions to clarify
the context of timing warnings and errors. Replace ambiguous phrases with more
explicit references to exceeding warning and error thresholds.

Issue: lf-edge#4521

Signed-off-by: Nikolay Martyanov <[email protected]>
(cherry picked from commit d31ef12)
OhmSpectator added a commit that referenced this issue Jan 15, 2025
@OhmSpectator
pillar: Refine log messages for threshold-based timing warnings.
4f0e689 
Update log messages in `StillRunning` and `CheckMaxTimeTopic` functions to clarify
the context of timing warnings and errors. Replace ambiguous phrases with more
explicit references to exceeding warning and error thresholds.

Issue: #4521

Signed-off-by: Nikolay Martyanov <[email protected]>
(cherry picked from commit d31ef12)
OhmSpectator added a commit that referenced this issue Jan 15, 2025
@OhmSpectator
pillar: Refine log messages for threshold-based timing warnings.
71509e3 
Update log messages in `StillRunning` and `CheckMaxTimeTopic` functions to clarify
the context of timing warnings and errors. Replace ambiguous phrases with more
explicit references to exceeding warning and error thresholds.

Issue: #4521

Signed-off-by: Nikolay Martyanov <[email protected]>
(cherry picked from commit d31ef12)
@OhmSpectator OhmSpectator added good first issue Good for newcomers enhancement New feature or request labels Jan 23, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@OhmSpectator