Improved reporting for custom settings state

ddribeiro commented 3 weeks ago

@allenhouchins: Show me status (pending, failed, etc.) and profile content Content is important for troubleshooting workflows. What does this error mean? Editing the profile could also be part of this workflow. Instead of having to upload a new profile for a simple typo.

Gong snippet: This feature request was discussed on an external call that was not recorded on Gong.

Problem

As an IT admin that uses Fleet to deploy custom settings to my hosts, I'd like to see how many hosts have successfully applied or failed to apply individual custom settings in the Fleet UI.

Currently, Fleet shows me how many hosts have Failed, Pending, Verifying, and Verified custom settings states. This feature request is to show those states individually per profile, so it is easier to identify hosts that have failed to apply a specific profile.

What have you tried?

I've tried to use the Fleet API to iterate over the GET /api/v1/fleet/hosts/:id endpoint and inspect the mdm.profiles dictionary to see the state of a configuration profile on that host.

However, doing this is expensive as it requires to iterate over each host in the environment and retrieve the status for each profile on individual hosts.

This iteration needs to be run each time I want to get updated host counts for each status for each of my custom settings.

Potential solutions

Fleet could display a table with each configuration profile assigned to a team with counts for how many hosts have failed, pending, verifying, or verified states for that profile. Similar to how we present pass/fail for policies today.

What is the expected workflow as a result of your proposal?

As an IT admin who wants to identify specific hosts that failed to apply a custom setting, I would be able to log into the Fleet UI, navigate to Controls > OS settings > Custom settings and see a list of all my profiles with host counts for each state per profile. This would allow me to take action on hosts that have a failed state (attempt to re-send the profile) or perform manual troubleshooting.

JoStableford commented 3 weeks ago

Linked to Unthread ticket:

Conversation #3015)

ddribeiro commented 3 weeks ago

In addition to UI improvements, we should also consider API endpoints that could return this information.

Something like: GET /api/v1/fleet/custom_settings to show a list of all custom settings and host counts for each state and GET /api/v1/fleet/custom_settings/:id to details about individual custom settings, including arrays of hosts grouped by status.

fleetdm / fleet