Configure the Woopra telemetry plugin

Configure the Woopra Telemetry Plugin to send telemetry from a Red Hat OpenShift Dev Spaces installation to Segment and Woopra. Any Red Hat OpenShift Dev Spaces deployment can use this plugin with a valid Woopra domain and Segment Write key.

Before you begin

  • You have an active oc session with administrative permissions to the OpenShift cluster. See Getting started with the CLI.
  • You have a valid Woopra domain and Segment Write key.

About this task

The devfile v2 for the plugin, plugin.yaml, has four environment variables that can be passed to the plugin:

  • WOOPRA_DOMAIN - The Woopra domain to send events to.
  • SEGMENT_WRITE_KEY - The write key to send events to Segment and Woopra.
  • WOOPRA_DOMAIN_ENDPOINT - If you prefer not to pass in the Woopra domain directly, the plugin gets it from a supplied HTTP endpoint that returns the Woopra Domain.
  • SEGMENT_WRITE_KEY_ENDPOINT - If you prefer not to pass in the Segment write key directly, the plugin gets it from a supplied HTTP endpoint that returns the Segment write key.

Procedure

  1. Deploy the plugin.yaml devfile v2 file to an HTTP server with the environment variables set correctly.
  2. Edit the CheCluster Custom Resource on the cluster: 
    $ oc edit checluster/devspaces -n openshift-devspaces
     
    spec:
  devEnvironments:
    defaultPlugins:
    - editor: che-incubator/che-code/latest
      plugins:
      - '<your_plugin_url>'

    where:

    editor
    The editorId to set the telemetry plugin for.
    plugins
    The URL to the telemetry plugin's devfile v2 definition, for example, https://your-web-server/plugin.yaml.