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

Add log error codes and map to documentation #978

Open
binarylogic opened this issue Oct 7, 2019 · 1 comment
Open

Add log error codes and map to documentation #978

binarylogic opened this issue Oct 7, 2019 · 1 comment
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.

Comments

@binarylogic
Copy link
Contributor

binarylogic commented Oct 7, 2019

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:

ERROR vector::topology: Configuration error: Source "in": data_dir option required, but not given here or globally

It'd be nice if we could add something like:

ERROR vector::topology: Configuration error: Source "in": data_dir option required, but not given here or globally. See https://docs.vector.dev/errors/abcd1234

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.

@binarylogic binarylogic added domain: observability Anything related to monitoring/observing Vector meta: idea Anything in the idea phase. Needs further discussion and consensus before work can begin. domain: docs type: enhancement A value-adding code change that enhances its existing functionality. needs: approval Needs review & approval before work can begin. labels Oct 7, 2019
@binarylogic binarylogic added this to the Improve setup & debugging milestone Oct 7, 2019
@LucioFranco
Copy link
Contributor

I think this relates to some of the error work that @bruceg has done. I think we could just add these types of hints specifically to the error variants Display implementation.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
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.
Projects
None yet
Development

No branches or pull requests

3 participants