Ylianst / MeshCentral

A complete web-based remote monitoring and management web site. Once setup you can install agents and perform remote desktop session to devices on the local network or over the Internet.
https://meshcentral.com
Apache License 2.0
4.26k stars 569 forks source link

Idea: Safe Debug and Support info generator #3088

Open rodrigolzd opened 3 years ago

rodrigolzd commented 3 years ago

Recently I saw a couple of issues here where the person would mistakenly post their actual sensitive server information in the issue text. This got me thinking that perhaps we could have another command at the console that would generate some sort of output we could use for support and debug purposes, perhaps some type of server profile without the sensitive information and perhaps with some extras like if the agentupdate setting in the config.json file is set to automatic or not.

Now as for what information is relevant for this, I think @Ylianst is the best person to decide as he is the one usually asking for more details for support purposes.

I think this would cause at least a few effects: Better detailed support requests with MC standard safe detailed info. Less requests for server setup details as the first reply to issues. Faster and more accurate bug reporting and support responses. So on.

Now, I wonder if it would also be possible to get a report from an specific agent or group of agents as well, perhaps some other command generating this info would be nice. I know there is a way to export the device info to a file already, but I am thinking of support from developers point of view, not support for the end users, so, maybe the exported information could be different, perhaps just agent version and some other useful info, but not all that is normally exported.

Open to improvements on these ideas.

rodrigolzd commented 2 years ago

@si458

just found this commit and wanted to mark it as related to this feature request

add client info to bug report https://github.com/Ylianst/MeshCentral/commit/7e48087db8f365d467d6d827022a4a547488848f

si458 commented 9 months ago

this now sort of exists, Show server configuration - shows ur current config.json Show server error log - shows error logs running info in the 'console' tab of the 'My Server' tab will return extra information

> info
{
    "meshVersion": "v1.1.20",
    "nodeVersion": "v18.17.1",
    "runMode": "Hybrid (LAN + WAN) mode",
    "productionMode": true,
    "database": "NeDB",
    "platform": "linux",
    "arch": "x64",
    "pid": 407,
    "uptime": 307985.787832109,
    "cpuUsage": {
        "user": 650371544,
        "system": 133009950
    },
    "memoryUsage": {
        "rss": 259301376,
        "heapTotal": 104615936,
        "heapUsed": 79715168,
        "external": 31781255,
        "arrayBuffers": 30858052
    },
    "warnings": [],
    "allDevGroupManagers": []
}

agentissues in the console tab again will return ips and issues for different agents amtstats shows amt info for computers

but what i will look into is maybe a server command that runs ALL these commands and exports it into a log file that lives inside the meshcentral-data folder for easier access/upload/troubleshooting