SOL-217 Adding basic analytics events logging for courseware search and index

common/lib/xmodule/xmodule/modulestore/courseware_index.py

@@ -3,6 +3,7 @@ from __future__ import absolute_import
 
 import logging
 
+from django.conf import settings
 from django.utils.translation import ugettext as _
 from opaque_keys.edx.locator import CourseLocator
 from search.search_engine_base import SearchEngine
@@ -10,6 +11,7 @@ from search.search_engine_base import SearchEngine
 from . import ModuleStoreEnum
 from .exceptions import ItemNotFoundError
 
+
 # Use default index and document names for now
 INDEX_NAME = "courseware_index"
 DOCUMENT_TYPE = "courseware_content"
@@ -36,6 +38,7 @@ class CoursewareSearchIndexer(object):
         Add to courseware search index from given location and its children
         """
         error_list = []
+        indexed_count = 0
         # TODO - inline for now, need to move this out to a celery task
         searcher = SearchEngine.get_search_engine(INDEX_NAME)
         if not searcher:
@@ -115,6 +118,7 @@ class CoursewareSearchIndexer(object):
                 remove_index_item_location(location)
             else:
                 index_item_location(location, None)
+            indexed_count += 1
         except Exception as err:  # pylint: disable=broad-except
             # broad exception so that index operation does not prevent the rest of the application from working
             log.exception(
@@ -127,9 +131,72 @@ class CoursewareSearchIndexer(object):
         if raise_on_error and error_list:
             raise SearchIndexingError(_('Error(s) present during indexing'), error_list)
 
+        return indexed_count
+
+    @classmethod
+    def do_publish_index(cls, modulestore, location, delete=False, raise_on_error=False):
+        """
+        Add to courseware search index published section and children
+        """
+        indexed_count = cls.add_to_search_index(modulestore, location, delete, raise_on_error)
+        CoursewareSearchIndexer._track_index_request('edx.course.index.published', indexed_count, str(location))
+        return indexed_count
+
     @classmethod
     def do_course_reindex(cls, modulestore, course_key):
         """
         (Re)index all content within the given course
         """
-        return cls.add_to_search_index(modulestore, course_key, delete=False, raise_on_error=True)
+        indexed_count = cls.add_to_search_index(modulestore, course_key, delete=False, raise_on_error=True)
+        CoursewareSearchIndexer._track_index_request('edx.course.index.reindexed', indexed_count)
+        return indexed_count
+
+    @staticmethod
+    def _track_index_request(event_name, indexed_count, location=None):
+        """Track content index requests.
+
+        Arguments:
+            location (str): The ID of content to be indexed.
+            event_name (str):  Name of the event to be logged.
+        Returns:
+            None
+
+        """
+
+        from eventtracking import tracker as track
+        tracker = track.get_tracker()
+        tracking_context = tracker.resolve_context()  # pylint: disable=no-member
+        data = {
+            "indexed_count": indexed_count,
+            'category': 'courseware_index',
+        }
+
+        if location:
+            data['location_id'] = location
+
+        tracker.emit(
+            event_name,
+            data
+        )
+
+        try:
+            if settings.FEATURES.get('SEGMENT_IO_LMS') and hasattr(settings, 'SEGMENT_IO_LMS_KEY'):
+                #Google Analytics - log index content request
+                import analytics
+
+                analytics.track(
+                    event_name,
+                    data,
+                    context={
+                        'Google Analytics': {
+                            'clientId': tracking_context.get('client_id')
+                        }
+                    }
+                )
+        except Exception:  # pylint: disable=broad-except
+            # Capturing all exceptions thrown while tracking analytics events. We do not want
+            # an operation to fail because of an analytics event, so we will capture these
+            # errors in the logs.
+            log.exception(
+                u'Unable to emit {0} event for content indexing.'.format(event_name)
+            )

common/lib/xmodule/xmodule/modulestore/mongo/draft.py

@@ -732,7 +732,7 @@ class DraftModuleStore(MongoModuleStore):
             self.signal_handler.send("course_published", course_key=course_key)
 
         # Now it's been published, add the object to the courseware search index so that it appears in search results
-        CoursewareSearchIndexer.add_to_search_index(self, location)
+        CoursewareSearchIndexer.do_publish_index(self, location)
 
         return self.get_item(as_published(location))
 

common/lib/xmodule/xmodule/modulestore/split_mongo/split_draft.py

@@ -357,7 +357,7 @@ class DraftVersioningModuleStore(SplitMongoModuleStore, ModuleStoreDraftAndPubli
         )
 
         # Now it's been published, add the object to the courseware search index so that it appears in search results
-        CoursewareSearchIndexer.add_to_search_index(self, location)
+        CoursewareSearchIndexer.do_publish_index(self, location)
 
         return self.get_item(location.for_branch(ModuleStoreEnum.BranchName.published), **kwargs)
 

common/lib/xmodule/xmodule/tests/__init__.py

@@ -18,6 +18,8 @@ from lazy import lazy
 from mock import Mock
 from operator import attrgetter
 from path import path
+from eventtracking import tracker
+from eventtracking.django import DjangoTracker
 
 from xblock.field_data import DictFieldData
 from xblock.fields import ScopeIds, Scope, Reference, ReferenceList, ReferenceValueDict
@@ -49,7 +51,6 @@ open_ended_grading_interface = {
     'grading_controller': 'grading_controller',
 }
 
-
 class TestModuleSystem(ModuleSystem):  # pylint: disable=abstract-method
     """
     ModuleSystem for testing
@@ -59,6 +60,8 @@ class TestModuleSystem(ModuleSystem):  # pylint: disable=abstract-method
         kwargs.setdefault('id_reader', id_manager)
         kwargs.setdefault('id_generator', id_manager)
         kwargs.setdefault('services', {}).setdefault('field-data', DictFieldData({}))
+        self.tracker = DjangoTracker()
+        tracker.register_tracker(self.tracker)
         super(TestModuleSystem, self).__init__(**kwargs)
 
     def handler_url(self, block, handler, suffix='', query='', thirdparty=False):