USAGE_DATA.md

August 4, 2023 ยท View on GitHub

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.

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

CommandData
odo initComponent Type, Devfile Name, Language, Project Type, Interactive Mode (bool)
odo devComponent Type, Devfile Name, Language, Project Type, Platform (podman, kubernetes, openshift), Platform version
odo deployComponent Type, Devfile Name, Language, Project Type, Platform (kubernetes, openshift), Platform version
odo <create/set/delete> namespaceCluster 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.

PageData
YAML (main page)Page accessed, UI started, Devfile saved to disk, Devfile cleared, Devfile applied
MetadataPage accessed, Metadata applied
CommandsPage accessed, Start create command, Create command
EventsPage accessed, Add event
ContainersPage accessed, Create container
ImagesPage accessed, Create Image
ResourcesPage accessed, Create Resource

odo v2

CommandData
odo createComponent Type, Devfile name
odo pushComponent 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.