github.com/telepresenceio/telepresence/v2@v2.20.0-pro.6.0.20240517030216-236ea954e789/TELEMETRY.md (about) 1 # Telemetry 2 3 Telepresence submits telemetry to Ambassador Labs' systems. 4 These metrics help us understand usage and improve the product; they include information on the user's operating system version, but no identifying information. 5 6 The following metrics are collected: 7 8 | Metric Name | Description | 9 | ------------------------------------- |------------------------------------------------------------------------------------------------------------------------------------------------------| 10 | `intercept_fail` | An attempt to create an intercept has failed. Includes an `error` trait detailing the error. | 11 | `intercept_validation_fail` | There has been an attempt to creat an invalid intercept. Includes an `error` trait detailing the error. | 12 | `intercept_success` | An attempt to create an intercept has succeeded. | 13 | `preview_domain_create_success` | An attempt to add a preview URL to an intercept has succeeded. | 14 | `preview_domain_create_fail` | An attempt to add a preview URL to an intercept has failed. Includes an `error` trait. | 15 | `Used legacy syntax` | A [legacy command](https://www.telepresence.io/docs/latest/install/migrate-from-legacy/#using-legacy-telepresence-commands) has been used. | 16 | `incluster_dns_queries` | Number of queries made by Telepresence to resolve a name to a cluster service (e.g. `kubernetes.default`). Inclues a `total` and a `failures` trait. | 17 | `connect` | Telepresence has attempted to connect to the cluster. Includes `time_to_connect`, `mapped_namespaces`, and `manager_version` | 18 | `connect_error` | Telepresence has failed to connect to the cluster. Includes `error`, `error_type`, `error_category`, `time_to_fail`, and `mapped_namespaces`. | 19 | `updated_routes` | Telepresence has updated the routes on the client machine. Includes `cluster_`, `also_proxy_`, `never_proxy_` and `allow_conflicting_subnets` traits | 20 | `login_failure` | A `telepresence login` has failed. Includes an `error` trait detailing the error, and a `method` trait detailing the login method. | 21 | `login_interrupted` | A `telepresence login` has been interrupted by the user, includes a `method` trait detailing the login method. | 22 | `login_success` | A `telepresence login` has succeded, includes a `method` trait detailing the login method. | 23 | `used_gather_logs` | A `telepresence gather-logs` command has been used. | 24 | `vpn_diag_error` | A `telepresence test-vpn` command has been used and has resulted in an error. | 25 | `vpn_diag_fail` | A `telepresence test-vpn` command has been used; no error, but it reports a misconfigured network. Includes traits detailing the failure. | 26 | `vpn_diag_pass` | A `telepresence test-vpn` command has been used and reported no misconfigurations. | 27 | `connector_remove_intercept_success` | The user daemon has successfully removed an intercept | 28 | `connector_remove_intercept_fail` | The user daemon has failed to remove an intercept. Includes an `error` trait describing the failure. | 29 | `connector_create_intercept_success` | The user daemon has successfully created an intercept | 30 | `connector_create_intercept_fail` | The user daemon has failed to create an intercept. Includes an `error` trait describing the failure. | 31 | `connector_can_intercept_success` | The user daemon has validated that an intercept can be created. | 32 | `connector_can_intercept_fail` | The user daemon has determined that an intercept can't be created. Includes an `error` trait describing the reason. | 33 | `pro_connector_upgrade_refusal` | The upgrade to the pro connector was refused by the user. Includes an `first_install` boolean trait. | 34 | `pro_connector_upgrade_success` | The upgrade to the pro connector succeeded. Includes an `first_install` boolean trait. | 35 | `pro_connector_upgrade_fail` | The upgrade to the pro connector failed. Includes an `error` trait describing the failure and a `first_install` boolean trait. | 36 | `helm_install_success` | helm install success, contains key: "upgrade", value: bool | 37 | `helm_install_failure` | helm install failure, contains key: "upgrade", value: bool, contains key: "error", value: string |