Skip to content

Commit d5b9f43

Browse files
authored
docs(telemetry): update telemetry payload documentation (#400)
## Summary Update telemetry documentation to reflect the new split architecture between cozystack-operator and cozystack-controller. ## Changes - Document that telemetry is now collected by two components - Update example payload with new metrics format - Add `cozy_cluster_capacity` metric (cpu, memory, GPU) - Add `cozy_package_info` metric for installed packages - Replace `cozy_workloads_count` with `cozy_application_count` - Remove `cozy_tenants_count` (now `cozy_application_count{kind="Tenant"}`) ## Related Depends on: cozystack/cozystack#1869 ## Test plan - [ ] Review rendered documentation - [ ] Verify payload examples are accurate
2 parents 1dcc6c0 + 439f23f commit d5b9f43

1 file changed

Lines changed: 25 additions & 10 deletions

File tree

content/en/docs/operations/configuration/telemetry.md

Lines changed: 25 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -18,29 +18,44 @@ Cozystack, as an open source project, thrives on community feedback and usage in
1818

1919
Cozystack strives to comply with the [LF Telemetry Data Policy](https://www.linuxfoundation.org/legal/telemetry-data-policy), ensuring responsible data collection practices that respect user privacy and transparency.
2020

21-
Our focus is on gathering non-personal usage metrics about Cozystack components rather than personal user information. We specifically collect information on the most commonly used application packages, the bundle names in use, enabled Cozystack features, as well as kernel versions and operating systems running in the environment. This collected data helps us gain insights into prevalent configurations and usage trends across installations.
21+
Our focus is on gathering non-personal usage metrics about Cozystack components rather than personal user information. We specifically collect information about cluster infrastructure (nodes, storage, networking), installed packages, and application instances. This collected data helps us gain insights into prevalent configurations and usage trends across installations.
22+
23+
Telemetry is collected by two components:
24+
- **cozystack-operator** — collects cluster-level metrics (nodes, storage, packages)
25+
- **cozystack-controller** — collects application-level metrics (deployed application instances)
2226

2327
For a detailed view of what data is collected, you can review the telemetry implementation:
2428
- [Telemetry Client](https://github.com/cozystack/cozystack/tree/main/internal/telemetry)
2529
- [Telemetry Server](https://github.com/cozystack/cozystack-telemetry-server/)
2630

2731
### Example of Telemetry Payload:
2832

29-
Below is how a typical telemetry payload looks like in Cozystack:
33+
Below is how a typical telemetry payload looks like in Cozystack.
34+
35+
**From cozystack-operator** (cluster infrastructure):
3036

3137
```prometheus
32-
cozy_cluster_info{cozystack_version="v0.22.0",kubernetes_version="v1.31.4",oidc_enabled="true",bundle_name="paas-full",bunde_enable="",bunde_disable=""} 1
38+
cozy_cluster_info{cozystack_version="v1.0.0",kubernetes_version="v1.31.4"} 1
3339
cozy_nodes_count{os="linux (Talos (v1.8.4))",kernel="6.6.64-talos"} 3
40+
cozy_cluster_capacity{resource="cpu"} 168
41+
cozy_cluster_capacity{resource="memory"} 811020009472
42+
cozy_cluster_capacity{resource="nvidia.com/TU104GL_TESLA_T4"} 3
3443
cozy_loadbalancers_count 1
35-
cozy_tenants_count 2
3644
cozy_pvs_count{driver="linstor.csi.linbit.com",size="5Gi"} 7
3745
cozy_pvs_count{driver="linstor.csi.linbit.com",size="10Gi"} 6
38-
cozy_pvs_count{driver="linstor.csi.linbit.com",size="25Gi"} 2
39-
cozy_workloads_count{uid="6099a6ff-87bd-463b-9deb-6b8dcdc7c47b",kind="etcd",type="etcd",version="2.4.0"} 3
40-
cozy_workloads_count{uid="17808511-372f-4cb5-ab1e-b3693118df77",kind="ingress",type="controller",version="1.4.0"} 2
41-
cozy_workloads_count{uid="994df12f-ed0d-4bd2-988e-955b9fa5d451",kind="kubernetes",type="control-plane",version="0.15.0"} 2
42-
cozy_workloads_count{uid="532cc3b0-84d1-4ad2-be4f-3c5c08c93633",kind="kubernetes",type="worker",version="0.15.0"} 10
43-
cozy_workloads_count{uid="d0e0fa40-38bd-4e86-9d24-6c8e2f16434c",kind="postgres",type="postgres",version="0.8.0"} 2
46+
cozy_package_info{name="cozystack.core",variant="default"} 1
47+
cozy_package_info{name="cozystack.storage",variant="linstor"} 1
48+
cozy_package_info{name="cozystack.monitoring",variant="default"} 1
49+
```
50+
51+
**From cozystack-controller** (application instances):
52+
53+
```prometheus
54+
cozy_application_count{kind="Tenant"} 2
55+
cozy_application_count{kind="Postgres"} 5
56+
cozy_application_count{kind="Redis"} 3
57+
cozy_application_count{kind="Kubernetes"} 2
58+
cozy_application_count{kind="VirtualMachine"} 0
4459
```
4560

4661
Data is collected by components running within Cozystack that periodically gather and transmit usage statistics to our secure backend. The telemetry system ensures that data is anonymized, aggregated, and stored securely, with strict controls on access to protect user privacy.

0 commit comments

Comments
 (0)