f14ab358fe
Closes: #15255 Changes: - Added the usage statistics added in https://github.com/fleetdm/fleet/pull/14216 to the inputs of the `receive-usage-analytics` webhook. - Updated the `receive-usage-analytics` webhook to send the new usage statistics to Datadog. - Added attributes for the new usage statistics to the `HistoricalUsageSnapshot` model. - Removed the `columnName` from the `hostsStatusWebHookEnabled` attribute of the `HistoricalUsageSnapshot` model, the name of this column will be changed in the database when the new columns are added to the databse table. - Updated the usage statistics documentation to have the new statistics. This PR requires database migrations. When this is approved and ready to merge, we will need to: - [ ] Merge this PR - [ ] Put fleetdm.com into maintenance mode while the "Deploy Fleet website" GH action runs. - [ ] Add the new columns to the database table - [ ] Change the name of the `hostStatusWebhookEnabled` column to `hostsStatusWebHookEnabled` - [ ] Set the default values for the new columns on the existing records. - [ ] When the website has finished redeploying, take it out of maintenance mode.
3.9 KiB
Usage statistics
Fleet Device Management Inc. periodically collects information about your instance.
What is included in usage statistics in Fleet?
Below is the JSON payload that is sent to Fleet Device Management Inc:
{
"anonymousIdentifier": "9pnzNmrES3mQG66UQtd29cYTiX2+fZ4CYxDvh495720=",
"fleetVersion": "x.x.x",
"licenseTier": "free",
"organization": "Fleet",
"numHostsEnrolled": 999,
"numUsers": 999,
"numTeams": 999,
"numPolicies": 999,
"numLabels": 999,
"softwareInventoryEnabled": true,
"vulnDetectionEnabled": true,
"systemUsersEnabled": true,
"hostsStatusWebHookEnabled": true,
"mdmMacOsEnabled": true,
"hostExpiryEnabled": true,
"mdmWindowsEnabled": false,
"liveQueryDisabled": false,
"numWeeklyActiveUsers": 999,
"numWeeklyPolicyViolationDaysActual": 999,
"numWeeklyPolicyViolationDaysPossible": 999,
"hostsEnrolledByOperatingSystem": {
"darwin": [
{
"version": "macOS 12.3.1",
"numEnrolled": 999
},
...
],
"windows": [
{
"version": "Microsoft Windows 10, version 21H2 (W)",
"numEnrolled": 999
},
...
],
"ubuntu": [
{
"version": "Ubuntu 22.04 'Jammy Jellyfish' (LTS)",
"numEnrolled": 999
},
...
],
"rhel": [
{
"version": "Red Hat Enterprise Linux 8.4.0",
"numEnrolled": 999
},
...
],
"debian": [
{
"version": "Debian GNU/Linux 9.0.0",
"numEnrolled": 999
},
...
],
"amzn": [
{
"version": "Amazon Linux 2.0.0",
"numEnrolled": 999
},
...
]
},
"hostsEnrolledByOrbitVersion": [
{
"version": "1.1.0",
"numHosts": 999
},
...
],
"hostsEnrolledByOsqueryVersion": [
{
"version": "4.9.0",
"numHosts": 999
},
...
],
"storedErrors": [
{
"count": 3,
"loc": [
"github.com/fleetdm/fleet/v4/server/example.example:12",
"github.com/fleetdm/fleet/v4/server/example.example:130",
]
},
...
],
"numHostsNotResponding": 9
}
Statistics contain no personal information about any particular device or person.
For Fleet Free instances, usage statistics are anonymous. The "organization" property is reported as "unknown."
Sending Usage statistics from your Fleet Free instance is optional and can be disabled.
Note: Usage statistics are not optional for Fleet Premium instances.
Why should we enable usage statistics?
Help make Fleet better! Fleet has wide adoption, but limited avenues for quantifying this. We need a way of measuring whether the enhancements and new features we ship are actually working.
Every time we ship a Fleet release without usage statistics, it's like launching a shiny, expensive new rocket into space without any way to find out what happens to it. Up until now, we've relied heavily on talking to users and working closely with customers and other community members. That's helped a lot! But it doesn't give us visibility into the problems other users might be having.
Insights about Fleet version adoption helps the team be more efficient when planning upgrade guides, release notes, and future security notices for users running vulnerable software versions.
Disable usage statistics
Users with the Admin role can disable usage statistics.
To disable usage statistics:
-
In the top navigation, navigate to Settings > Organization settings.
-
Scroll to the "Usage statistics" section.
-
Uncheck the "Enable usage statistics" checkbox and then select "Update settings."
Usage statistics can also be disabled via configuration files.