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.

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

[Operational Awareness] review usage of logger in KIM to ensure well formatted and expressive log-messages and appropriate log-levels #388

Open
6 tasks
tobiscr opened this issue Sep 18, 2024 · 0 comments
Labels
area/control-plane Related to all activities around Kyma Control Plane kind/feature Categorizes issue or PR as related to a new feature.

Comments

@tobiscr
Copy link
Contributor

tobiscr commented Sep 18, 2024

Description

For efficient analysis and debugging during runtime, we have to provide expressive error-messages in KIM. Also the used log-level has to be reviewed to highlight relevant information in the logs.

Guidelines for Loglevel usage:

  • DEBUG / VERBOSE (only for tracing purposes)
  • INFO (business/operational relevant but not critical)
  • WARN (critical but recoverable)
  • ERROR (critical and non-recoverable)

AC:

  • Ensure each log message related to the reconciliation of a RuntimeCR has to include the runtime-ID and shoot-ID
  • Review the logic in KIM and ensure business / technical relevant events and also all technical edge / error cases are logge
  • Review used log messages to ensure they include all information to enable an on-call engineer to understand the problem (expressive message, provide all data required for next analysis step, indicate if the issue could be related by 3rd party system etc.)
  • Ensure for each log message is an appropriate log-level used
  • Use JSON as standard log format (Configure logging to be in a json format #50)
  • Use proper timestamp format (Adjust log format of KIM to RFC3339 #219)

Reasons

Improve operational quality of KIM by using expressive log-messages.

Attachments

@tobiscr tobiscr added kind/feature Categorizes issue or PR as related to a new feature. area/control-plane Related to all activities around Kyma Control Plane labels Sep 18, 2024
@tobiscr tobiscr changed the title Operational Awareness: review usage of logger in KIM to ensure expressive log-messages and usage of correct log-level Operational Awareness: review usage of logger in KIM to ensure expressive log-messages and approproate log-levels Sep 18, 2024
@tobiscr tobiscr changed the title Operational Awareness: review usage of logger in KIM to ensure expressive log-messages and approproate log-levels Operational Awareness: review usage of logger in KIM to ensure well formatted and expressive log-messages and appropriate log-levels Sep 23, 2024
@tobiscr tobiscr changed the title Operational Awareness: review usage of logger in KIM to ensure well formatted and expressive log-messages and appropriate log-levels [Operational Awareness] review usage of logger in KIM to ensure well formatted and expressive log-messages and appropriate log-levels Nov 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/control-plane Related to all activities around Kyma Control Plane kind/feature Categorizes issue or PR as related to a new feature.
Projects
None yet
Development

No branches or pull requests

1 participant