DataDog RUM + Events (#225)

* DataDog RUM + Events

* THE RIGHT INFORMATION ON THE FILE

* Fix: Travis Build

* Fix: Travis Build

* Added all of the ga events + some more other ones that weren't just inside scheduleActionsDirective.js

* Few more events + linter

* Took out some unnececarry events

Author: Dr-N0

README.md

@@ -17,25 +17,26 @@ Available at [schedule.csh.rit.edu](https://schedule.csh.rit.edu)
 ## Dev Environment
 
 ### Setup
-- Fork and clone the repository
-- Copy the `config.example.php` file to `config.php` in `/inc/` or set environment variables as defined in `config.env.php`
-- Contact a current maintainer for server/database configs
-- If you wish to see images locally, you will also need S3 credentials, either supply your own or reach out
+- Fork and clone the repository.
+- Copy the `config.example.php` file to `config.php` in `/inc/` or set environment variables as defined in `config.env.php`.
+- Contact a current maintainer for server/database configs.
+- If you wish to see images locally, you will also need S3 credentials, either supply your own or reach out.
 
 ### Run Locally
-In order to run locally youre going to need [docker](https://www.docker.com/)
+In order to run locally youre going to need [docker](https://www.docker.com/).
 
 ```
 docker build -t schedulemaker .
 docker run --rm -i -t -p 5000:8080 --name=schedulemaker schedulemaker
 ```
 
-You can replace `5000` with whatever port you wish to connect locally to. Then visit `http://localhost:5000` in a browser
+You can replace `5000` with whatever port you wish to connect locally to. Then visit `http://localhost:5000` in a browser.
 
 ### Development
-- To build js files run `npm run-script build`
-- Increment the version number in `package.json` after updating js/css files or ensure all cache cleared
-  - Make sure you increment at least the patch number in any PRs that touch Javascript/CSS
+- To build js files run `npm run-script build`.
+- Increment the version number in `package.json` after updating js/css files or ensure all cache cleared.
+  - Make sure you increment at least the patch number in any PRs that touch Javascript/CSS.
+- If you get an error with JS/CSS not loading, check your config file.
 
 ## Maintainers
 

assets/src/modules/sm/Generate/controllers/GenerateController.js

@@ -160,6 +160,11 @@ angular.module('sm').controller('GenerateController', function ($scope, globalKb
     $http.post('/generate/getMatchingSchedules', $.param(requestData))
       .success(function (data, status, headers, config) {
         ga('send', 'event', 'generate', 'schedule')
+        window.DD_RUM &&
+        DD_RUM.addUserAction('Generate', {
+          type: 'Schedule',
+          data: data
+        })
         $scope.generationStatus = 'D'
 
         // If no errors happened

assets/src/modules/sm/Schedule/directives/scheduleActionsDirective.js

@@ -51,6 +51,10 @@ angular.module('sm').directive('scheduleActions', function ($http, $q, shareServ
       save: function (saveType) {
         if (saveType === 'create') {
           ga('send', 'event', 'schedule', 'save')
+          window.DD_RUM &&
+          DD_RUM.addUserAction('Schedule', {
+            type: 'Save'
+          })
           getSavedInfo().then(function (data) {
             scope.notification = 'This schedule can be accessed at ' +
               '<a href="' + data.url + '" target="_blank">' +
@@ -62,14 +66,23 @@ angular.module('sm').directive('scheduleActions', function ($http, $q, shareServ
           })
         } else {
           ga('send', 'event', 'schedule', 'fork')
-          localStorage.setItem('forkSchedule', scope.schedule)
+          window.DD_RUM &&
+          DD_RUM.addUserAction('Schedule', {
+            type: 'Fork'
+          })
 
+          localStorage.setItem('forkSchedule', scope.schedule)
           $state.go('generate')
         }
       },
 
       shareToService: function ($event, serviceName, newWindow) {
         ga('send', 'event', 'schedule', 'share', serviceName)
+        window.DD_RUM &&
+        DD_RUM.addUserAction('Schedule', {
+          type: 'Share',
+          serviceName: serviceName
+        })
         $event.preventDefault()
         scope.status = 'L'
         if (serviceName && serviceName in shareServiceInfo) {
@@ -87,6 +100,11 @@ angular.module('sm').directive('scheduleActions', function ($http, $q, shareServ
 
       shareToEmail: function ($event) {
         ga('send', 'event', 'schedule', 'share', 'email')
+        window.DD_RUM &&
+        DD_RUM.addUserAction('Schedule', {
+          type: 'Share',
+          subtype: 'Email'
+        })
         $event.preventDefault()
 
         getSavedInfo().then(function (data) {
@@ -100,13 +118,23 @@ angular.module('sm').directive('scheduleActions', function ($http, $q, shareServ
 
       shareToDirectLink: function ($event) {
         ga('send', 'event', 'schedule', 'share', 'link')
+        window.DD_RUM &&
+        DD_RUM.addUserAction('Schedule', {
+          type: 'Share',
+          subtype: 'Link'
+        })
         $event.preventDefault()
 
         scope.scheduleActions.save('create')
       },
 
       downloadiCal: function ($event) {
         ga('send', 'event', 'schedule', 'download', 'iCal')
+        window.DD_RUM &&
+        DD_RUM.addUserAction('Schedule', {
+          type: 'Download',
+          subtype: 'iCal'
+        })
         $event.preventDefault()
 
         getSavedInfo().then(function (data) {
@@ -116,6 +144,11 @@ angular.module('sm').directive('scheduleActions', function ($http, $q, shareServ
 
       downloadImage: function ($event) {
         ga('send', 'event', 'schedule', 'download', 'image')
+        window.DD_RUM &&
+        DD_RUM.addUserAction('Schedule', {
+          type: 'Download',
+          subtype: 'Image'
+        })
         $event.preventDefault()
 
         var popup = openPopup(true)
@@ -128,6 +161,10 @@ angular.module('sm').directive('scheduleActions', function ($http, $q, shareServ
 
       print: function () {
         ga('send', 'event', 'schedule', 'print')
+        window.DD_RUM &&
+        DD_RUM.addUserAction('Schedule', {
+          type: 'Print'
+        })
 
         var reloadSchedule = angular.copy(scope.state.drawOptions)
         reloadSchedule.term = scope.state.requestOptions.term
@@ -142,6 +179,10 @@ angular.module('sm').directive('scheduleActions', function ($http, $q, shareServ
 
       hide: function () {
         ga('send', 'event', 'schedule', 'hide')
+        window.DD_RUM &&
+        DD_RUM.addUserAction('Schedule', {
+          type: 'Hide'
+        })
         const appstate = scope.$parent.$parent.state
         const pageStartIndex = appstate.displayOptions.currentPage * appstate.displayOptions.pageSize
 

assets/src/modules/sm/Search/controllers/SearchController.js

@@ -138,6 +138,13 @@ angular.module('sm').controller('SearchController', function ($scope, $http, ent
         // 'D'one loading
         $scope.searchStatus = 'D'
 
+        ga('send', 'event', 'search', 'find')
+        window.DD_RUM &&
+        DD_RUM.addUserAction('Search', {
+          type: 'Find',
+          data: data
+        })
+
         if (status === 200 && typeof data.error === 'undefined') {
           // Set the results
           $scope.searchResults = data

assets/src/modules/sm/app.js

@@ -76,6 +76,10 @@ angular.module('sm', ['ngAnimate', 'ngSanitize', 'ui.router'])
   .run(function ($rootScope, $window) {
     $rootScope.$on('$stateChangeSuccess', function (evt) {
       ga('send', 'pageview')
+      window.DD_RUM &&
+      DD_RUM.addUserAction('Pageview', {
+        type: 'On Load'
+      })
       $($window).scrollTop(0)
     })
 

inc/config.env.php

@@ -41,7 +41,13 @@
 $GOOGLEANALYTICS = ($SERVER_TYPE == 'production')?
     $get_env(getenv("GOOGLEANALYTICS1"), ''):
     $get_env(getenv("GOOGLEANALYTICS2"), '');
-//
+
+////////////////////////////////////////////////////////////////////////////
+////// DATADOG RUM ANALYTICS
+////
+
+$RUM_CLIENT_TOKEN = $get_env(getenv("RUM_CLIENT_TOKEN"), '');
+$RUM_APPLICATION_ID = $get_env(getenv("RUM_APPLICATION_ID"), '');
 
 ////////////////////////////////////////////////////////////////////////////
 // WORK AROUNDS

index.php

@@ -126,6 +126,16 @@
 
 			ga('create', '<?= $GOOGLEANALYTICS ?>', 'rit.edu');
 		</script>
+		<script
+			src="https://www.datadoghq-browser-agent.com/datadog-rum-us.js"
+			type="text/javascript">
+		</script>
+		<script>
+			window.DD_RUM && window.DD_RUM.init({
+				clientToken: '<?= $RUM_CLIENT_TOKEN ?>',
+				applicationId: '<?= $RUM_APPLICATION_ID ?>',
+			});
+		</script>
 		<script src="//cdnjs.cloudflare.com/ajax/libs/jquery/3.2.1/jquery.min.js"></script>
 		<script src="//cdnjs.cloudflare.com/ajax/libs/mousetrap/1.4.6/mousetrap.min.js"></script>
 		<script src="//cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.7/js/bootstrap.min.js"></script>