Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/content/docs/platform-settings-telemetry.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ Usage telemetry is on by default for new installs and is not a substitute for op

On a new install the first admin to sign in sees a notice naming the destination and both tiers; nothing is sent until an admin has seen it. Admin Settings > Telemetry then shows the destination, a preview of the next report, the last attempt, separate switches for the basic and extended tiers, and an install-ID reset. Turning basic off turns extended off with it.

**Basic** sends only the Gameplane version, the GameServer count and the GameTemplate count. **Extended** adds a random install ID, the Kubernetes minor version, a distribution category, CPU architectures and a node-count band, server counts per official module (custom modules are one combined count), feature adoption flags and bands, the database kind, the UI language, a public signing key and the send time. Every value comes from a fixed set or is a number; names, namespaces, hostnames, addresses and player data are never sent.
**Basic** sends only the Gameplane version, the GameServer count and the GameTemplate count, summed over every cluster the panel manages and can reach. **Extended** adds a random install ID, the Kubernetes minor versions, distribution categories, CPU architectures and a node-count band of those clusters, whether the panel runs on a cluster or standalone, server counts per official module (custom modules are one combined count), feature adoption flags and bands, the database kind, the UI language, a public signing key and the send time. Every value comes from a fixed set or is a number; names, namespaces, hostnames, addresses and player data are never sent.

<DocsSectionList
items={[
Expand Down
4 changes: 2 additions & 2 deletions src/pages/telemetry.astro
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,8 @@ import { withBase } from "../lib/url";
<h2>What is sent</h2>
<p>Two tiers, about once a day, only while an admin has left them on.</p>
<ul>
<li><strong>Basic:</strong> exactly <code>version</code> (Gameplane version), <code>servers</code> (number of GameServers), <code>templates</code> (number of GameTemplates).</li>
<li><strong>Extended (adds only the following):</strong> a random install ID (a UUID generated on the install, not derived from the cluster, host, network or users); environment: Kubernetes minor version, a distribution category (k3s, rke2, k0s, eks, gke, aks, openshift, microk8s, minikube, kind, doks, talos or other), CPU architectures, and a node-count band (1, 2-3, 4-10, 11-50, 51+); game usage: a server count for each official catalog module plus one combined <code>custom</code> count; feature adoption: wake-on-connect, relay tunnel types (frp, tailscale, playit), packet capture, backups, single sign-on, audit forwarding (each yes/no), a registered-cluster band (1, 2-3, 4-10, 11+), database kind (sqlite or postgres) and UI language; the install's public signing key and the time the report was sent.</li>
<li><strong>Basic:</strong> exactly <code>version</code> (Gameplane version), <code>servers</code> (number of GameServers), <code>templates</code> (number of GameTemplates), counted over the local cluster, when there is one, and every registered cluster the panel can reach.</li>
<li><strong>Extended (adds only the following):</strong> a random install ID (a UUID generated on the install, not derived from the cluster, host, network or users); environment, over every cluster the panel can reach: Kubernetes minor versions, distribution categories (k3s, rke2, k0s, eks, gke, aks, openshift, microk8s, minikube, kind, doks, talos or other), CPU architectures, a node-count band over all their nodes (1, 2-3, 4-10, 11-50, 51+), and whether the panel runs on a cluster or standalone; game usage: a server count for each official catalog module plus one combined <code>custom</code> count; feature adoption: wake-on-connect, relay tunnel types (frp, tailscale, playit), packet capture, backups, single sign-on, audit forwarding (each yes/no), a registered-cluster band (1, 2-3, 4-10, 11+), database kind (sqlite or postgres) and UI language; the install's public signing key and the time the report was sent.</li>
<li>Every extended value comes from a fixed set of categories or bands, or is a number, the install ID, the public key or the send time; anything else is sent as <code>other</code>.</li>
</ul>

Expand Down
Loading