Uploaded image for project: 'OpenShift Console'
  1. OpenShift Console
  2. CONSOLE-3943

Configure and load default Segment Api Key and proxy

XMLWordPrintable

    • Icon: Story Story
    • Resolution: Done
    • Icon: Undefined Undefined
    • None
    • None
    • None
    • None
    • OEX OCP Console - Sprint 253

      We want to enable segment analytics by default on all (incl. self-managed) OCP clusters using a known segment API key and the console.redhat.com proxy. We'll still want to allow to honor the segment-related annotations on the console operator config for overriding these values.

      Most likely the segment key should be defaulted in the console operator, otherwise we would need a separate console flag for disabling analytics. If the operator provides the key, then the console backend can use the presence of the key to determine when to enable analytics. We can likely change the segment URL and CDN default values directly in the console code, however.

      ODC-7517 tracks disabling segment analytics when cluster telemetry is disabled, which is a separate change, but required for this work.

      OpenShift UI Telemetry Implementation details
       
      This three keys should have new default values: 

      1. SEGMENT_API_KEY
      2. SEGMENT_API_HOST
      3. SEGMENT_JS_HOST OR SEGMENT_JS_URL

      See https://github.com/openshift/console/blob/master/frontend/packages/console-telemetry-plugin/src/listeners/segment.ts

      Defaults:

      stringData:
        SEGMENT_API_KEY: BnuS1RP39EmLQjP21ko67oDjhbl9zpNU
        SEGMENT_API_HOST: console.redhat.com/connections/api/v1
        SEGMENT_JS_HOST: console.redhat.com/connections/cdn
      

      AC:

      • Add default values for telemetry annotations into a CM in the openshift-console-operator NS.
      • Add and update unit tests and add e2e tests

            jhadvig@redhat.com Jakub Hadvig
            spadgett@redhat.com Samuel Padgett
            YaDan Pei YaDan Pei
            Votes:
            0 Vote for this issue
            Watchers:
            4 Start watching this issue

              Created:
              Updated:
              Resolved: