Skip to content

Better logging #971

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

Closed
EgorBu opened this issue Oct 11, 2019 · 3 comments · Fixed by #978
Closed

Better logging #971

EgorBu opened this issue Oct 11, 2019 · 3 comments · Fixed by #978
Labels
enhancement New feature or request

Comments

@EgorBu
Copy link

EgorBu commented Oct 11, 2019

Hi,
It would be great to improve logging.
For example - I tried to initialize gitbase and got:

FATA[0000] unable to initialize database engine          error="mkdir /var/lib/gitbase: permission denied"

Fortunately - I found this path in doc and changed GITBASE_INDEX_DIR.
But it's definitely not obvious.

For example, it could contain a suggestion what possibly could be the reason for the error:

Error messages, and in general any feedback provided to a user in the course of interacting with your API, is part of the API. Interactivity and feedback are integral to the user experience. Design your API’s error messages deliberately.

from here.

@agarciamontoro agarciamontoro added the enhancement New feature or request label Oct 11, 2019
@agarciamontoro
Copy link
Contributor

I agree that this can be greatly improved. Your feedback here is valuable, so: what kind of message would you have liked to read there?

@EgorBu
Copy link
Author

EgorBu commented Oct 11, 2019

It's hard work but ideally, the error message should contain hints about how to solve the problem:

FATA[0000] bla bla
This could happen in several cases:
* try to check that you have permissions
* try to launch with sudo
* try to  change this env variable VARIABLE

@erizocosmico
Copy link
Contributor

Waiting on src-d/go-mysql-server#841

@erizocosmico erizocosmico removed the blocked Some other issue is blocking this label Oct 16, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants