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 automated reporting of networking/similar issues #1575

Closed
holta opened this issue Mar 19, 2019 · 7 comments
Closed

More automated reporting of networking/similar issues #1575

holta opened this issue Mar 19, 2019 · 7 comments

Comments

@holta
Copy link
Member

holta commented Mar 19, 2019

I'm thinking we should automate reporting of networking [and other] bugs so we can be 10X more efficient during the initial phases of debugging especially. Instead of spending days-upon-days and weeks-upon-weeks gathering context each time (whereupon we lose people often, permanently in many cases...)

Networking issues will never entirely go away, as we've discovered over 7 years now — nor will other bugs of course — as there will always Yet Another wacky networking topology thrown at us, Etc. No matter what we tell implementers we simply cannot control them.

So it would seem wise that IIAB include a script to auto-publish the output of 10-or-so key log files & network/configuration files, so initial reporting becomes an order of magnitude more efficient going forward. Non-technical implementers (and there are many) will happily partake if they're leading themselves and all of us forward. e.g. the best would be 1 short command, that tests for Internet and then [with consent] uploads all these files to pastebin/GitHub or similar.

And also somehow emails us at the same time?

A more mature version of this "iiab-diagnostics" command (or whatever we call it) could also dump everything into /opt/iiab/diagnostics (or wherever) with crisp instructions for implementers to (1) move these files to USB stick (2) publish these to the web from Windows [or Android] typically.

Refs: #1306 #1519 #1520 #1527 #1536 #1569 #1572

@holta holta added this to the 7.0 milestone Mar 19, 2019
@holta
Copy link
Member Author

holta commented Mar 19, 2019

If folks can add to this ticket their recommendations of the 10-or-so-most-useful IIAB config & networking & log files that would be Extremely Useful!

Also: which such files might will be the most privacy-sensitive, and as such perhaps should not be published to GitHub etc?

@holta
Copy link
Member Author

holta commented Mar 23, 2019

What IIAB files are most useful for remote support / remote diagnostics? DRAFT:

  • /etc/iiab/local_vars.yml
  • /etc/iiab/iiab.env
  • /etc/iiab/iiab.ini
  • /opt/iiab/iiab/iiab-install.log
  • /opt/iiab/iiab/iiab-network.log (if ./iiab-network has been run)
  • /opt/iiab/iiab/iiab-debug.log (if ./runrole <ROLE> has been run)
  • /library/www/html/home/menu.json
  • output of uname -a
  • output of ip a
  • output of brctl show
  • /etc/resolv.conf & other DNS files?
  • hostapd &/or wpa_supplicant config files ?
  • is it possible to auto-verify whether or not an X Windows-like graphical desktop is installed?
  • output of other networking files & commands?

@mikkokotila
Copy link

I guess one thing that seems useful would be to have a single command (in path preferably) where the user just types something like $ iiab-diag which gathers all the various files and meaningful system specs, package it into zip and emails it.

Then the next step could be to have some automated analysis tools to automate common processes, and finally implement those automations on the system with some prescriptions (e.g. run this command and see what happens). If that data could be collected, maybe an AI could be later trained that would be able to sniff the system and go through a process of trial and error to fix the system for the user.

@georgejhunt
Copy link
Contributor

  • I was searching for something like pastebin for targz files. It looks like filebin works: https://filebin.ca/4dnRGP2bDOOk/raspbian-9-190415-ghunt.17244.tgz.
  • I discovered that vim is able to open tgz files and enable easy browsing of content.
  • I was able to download this filebin url via chrome. But wget on macbook got an error 503 "service temporarily unavailable".
  • I just tried to drop the tgz into this issue input box. The error message suggested that zip files are supported.
  • But I'd rather keep the convenience of having all the information packaged together and browsable via vim, rather than to be forced to create a separate directory to unzip the separate files into.

@holta
Copy link
Member Author

holta commented Apr 15, 2019

Huge thanks @mikkokotila & @georgejhunt for your designs here.

@jvonau has a lot of experience in tech support and may also have valuable insights e.g. things like which things are most indicative of implementer/operator intentions alongside the technical issues (:

@holta
Copy link
Member Author

holta commented Jun 23, 2019

PRs #1757 & #1763 are now merged — so /usr/bin/iiab-diagnostics is now available in reasonably polished form for new implementers, as documented here:

https://github.com/iiab/iiab/blob/master/scripts/iiab-diagnostics.README.md

Tangentially Related:
#1749 -> PR #1752 OpenVPN is very commonly needed when DNS is failing
#1759 Assess MediaWiki/Discourse/CRM/FB needs to scale up IIAB Community Support
#1762 IIAB Community Analytics above & beyond AWStats

@holta
Copy link
Member Author

holta commented Jun 27, 2019

The core is now implemented by @georgejhunt's PRs #1757 and my #1763.

Please re-open as nec, if/where further improvement is nec!

@holta holta closed this as completed Jun 27, 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

3 participants