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

log: errors should include hints to the operator with remediation steps #80875

Closed
dhartunian opened this issue May 2, 2022 · 0 comments · Fixed by #82891
Closed

log: errors should include hints to the operator with remediation steps #80875

dhartunian opened this issue May 2, 2022 · 0 comments · Fixed by #82891
Assignees
Labels
C-enhancement Solution expected to add code/behavior + preserve backward-compat (pg compat issues are exception)

Comments

@dhartunian
Copy link
Collaborator

dhartunian commented May 2, 2022

Currently, error log messages typically omit remediation steps and customers have to resort to either searching documentation or forums to understand what to do when they see something. In addition, some "error" level messages require no remediation at all and simply offer a notification that something out of the ordinary happened that the DB is able to safely recover from.

The desired feature here is an API that can nudge log message writers to provide remediation along with their error message.

Jira issue: CRDB-15470

@dhartunian dhartunian added C-enhancement Solution expected to add code/behavior + preserve backward-compat (pg compat issues are exception) T-observability-inf labels May 2, 2022
@jlinder jlinder added sync-me and removed sync-me labels May 20, 2022
@craig craig bot closed this as completed in c25a0dc Nov 1, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C-enhancement Solution expected to add code/behavior + preserve backward-compat (pg compat issues are exception)
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants