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

Improve the output of the log file #425

Open
thoov opened this issue May 10, 2019 · 1 comment
Open

Improve the output of the log file #425

thoov opened this issue May 10, 2019 · 1 comment

Comments

@thoov
Copy link
Member

thoov commented May 10, 2019

NOTE: this issue predates this project's rename to Volta.

Currently the log output looks like this:

ember -v
Notion v0.4.1

Notion error: Could not read package info for dependencies.

Please ensure that all dependencies have been installed.

cause: Could not read project manifest
from /Users/thoover/code/travis-web/node_modules/ember-cli-htmlbars/package.json

Please ensure that the file exists.

cause: Could not read project manifest
from /Users/thoover/code/travis-web/node_modules/ember-cli-htmlbars/package.json

Please ensure that the file exists.

cause: No such file or directory (os error 2)

This currently lacks useful info that will make debugging / future support loads harder. We should standardize the log to the following format:

Command: 

ember -v

Message: 

Notion error: Could not read package info for dependencies.

Please ensure that all dependencies have been installed.
Error details written to: /Users/thoover/.notion/log/notion-error-2019-05-10_15_14_13.612.log

Verbose Message:

 - The same output that would have been produced if the user ran the command with the -v flag

System Info:

- OS Name + Version
- Shell type
- PATH
- Time when the command ran

Notion Info:

- Notion Version
- Values of Notion ENVs
- List of notion installed shims and their versions
- List of config info


Full Stack Trace:

 - The stack trace that rust / npm / yarn gives when the command failed

This format will allow us to easily ask users to submit their log with the issue and will help us dig in and debug problems that may happen.

@thoov
Copy link
Member Author

thoov commented May 10, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants