Support Tool - Discussion & Specs

[thebracket]

Since we're getting some popularity, we discussed in Matrix that it might be a good idea to have a support tool that gathers useful information and uploads it to us, so we can better help.

There's a lot of things to worry about here, so I'm hoping we can build up some comments to come up with a good, safe, open specification:

• ShapedDevices.csv contains personally identifiable customer information - but it's also super useful for figuring out what's going on. I'd support sharing it, but with Circuit Name and Device Name scrambled in a one-way hash so that we (or anyone else who reads it) have no way of reversing it. We might anonymize IP addresses for the same reason.
• Network.json is less personally identifying, but we should scramble the names - using the same one-way hash so that we can still tell that customers are linked (or not) to ShapedDevices - but with no way to say "oh, there's a tasty target"
• It would be super helpful to grab CPU information, RAM information, Linux version information, NIC information, whether the system is in a VM. Any problems sharing that?
• /etc/lqos - I don't see anything in there that isn't publicly shareable?
• ispConfig.py - so this is really useful for diagnosing (especially with the other info), but requires a bunch of sanitization. We'd need to hide all the integration (UISP, influx, etc.) URLs and credentials; we don't want anyone handing out UISP access by mistake.
• Dump recent usage data, unknown IPs? We'd have to anonymize the IP addresses, but I think it could be useful. A downside of anonymizing IPs is that we can't say "oh, your interfaces are the wrong way around".

I'm thinking that the tool should:

• Be open source so anyone can build it themselves, and verify that we haven't added anything evil. I'd rather not ask everyone to just trust us.
• Save a dump in a human-readable form, so you can look through and make sure we aren't taking any data we shouldn't. Again, nobody should have to trust us!
• Provide an easy way to send the data to us once it's gathered and the user has made sure that we aren't stealing the keys to the kingdom.

Thoughts, everyone?

[thebracket]

I'm closing this as "done", because we have a support tool that does this in 1.5 BETA 1.