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

More detailed error messages #273

Open
muziqaz opened this issue Aug 23, 2024 · 4 comments
Open

More detailed error messages #273

muziqaz opened this issue Aug 23, 2024 · 4 comments
Labels
enhancement New feature or request

Comments

@muziqaz
Copy link
Contributor

muziqaz commented Aug 23, 2024

Not sure if this is fahclient side or web control side, but more detailed (less cryptic) error messages would help a lot in troubleshooting.

@jcoffland
Copy link
Member

There's no easy way to make all error messages understandable for most users. Many of the error messages are not meant to be understood by the end user because explaining many of the errors would be difficult if not impossible. They are meant to be passed on via a bug report to the developer.

@muziqaz
Copy link
Contributor Author

muziqaz commented Aug 23, 2024

I recon couple of word hint would be helpful to us, more advanced users. Let's say instead of

10:58:34:I1:WU6:Uploading WU results
10:58:34:I1:OUT1506:> POST https://ds03.scs.illinois.edu/api/results HTTP/1.1
10:58:52:E :OUT1504:Failed response: EOF

expand into:
Failed responce: Connection Failed or whatever EOF is actually abreviating
At the moment EOF is kinda cryptic.

The reason I am targeting more advanced users is because "normal" users will simply come to forum or discord and ask: "My fah is not working" regardless on how detailed the error message is. So if we, advanced users have some sort of hint on what the error means, we could guide others to do some troubleshooting and maybe fixing the issue

@jcoffland
Copy link
Member

jcoffland commented Aug 23, 2024

EOF = End of File

This means the connection was closed from the other end.

@jcoffland jcoffland added the enhancement New feature or request label Aug 27, 2024
@dymil
Copy link

dymil commented Nov 23, 2024

See, that's totally incomprehensible, and I teach computer networking to undergraduates. It's only after you explain that that I grok that probably the socket is somewhere wrapped in a file-like interface.

Even though I'm sure this is all output by some HTTPS library under the hood, appending some conjecture to the error message—say, that an underlying TCP socket call returned with '0' (graceful closure)—would go a long way. It'd just be a lookup table, basically, to append such text.

Heck, maybe a RAG model could produce that speculation for a(n advanced) user, given a copy-pasted log, and thereby help produce the lookup table to add to the codes.

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

No branches or pull requests

3 participants