docs: telemetry and metrics refinements (#3885)

* docs: refine telemetry docs Refine services to which telemetry are sent * docs: refine metrics doc Relates to kubeshop/helm-charts#515 (comment)
kubeshop · May 24, 2023 · 6edc02a · 6edc02a
1 parent efa831f
commit 6edc02a
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 2 deletions.
diff --git a/docs/docs/articles/metrics.md b/docs/docs/articles/metrics.md
@@ -15,6 +15,14 @@ The Testkube API Server exposes a `/metrics` endpoint that can be consumed by Pr
 * `testkube_testtriggers_bulk_deletes_count` - The total number of test trigger bulk delete events.
 * `testkube_test_aborts_count` - The total number of tests aborted by type events.
 
+Note: as the metrics also include labels with the associated test name (see below), no metrics are produced unless some tests were run since last api-server restart 
+
+```
+# HELP testkube_test_executions_count The total number of test executions
+# TYPE testkube_test_executions_count counter
+testkube_test_executions_count{name="test-website",result="passed",type="curl-container/test"} 1
+```
+
 ## Installation
 
 If a Prometheus operator is not installed, please follow the steps here: [https://grafana.com/docs/grafana-cloud/quickstart/prometheus_operator/](https://grafana.com/docs/grafana-cloud/quickstart/prometheus_operator/).

diff --git a/docs/docs/articles/telemetry.md b/docs/docs/articles/telemetry.md
@@ -6,7 +6,16 @@ Participation in this program is optional. You may [opt-out](#how-to-opt-out) if
 
 The data collected is always anonymous, not traceable to the source, and only used in aggregate form. 
 
-Telemetry collects and scrambles information about the host when the API server is bootstrapped for the first time. 
+## Dashboard telemetry
+
+The webui dashboard collects user consent and then sends telemetry to the following services:
+* app.posthog.com
+* api.segment.io
+* google analytics
+
+## API-server telemetry
+
+Api server Telemetry collects and scrambles information about the host when the API server is bootstrapped for the first time. 
 
 The collected data looks like this.
 
@@ -30,7 +39,7 @@ The collected data looks like this.
 }
 ```
 
-## What We Collect
+### What We Collect
 
 The telemetry data we use in our metrics is limited to:
 
@@ -41,6 +50,8 @@ The telemetry data we use in our metrics is limited to:
  - The number of people who disable telemetry.
  - The number of unique sessions in the Testkube Dashboard.
 
+It is sent to https://analytics.testkube.io and https://www.google-analytics.com
+
 ## How to Opt Out?
 
 To opt out of the Testkube telemetry collection: