Merge pull request #8322 from cpennington/document-read-metrics

Add metrics around all split-mongo database operations measuring coun…

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

@@ -127,6 +127,7 @@ class SplitBulkWriteRecord(BulkOpsRecord):
         self.modules = defaultdict(dict)
         self.definitions = {}
         self.definitions_in_db = set()
+        self.course_key = None
 
     # TODO: This needs to track which branches have actually been modified/versioned,
     # so that copying one branch to another doesn't update the original branch.
@@ -228,6 +229,7 @@ class SplitBulkWriteMixin(BulkOperationsMixin):
         bulk_write_record.initial_index = self.db_connection.get_course_index(course_key)
         # Ensure that any edits to the index don't pollute the initial_index
         bulk_write_record.index = copy.deepcopy(bulk_write_record.initial_index)
+        bulk_write_record.course_key = course_key
 
     def _end_outermost_bulk_operation(self, bulk_write_record, structure_key, emit_signals=True):
         """
@@ -241,7 +243,7 @@ class SplitBulkWriteMixin(BulkOperationsMixin):
             dirty = True
 
             try:
-                self.db_connection.insert_structure(bulk_write_record.structures[_id])
+                self.db_connection.insert_structure(bulk_write_record.structures[_id], bulk_write_record.course_key)
             except DuplicateKeyError:
                 # We may not have looked up this structure inside this bulk operation, and thus
                 # didn't realize that it was already in the database. That's OK, the store is
@@ -252,7 +254,7 @@ class SplitBulkWriteMixin(BulkOperationsMixin):
             dirty = True
 
             try:
-                self.db_connection.insert_definition(bulk_write_record.definitions[_id])
+                self.db_connection.insert_definition(bulk_write_record.definitions[_id], bulk_write_record.course_key)
             except DuplicateKeyError:
                 # We may not have looked up this definition inside this bulk operation, and thus
                 # didn't realize that it was already in the database. That's OK, the store is
@@ -263,9 +265,13 @@ class SplitBulkWriteMixin(BulkOperationsMixin):
             dirty = True
 
             if bulk_write_record.initial_index is None:
-                self.db_connection.insert_course_index(bulk_write_record.index)
+                self.db_connection.insert_course_index(bulk_write_record.index, bulk_write_record.course_key)
             else:
-                self.db_connection.update_course_index(bulk_write_record.index, from_index=bulk_write_record.initial_index)
+                self.db_connection.update_course_index(
+                    bulk_write_record.index,
+                    from_index=bulk_write_record.initial_index,
+                    course_context=bulk_write_record.course_key
+                )
 
         if dirty and emit_signals:
             self.send_bulk_published_signal(bulk_write_record, structure_key)
@@ -294,7 +300,7 @@ class SplitBulkWriteMixin(BulkOperationsMixin):
         if bulk_write_record.active:
             bulk_write_record.index = index_entry
         else:
-            self.db_connection.insert_course_index(index_entry)
+            self.db_connection.insert_course_index(index_entry, course_key)
 
     def update_course_index(self, course_key, updated_index_entry):
         """
@@ -308,7 +314,7 @@ class SplitBulkWriteMixin(BulkOperationsMixin):
         if bulk_write_record.active:
             bulk_write_record.index = updated_index_entry
         else:
-            self.db_connection.update_course_index(updated_index_entry)
+            self.db_connection.update_course_index(updated_index_entry, course_key)
 
     def get_structure(self, course_key, version_guid):
         bulk_write_record = self._get_bulk_ops_record(course_key)
@@ -317,7 +323,7 @@ class SplitBulkWriteMixin(BulkOperationsMixin):
 
             # The structure hasn't been loaded from the db yet, so load it
             if structure is None:
-                structure = self.db_connection.get_structure(version_guid)
+                structure = self.db_connection.get_structure(version_guid, course_key)
                 bulk_write_record.structures[version_guid] = structure
                 if structure is not None:
                     bulk_write_record.structures_in_db.add(version_guid)
@@ -326,7 +332,7 @@ class SplitBulkWriteMixin(BulkOperationsMixin):
         else:
             # cast string to ObjectId if necessary
             version_guid = course_key.as_object_id(version_guid)
-            return self.db_connection.get_structure(version_guid)
+            return self.db_connection.get_structure(version_guid, course_key)
 
     def update_structure(self, course_key, structure):
         """
@@ -338,7 +344,7 @@ class SplitBulkWriteMixin(BulkOperationsMixin):
         if bulk_write_record.active:
             bulk_write_record.structures[structure['_id']] = structure
         else:
-            self.db_connection.insert_structure(structure)
+            self.db_connection.insert_structure(structure, course_key)
 
     def get_cached_block(self, course_key, version_guid, block_id):
         """
@@ -387,7 +393,7 @@ class SplitBulkWriteMixin(BulkOperationsMixin):
 
             # The definition hasn't been loaded from the db yet, so load it
             if definition is None:
-                definition = self.db_connection.get_definition(definition_guid)
+                definition = self.db_connection.get_definition(definition_guid, course_key)
                 bulk_write_record.definitions[definition_guid] = definition
                 if definition is not None:
                     bulk_write_record.definitions_in_db.add(definition_guid)
@@ -396,7 +402,7 @@ class SplitBulkWriteMixin(BulkOperationsMixin):
         else:
             # cast string to ObjectId if necessary
             definition_guid = course_key.as_object_id(definition_guid)
-            return self.db_connection.get_definition(definition_guid)
+            return self.db_connection.get_definition(definition_guid, course_key)
 
     def get_definitions(self, course_key, ids):
         """
@@ -424,7 +430,7 @@ class SplitBulkWriteMixin(BulkOperationsMixin):
 
         if len(ids):
             # Query the db for the definitions.
-            defs_from_db = self.db_connection.get_definitions(list(ids))
+            defs_from_db = self.db_connection.get_definitions(list(ids), course_key)
             # Add the retrieved definitions to the cache.
             bulk_write_record.definitions.update({d.get('_id'): d for d in defs_from_db})
             definitions.extend(defs_from_db)
@@ -439,7 +445,7 @@ class SplitBulkWriteMixin(BulkOperationsMixin):
         if bulk_write_record.active:
             bulk_write_record.definitions[definition['_id']] = definition
         else:
-            self.db_connection.insert_definition(definition)
+            self.db_connection.insert_definition(definition, course_key)
 
     def version_structure(self, course_key, structure, user_id):
         """
@@ -1206,7 +1212,7 @@ class SplitMongoModuleStore(SplitBulkWriteMixin, ModuleStoreWriteBase):
             'edited_on': course['edited_on']
         }
 
-    def get_definition_history_info(self, definition_locator):
+    def get_definition_history_info(self, definition_locator, course_context=None):
         """
         Because xblocks doesn't give a means to separate the definition's meta information from
         the usage xblock's, this method will get that info for the definition
@@ -1220,7 +1226,7 @@ class SplitMongoModuleStore(SplitBulkWriteMixin, ModuleStoreWriteBase):
             # The supplied locator is of the wrong type, so it can't possibly be stored in this modulestore.
             raise ItemNotFoundError(definition_locator)
 
-        definition = self.db_connection.get_definition(definition_locator.definition_id)
+        definition = self.db_connection.get_definition(definition_locator.definition_id, course_context)
         if definition is None:
             return None
         return definition['edit_info']