Add log error codes and map to documentation #978
Labels
domain: external docs
Anything related to Vector's external, public documentation
domain: observability
Anything related to monitoring/observing Vector
have: nice
This feature is nice to have. It is low priority.
meta: idea
Anything in the idea phase. Needs further discussion and consensus before work can begin.
needs: approval
Needs review & approval before work can begin.
type: enhancement
A value-adding code change that enhances its existing functionality.
Overview
After using Vector and encountering a few errors I think it would be beneficial to map known errors to codes / specific documentation takes. For example:
It'd be nice if we could add something like:
Or something similar. This page would talk about the error and how to resolve it.
Ideas
One idea would be to parse this from the code itself and autogenerate the error pages as a result. I'm unsure how easy this would be, but it seems like #543 makes this easier / possible.
Shaping
Before we begin work we should audit all of the messages and create a checkbox task list for each one. This includes updating the error message as well as the associated documentation page. I'd also like to agree on how this will work exactly, especially if we are able to auto-generate pages for the error messages.
The text was updated successfully, but these errors were encountered: