Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • Rule of thumb: Use server-side events where possible.  More context is available to server-side events.  Server-side events are less likely to have false duplicate events.
  • Call tracker.emit
    • Emits to Tracking Log and downstream tools (e.g. Vertica/Tableau, edX Research Package, etc.)
    • Event must be whitelisted to emit also be emitted to Segment.
      • In turn, Segment emits to other tools: Google Analytics (GA), Google Tag Manager, Optimizely, Qualaroo, Crazy Egg, Marketing tools.
      • Here are sample commits for updating the whitelist for edge.edx.org and the whitelists for edx.org.
      • At this time, it doesn't look like our code supports sending special labels to GA from server-side events.  See /wiki/spaces/AN/pages/30967007 for possibly enhancing this.
  • To send events directly to Segment:
    • This is appropriate when server-side event does not need to appear in tracking logs.
    • Call segment.track(), after "from common.djangoapps.track import segment".
    • If appropriate, also call segment.identify().  Currently the LMS only does this at login/registration.   

Client-side events

  • Rule of thumb: Where you have an option of client-side or server-side event, choose server-side (see above).
  • Logger.log
    • Important: This should be renamed to Tracker.emit, but that requires a deprecation strategy including telling course teams.
    • Emits to Tracking Log and downstream tools (e.g. Vertica/Tableau, edX Research Package, etc.)
    • Event must be whitelisted to emit to Segment (see above).
  • analytics.track
    • Use this if you want Segment and its downstream tools only.  If you want the Tracking Log or both, use the other call (with or without the whitelist).
    • Emits to Segment and its downstream tools.

...

  • Google Analytics (GA)
  • Google Tag Manager
  • Firebase Analytics
  • Fabric (Mobile)
  • Segment (a.k.a. Segment.io)
  • Tracking Log
  • Optimizely (A/B Testing)
  • Qualaroo (survey tool)
  • Crazy Egg (screen recording/heat mapping, may or may not be used)
  • Marketing
    • Sailthru (email marketing)
    • Facebook ad reporting

Diagnostic Tools (includes Performance):

...