Adds segment-io integration into the LMS

Tell segment IO whenever a page is loaded. Once this works, we can add more detailed instrumentation for events we care about. Will be turned off in prod until the SEGMENT_IO_LMS feature flag is set to True and a SEGMENT_IO_LMS_KEY is set.

Adds segment-io integration into the LMS
Tell segment IO whenever a page is loaded. Once this works, we can add more detailed instrumentation for events we care about. Will be turned off in prod until the SEGMENT_IO_LMS feature flag is set to True and a SEGMENT_IO_LMS_KEY is set.
4ffe3c51 · Victor Shnayder · Victor Shnayder · 74338450 · 4ffe3c51 · 4ffe3c51
Commit 4ffe3c51 authored May 28, 2013 by Victor Shnayder Committed by Victor Shnayder Jun 06, 2013
Hide whitespace changes
Inline Side-by-side

Showing with 41 additions and 0 deletions

lms/envs/aws.py
+5 -0

lms/envs/common.py
+3 -0

lms/envs/dev.py
+7 -0

lms/templates/main.html
+2 -0

lms/templates/widgets/segment-io.html
+24 -0

No files found.
--- a/lms/envs/aws.py
+++ b/lms/envs/aws.py
@@ -172,6 +172,11 @@ for name, value in ENV_TOKENS.get("CODE_JAIL", {}).items():

 COURSES_WITH_UNSAFE_CODE = ENV_TOKENS.get("COURSES_WITH_UNSAFE_CODE", [])

+# If segment.io key specified, load it and turn on segment IO if the feature flag is set
+SEGMENT_IO_LMS_KEY = ENV_TOKENS.get('SEGMENT_IO_LMS_KEY')
+if SEGMENT_IO_LMS_KEY:
+    MITX_FEATURES['SEGMENT_IO_LMS'] = ENV_TOKENS.get('SEGMENT_IO_LMS', False)
+
 ############################## SECURE AUTH ITEMS ###############
 # Secret things: passwords, access keys, etc.


--- a/lms/envs/common.py
+++ b/lms/envs/common.py
@@ -102,6 +102,9 @@ MITX_FEATURES = {
    # Staff Debug tool.
    'ENABLE_STUDENT_HISTORY_VIEW': True,

+    # segment.io for LMS--need to explicitly turn it on on production.
+    'SEGMENT_IO_LMS': False,
+
    # Enables the student notes API and UI.
    'ENABLE_STUDENT_NOTES': True,


--- a/lms/envs/dev.py
+++ b/lms/envs/dev.py
@@ -244,6 +244,13 @@ MITX_FEATURES['ENABLE_PEARSON_LOGIN'] = False
 ANALYTICS_SERVER_URL = "http://127.0.0.1:9000/"
 ANALYTICS_API_KEY = ""

+##### segment-io  ######
+
+# If there's an environment variable set, grab it and turn on segment io
+SEGMENT_IO_LMS_KEY = os.environ.get('SEGMENT_IO_LMS_KEY')
+if SEGMENT_IO_LMS_KEY:
+    MITX_FEATURES['SEGMENT_IO_LMS'] = True
+

 #####################################################################
 # Lastly, see if the developer has any local overrides.

--- a/lms/templates/main.html
+++ b/lms/templates/main.html
@@ -61,6 +61,8 @@
    % endif
  % endif

+  <%include file="widgets/segment-io.html" />
+
 </head>

 <body class="<%block name='bodyclass'/>">

--- a/lms/templates/widgets/segment-io.html
+++ b/lms/templates/widgets/segment-io.html
+% if settings.MITX_FEATURES.get('SEGMENT_IO_LMS'):
+<!-- begin Segment.io -->
+<script type="text/javascript">
+  var analytics=analytics||[];analytics.load=function(e){var t=document.createElement("script");t.type="text/javascript",t.async=!0,t.src=("https:"===document.location.protocol?"https://":"http://")+"d2dq2ahtl5zl1z.cloudfront.net/analytics.js/v1/"+e+"/analytics.min.js";var n=document.getElementsByTagName("script")[0];n.parentNode.insertBefore(t,n);var r=function(e){return function(){analytics.push([e].concat(Array.prototype.slice.call(arguments,0)))}},i=["identify","track","trackLink","trackForm","trackClick","trackSubmit","pageview","ab","alias","ready"];for(var s=0;s<i.length;s++)analytics[i[s]]=r(i[s])};
+  analytics.load("${ settings.SEGMENT_IO_LMS_KEY }");
+
+  % if user.is_authenticated():
+  analytics.identify("${ user.id }", {
+      email     : "${ user.email }",
+      username  : "${ user.username }"
+  });
+
+  % endif
+</script>
+<!-- end Segment.io -->
+% else:
+<!-- dummy segment.io -->
+<script type="text/javascript">
+  var analytics = {
+    track: function() { return; }
+  };
+</script>
+<!-- end dummy segment.io -->
+% endif