mirror of
https://github.com/redhat-developer/odo.git
synced 2025-10-19 03:06:19 +03:00
b93a75c11a
* Make UI not experimental * Display API and UI URLs * Remove link to old sources * Fix integration tests * Add UI to Usage Data * Add a "Using the GUI to edit the Devfile" page to doc * Add link to odo.dev specific page * Apply suggestions from code review Co-authored-by: Armel Soro <armel@rm3l.org> * Change favicon with odo logo * Display web console URL as part of the Dev status * Update UI static files * Document that Comments not supported * Add UI screenshots --------- Co-authored-by: Armel Soro <armel@rm3l.org>
70 lines
3.3 KiB
Markdown
70 lines
3.3 KiB
Markdown
Usage Data
|
|
---
|
|
|
|
You can help improve `odo` by allowing it to collect usage data.
|
|
Read more about our privacy statement in this article on [developers.redhat.com](https://developers.redhat.com/article/tool-data-collection).
|
|
|
|
If the user has consented to `odo` collecting usage data, the following data will be collected when a command is executed -
|
|
|
|
* Command Name
|
|
* Command Duration
|
|
* Command Success
|
|
* Pseudonymized error message and error type (in case of failure)
|
|
* Whether the command was run from a terminal
|
|
* Whether the command was run in experimental mode
|
|
* `odo` version in use
|
|
|
|
In addition to this, the following data about user's identity is also noted -
|
|
* OS type
|
|
* Timezone
|
|
* Locale
|
|
|
|
The following tables describe the additional information collected by `odo` commands.
|
|
|
|
**odo v3**
|
|
|
|
| Command | Data |
|
|
|-----------------------------------|-----------------------------------------------------------------------------------------------------------------|
|
|
| odo init | Component Type, Devfile Name, Language, Project Type, Interactive Mode (bool) |
|
|
| odo dev | Component Type, Devfile Name, Language, Project Type, Platform (podman, kubernetes, openshift), Platform version|
|
|
| odo deploy | Component Type, Devfile Name, Language, Project Type, Platform (kubernetes, openshift), Platform version |
|
|
| odo <create/set/delete> namespace | Cluster Type (Possible values: OpenShift 3, OpenShift 4, Kubernetes) |
|
|
|
|
**odo v3 GUI**
|
|
|
|
The odo v3 GUI is accessible (by default at http://localhost:20000) when the command `odo dev` is running.
|
|
|
|
| Page | Data
|
|
|----------------------|-------------------------
|
|
| YAML (main page) | Page accessed, UI started, Devfile saved to disk, Devfile cleared, Devfile applied |
|
|
| Metadata | Page accessed, Metadata applied |
|
|
| Commands | Page accessed, Start create command, Create command |
|
|
| Events | Page accessed, Add event |
|
|
| Containers | Page accessed, Create container |
|
|
| Images | Page accessed, Create Image |
|
|
| Resources | Page accessed, Create Resource |
|
|
|
|
**odo v2**
|
|
|
|
| Command | Data |
|
|
|--------------------------|----------------------------------------------------------------------|
|
|
| odo create | Component Type, Devfile name |
|
|
| odo push | Component Type, Cluster Type, Language, Project Type |
|
|
| odo project <create/set> | Cluster Type (Possible values: OpenShift 3, OpenShift 4, Kubernetes) |
|
|
|
|
|
|
All the data collected above is pseudonymized to keep the user information anonymous.
|
|
|
|
Note: Telemetry data is not collected when you run `--help` for commands.
|
|
|
|
### Enable/Disable preference
|
|
|
|
#### Enable
|
|
`odo preference set ConsentTelemetry true`
|
|
|
|
#### Disable
|
|
`odo preference set ConsentTelemetry false`
|
|
|
|
Alternatively you can _disable_ telemetry by setting the `ODO_TRACKING_CONSENT` environment variable to `no`.
|
|
This environment variable will override the `ConsentTelemetry` value set by `odo preference`.
|