fleet/docs/Using Fleet/Usage-statistics.md
Eric 8fb22579ea
Reorganize Fleet documentation (#12871)
Closes: #12611

Changes:
- Added three new documentation sections `/docs/get-started/`,
`/docs/configuration` and `/docs/rest api/`
- Updated folder names: `/docs/Using-Fleet/` » `/docs/Using Fleet` and
`/docs/deploying` » `/docs/deploy/`
- Moved `/docs/using-fleet/process-events.md` to `/articles` and updated
the meta tags to change it into a guide.
- Added support for a new meta tag: `navSection`. This meta tag is used
to organize pages in the sidebar navigation on fleetdm.com/docs
- Moved `docs/using-fleet/application-security.md` and
`docs/using-fleet/security-audits.md` to the security handbook.
- Moved `docs/deploying/load-testing.md` and
`docs/deploying/debugging.md` to the engineering handbook.
- Moved the following files/folders:
- `docs/using-fleet/configuration-files/` »
`docs/configuration/configuration-files/`
- `docs/deploying/configuration.md` »
`docs/configuration/fleet-server-configuration.md`
    -  `docs/using-fleet/rest-api.md` » `docs/rest-api/rest-api.md`
- `docs/using-fleet/monitoring-fleet.md` » `docs/deploy/rest-api.md`
- Updated filenames:
- `docs/using-fleet/permissions.md` »
`docs/using-fleet/manage-access.md`
- `docs/using-fleet/adding-hosts.md` »
`docs/using-fleet/enroll-hosts.md`
    -  `docs/using-fleet/teams.md` » `docs/using-fleet/segment-hosts.md`
- `docs/using-fleet/fleet-ctl-agent-updates.md` »
`docs/using-fleet/update-agents.md`
- `docs/using-fleet/chromeos.md` »
`docs/using-fleet/enroll-chromebooks.md`
- Updated the generated markdown in `server/fleet/gen_activity_doc.go`
and `server/service/osquery_utils/gen_queries_doc.go`
- Updated the navigation sidebar and mobile dropdown links on docs pages
to group pages by their `navSection` meta tag.
- Updated fleetdm.com/docs not to show pages in the `docs/contributing/`
folder in the sidebar navigation
- Added redirects for docs pages that have moved.

.

---------

Co-authored-by: Mike Thomas <mthomas@fleetdm.com>
Co-authored-by: Rachael Shaw <r@rachael.wtf>
2023-07-27 17:40:01 -05:00

3.6 KiB
Raw Blame History

Usage statistics

  In Fleet 4.0, Usage statistics were introduced.

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,
  "hostStatusWebhookEnabled": true,
  "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 instance is optional and can be disabled.

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:

  1. In the top navigation, navigate to Settings > Organization settings.

  2. Scroll to the "Usage statistics" section.

  3. Uncheck the "Enable usage statistics" checkbox and then select "Update settings."