Skip to content

Product analytics instrumentation SDK example code is invalid

Elwyn Benson requested to merge 409027-instrumentation-sdk-example-code into master

What does this MR do and why?

Updates the product analytics example SDK instrumentation code to be valid JavaScript: glClientSDK({ 'value', 'value' }) becomes glClientSDK({ appId: 'value', host: 'value' })

Update applicationId to appId inline with the SDK. This only happens when product_analytics_snowplow_support feature flag is enabled.

Also specify package version 0.0.5 when feature flag is disabled so the Jitsu-supported SDK is used.

Screenshots or screen recordings

before after (FF enabled) after (FF disabled)
image image image

How to set up and validate locally

Note: This feature has a lot of setup steps. If you need help please ask me or I can step through these during a call with you.

  1. Follow these instructions to setup Product Analytics in GDK.
  2. Create a new project.
  3. In the new project, view the Analytics > Dashboards
  4. Click on the Product Analytics Set up button.
  5. When you are presented with the "Instrument your application" instructions, verify the code examples are valid JavaScript

Enable the product_analytics_snowplow_support feature flag

  1. Refresh the page and verify that all applicationId keys have changed to appId

MR acceptance checklist

This checklist encourages us to confirm any changes have been analyzed to reduce risks in quality, performance, reliability, security, and maintainability.

Related to #409027 (closed)

Edited by Elwyn Benson

Merge request reports