GUI button for log collection & easy retrieval

[nonpunctual]

• How might this have a positive effect on your organization?

When support is on the line with a user or when an admin is helping an end user it may be helpful to have a button in the GUI that would collect relevant on-device logs & send them to somewhere support can retrieve them, or, a location on the local filesystem that is easy for an end user to navigate to in Finder / Explorer window, etc. so that the end user doesn't have to do any difficult navigation or run shell commands to collect logs.

• What is the current situation? Why does the current situation hurt?
• What are you doing right now to work around this issue? What's non-ideal about it?

Currently this can be accomplished with a script, but, that script would have to be installed in a customer's Fleet instance "on-demand". It would be easier for support, admins & end users if there were a button for this as it's a common workflow / request.

Problem

Collect on-device fleetd logs.

Potential solutions

1. Running a script "built-in" to Fleet would be the quickest way to build this. I assume it would be similar method to the way we execute lock & wipe scripts for platforms.

[noahtalerman]

script "built-in" to Fleet

@nonpunctual what would the script look like? Which logs would it collect?

[nonpunctual]

The scripts I've seen would be extremely simple. Just copying files from where ever they are written to a more obvious place in the user space ie, /Users/Shared or /Documents or whatever, & collapsing them into an archive (.tar, .zip) I think makes the most sense @ksatter hopefully has some color to add because she was the one that suggested this. Thanks.

[nonpunctual]

[nonpunctual]

One of the questions answered by whether or not we add a feature like this is: who are we building Fleet for?

Admins who know systems don't need to know usually where to get logs, but, even so it's nice to be able to collect them quickly & easily.

If someone on a help desk is tasked with using Fleet, they are the ones collecting logs. If logs are not captured at the time an issue is occurring, the issue can be difficult or impossible to reproduce.

This feature should be prioritized for this reason & because it's easy to do.

[noahtalerman]

Hey @nonpunctual, at feature fest we discussed the solution of adding a script, like the following, to Fleet:

cp /var/log/orbit/orbit.stderr.log ~/Library/Logs/Fleet/fleet-desktop.log /Users/Shared

echo "Successfully copied fleetd logs to the /Users/Shared folder."

echo "To retrieve logs, ask the end user to open Finder and in the menu bar select Go > Go to Folder."

echo "Then, ask the end user to type in /Users/Shared, press Return, and locate orbit.stderr.log (Orbit logs) and fleet-desktop.log (Fleet Desktop logs) files."

Help desk can then log in to Fleet and run the script via the "Run script" action on the Host details page. What do you think?

We didn't have the space to take on adding a button for this in the current design sprint (4.48)

Please feel free to bring this one back to feature fest.

[nonpunctual]

@noahtalerman I think that's a good solution. I think a button would still be a nice to have but this is isn't super critical as long as we have like a script library of things like this the same way we have a query library maybe?

[nonpunctual]

related:

#19489
#18234

Closing as dupelicate.