Skip to content

Commit 40ff9b5

Browse files
committed
Note on telemetry and example output
Signed-off-by: Alex Ellis (OpenFaaS Ltd) <[email protected]>
1 parent b36adad commit 40ff9b5

File tree

1 file changed

+36
-0
lines changed

1 file changed

+36
-0
lines changed

docs/deployment/pro.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -230,6 +230,42 @@ Identity and Access Management (IAM) and Single-Sign On (SSO) are closely relate
230230
* [Identity and Access Management (IAM)](/openfaas-pro/iam/overview)
231231
* [Single-Sign On (SSO)](/openfaas-pro/sso/overview)
232232

233+
### A note on telemetry
234+
235+
Non-confidential telemetry is sent on an automated basis, this summarises the version of Kubernetes being used, the version of the OpenFaaS operator, and the number of functions along with their invocation counts.
236+
237+
Telemetry is required as part of the OpenFaaS Pro license agreement, and is used to help us support customers, improve the product, and to provide you with a better experience.
238+
239+
To view the telemetry data, you can run the following command:
240+
241+
```bash
242+
kubectl port-forward -n openfaas svc/gateway 8080:8080 &
243+
244+
PASSWORD=$(kubectl get secret -n openfaas basic-auth -o jsonpath="{.data.basic-auth-password}" | base64 --decode; echo)
245+
curl -s http://admin:$PASSWORD@127.0.0.1:8080/system/telemetry|jq
246+
```
247+
248+
Example output from a test cluster:
249+
250+
```json
251+
{
252+
"s": "0.0.2",
253+
"v": "0.5.61-8-gc2c68d17",
254+
"data": {
255+
"uptime": 5717804906149224,
256+
"license_email": "[email protected]",
257+
"namespace": "openfaas",
258+
"operator_version": "0.5.61-8-gc2c68d17",
259+
"k8s_version": "v1.29.3+k3s1",
260+
"total_fns": 24,
261+
"total_namespaces": 4,
262+
"total_replicas": 20,
263+
"invocations_daily": 3.000266226477385,
264+
"seconds_daily": 0.014143783188987933
265+
}
266+
}
267+
```
268+
233269
## A note on upgrading from established OpenFaaS CE installations
234270

235271
For a smooth upgrade experience, we recommend that you test the initial upgrade in a temporary or pre-production environment before rolling out to production.

0 commit comments

Comments
 (0)