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

Reply structured error messages in RuntimeCR to KEB #630

Open
2 tasks
tobiscr opened this issue Jan 29, 2025 · 0 comments
Open
2 tasks

Reply structured error messages in RuntimeCR to KEB #630

tobiscr opened this issue Jan 29, 2025 · 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 Jan 29, 2025

Description

KIM is currently replying plain strings to KEB in RuntimeCRs. This has several limitations and makes it hard to provide well formatted and informative error messages to our BTP customers.

We agreed to use structured data in the future (e.g. JSON) in our error messages. This has several advantages:

  • Provide metadata about error cases (e.g. which logic e.g. extender / converter fired the failure, timestamp etc.)
  • Deliver more flexible error messages which can be translated in the UI smoothyl (distinguish between static error string and it's dynamic parts)
  • Make the error processable by machines
    etc.

AC:

  • Replace the plain error / feedback strings in RuntimeCRs with structured data (e.g. JSON)
  • Discuss within Framefrog and Gophers whether we should provude a library to standardised the processing of replied structured data easily (e.g. shared factory library for error messages etc.)

Reasons

Enhance error messages provided to KEB to improve UX in BTP Cockpit.

Attachments

@tobiscr tobiscr added area/control-plane Related to all activities around Kyma Control Plane kind/feature Categorizes issue or PR as related to a new feature. labels Jan 29, 2025
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