Add metrics around old ORA requests

common/lib/xmodule/xmodule/open_ended_grading_classes/controller_query_service.py

@@ -1,3 +1,5 @@
+from dogapi import dog_stats_api
+
 import logging
 from .grading_service_module import GradingService
 
@@ -9,33 +11,28 @@ class ControllerQueryService(GradingService):
     Interface to controller query backend.
     """
 
+    METRIC_NAME = 'edxapp.open_ended_grading.controller_query_service'
+
     def __init__(self, config, system):
         config['system'] = system
         super(ControllerQueryService, self).__init__(config)
         self.url = config['url'] + config['grading_controller']
         self.login_url = self.url + '/login/'
         self.check_eta_url = self.url + '/get_submission_eta/'
-        self.is_unique_url = self.url + '/is_name_unique/'
         self.combined_notifications_url = self.url + '/combined_notifications/'
         self.grading_status_list_url = self.url + '/get_grading_status_list/'
         self.flagged_problem_list_url = self.url + '/get_flagged_problem_list/'
         self.take_action_on_flags_url = self.url + '/take_action_on_flags/'
 
-    def check_if_name_is_unique(self, location, problem_id, course_id):
-        params = {
-            'course_id': course_id,
-            'location': location,
-            'problem_id': problem_id
-        }
-        response = self.get(self.is_unique_url, params)
-        return response
-
     def check_for_eta(self, location):
         params = {
             'location': location,
         }
-        response = self.get(self.check_eta_url, params)
-        return response
+        data = self.get(self.check_eta_url, params)
+        self._record_result('check_for_eta', data)
+        dog_stats_api.histogram(self._metric_name('check_for_eta.eta'), data.get('eta', 0))
+
+        return data
 
     def check_combined_notifications(self, course_id, student_id, user_is_staff, last_time_viewed):
         params = {
@@ -45,25 +42,48 @@ def check_combined_notifications(self, course_id, student_id, user_is_staff, las
             'last_time_viewed': last_time_viewed,
         }
         log.debug(self.combined_notifications_url)
-        response = self.get(self.combined_notifications_url, params)
-        return response
+        data = self.get(self.combined_notifications_url, params)
+
+        tags = [u'course_id:{}'.format(course_id), u'user_is_staff:{}'.format(user_is_staff)]
+        tags.extend(
+            u'{}:{}'.format(key, value)
+            for key, value in data.items()
+            if key not in ('success', 'version', 'error')
+        )
+        self._record_result('check_combined_notifications', data, tags)
+        return data
 
     def get_grading_status_list(self, course_id, student_id):
         params = {
             'student_id': student_id,
             'course_id': course_id,
         }
 
-        response = self.get(self.grading_status_list_url, params)
-        return response
+        data = self.get(self.grading_status_list_url, params)
+
+        tags = [u'course_id:{}'.format(course_id)]
+        self._record_result('get_grading_status_list', data, tags)
+        dog_stats_api.histogram(
+            self._metric_name('get_grading_status_list.length'),
+            len(data.get('problem_list', [])),
+            tags=tags
+        )
+        return data
 
     def get_flagged_problem_list(self, course_id):
         params = {
             'course_id': course_id,
         }
 
-        response = self.get(self.flagged_problem_list_url, params)
-        return response
+        data = self.get(self.flagged_problem_list_url, params)
+
+        tags = [u'course_id:{}'.format(course_id)]
+        self._record_result('get_flagged_problem_list', data, tags)
+        dog_stats_api.histogram(
+            self._metric_name('get_flagged_problem_list.length'),
+            len(data.get('flagged_submissions', []))
+        )
+        return data
 
     def take_action_on_flags(self, course_id, student_id, submission_id, action_type):
         params = {
@@ -73,8 +93,11 @@ def take_action_on_flags(self, course_id, student_id, submission_id, action_type
             'action_type': action_type
         }
 
-        response = self.post(self.take_action_on_flags_url, params)
-        return response
+        data = self.post(self.take_action_on_flags_url, params)
+
+        tags = [u'course_id:{}'.format(course_id), u'action_type:{}'.format(action_type)]
+        self._record_result('take_action_on_flags', data, tags)
+        return data
 
 
 class MockControllerQueryService(object):
@@ -85,14 +108,6 @@ class MockControllerQueryService(object):
     def __init__(self, config, system):
         pass
 
-    def check_if_name_is_unique(self, *args, **kwargs):
-        """
-        Mock later if needed.  Stub function for now.
-        @param params:
-        @return:
-        """
-        pass
-
     def check_for_eta(self, *args, **kwargs):
         """
         Mock later if needed.  Stub function for now.
@@ -102,15 +117,47 @@ def check_for_eta(self, *args, **kwargs):
         pass
 
     def check_combined_notifications(self, *args, **kwargs):
-        combined_notifications = '{"flagged_submissions_exist": false, "version": 1, "new_student_grading_to_view": false, "success": true, "staff_needs_to_grade": false, "student_needs_to_peer_grade": true, "overall_need_to_check": true}'
+        combined_notifications = {
+            "flagged_submissions_exist": False,
+            "version": 1,
+            "new_student_grading_to_view": False,
+            "success": True,
+            "staff_needs_to_grade": False,
+            "student_needs_to_peer_grade": True,
+            "overall_need_to_check": True
+        }
         return combined_notifications
 
     def get_grading_status_list(self, *args, **kwargs):
-        grading_status_list = '{"version": 1, "problem_list": [{"problem_name": "Science Question -- Machine Assessed", "grader_type": "NA", "eta_available": true, "state": "Waiting to be Graded", "eta": 259200, "location": "i4x://MITx/oe101x/combinedopenended/Science_SA_ML"}, {"problem_name": "Humanities Question -- Peer Assessed", "grader_type": "NA", "eta_available": true, "state": "Waiting to be Graded", "eta": 259200, "location": "i4x://MITx/oe101x/combinedopenended/Humanities_SA_Peer"}], "success": true}'
+        grading_status_list = {
+            "version": 1,
+            "problem_list": [
+                {
+                    "problem_name": "Science Question -- Machine Assessed",
+                    "grader_type": "NA",
+                    "eta_available": True,
+                    "state": "Waiting to be Graded",
+                    "eta": 259200,
+                    "location": "i4x://MITx/oe101x/combinedopenended/Science_SA_ML"
+                }, {
+                    "problem_name": "Humanities Question -- Peer Assessed",
+                    "grader_type": "NA",
+                    "eta_available": True,
+                    "state": "Waiting to be Graded",
+                    "eta": 259200,
+                    "location": "i4x://MITx/oe101x/combinedopenended/Humanities_SA_Peer"
+                }
+            ],
+            "success": True
+        }
         return grading_status_list
 
     def get_flagged_problem_list(self, *args, **kwargs):
-        flagged_problem_list = '{"version": 1, "success": false, "error": "No flagged submissions exist for course: MITx/oe101x/2012_Fall"}'
+        flagged_problem_list = {
+            "version": 1,
+            "success": False,
+            "error": "No flagged submissions exist for course: MITx/oe101x/2012_Fall"
+        }
         return flagged_problem_list
 
     def take_action_on_flags(self, *args, **kwargs):
@@ -131,5 +178,4 @@ def convert_seconds_to_human_readable(seconds):
     else:
         human_string = "{0} days".format(round(seconds / (60 * 60 * 24), 1))
 
-    eta_string = "{0}".format(human_string)
-    return eta_string
+    return human_string

common/lib/xmodule/xmodule/open_ended_grading_classes/grading_service_module.py

@@ -2,9 +2,10 @@
 import json
 import logging
 import requests
+from dogapi import dog_stats_api
 from requests.exceptions import RequestException, ConnectionError, HTTPError
 
-from .combined_open_ended_rubric import CombinedOpenEndedRubric
+from .combined_open_ended_rubric import CombinedOpenEndedRubric, RubricParsingError
 from lxml import etree
 
 log = logging.getLogger(__name__)
@@ -44,40 +45,66 @@ def _login(self):
 
         return response.json()
 
+    def _metric_name(self, suffix):
+        """
+        Return a metric name for datadog, using `self.METRIC_NAME` as
+        a prefix, and `suffix` as the suffix.
+
+        Arguments:
+            suffix (str): The metric suffix to use.
+        """
+        return '{}.{}'.format(self.METRIC_NAME, suffix)
+
+    def _record_result(self, action, data, tags=None):
+        """
+        Log results from an API call to an ORA service to datadog.
+
+        Arguments:
+            action (str): The ORA action being recorded.
+            data (dict): The data returned from the ORA service. Should contain the key 'success'.
+            tags (list): A list of tags to attach to the logged metric.
+        """
+        if tags is None:
+            tags = []
+
+        tags.append(u'result:{}'.format(data.get('success', False)))
+        tags.append(u'action:{}'.format(action))
+        dog_stats_api.increment(self._metric_name('request.count'), tags=tags)
+
     def post(self, url, data, allow_redirects=False):
         """
-        Make a post request to the grading controller
+        Make a post request to the grading controller. Returns the parsed json results of that request.
         """
         try:
             op = lambda: self.session.post(url, data=data,
                                            allow_redirects=allow_redirects)
-            r = self._try_with_login(op)
-        except (RequestException, ConnectionError, HTTPError) as err:
+            response_json = self._try_with_login(op)
+        except (RequestException, ConnectionError, HTTPError, ValueError) as err:
             # reraise as promised GradingServiceError, but preserve stacktrace.
             #This is a dev_facing_error
             error_string = "Problem posting data to the grading controller.  URL: {0}, data: {1}".format(url, data)
             log.error(error_string)
             raise GradingServiceError(error_string)
 
-        return r.text
+        return response_json
 
     def get(self, url, params, allow_redirects=False):
         """
-        Make a get request to the grading controller
+        Make a get request to the grading controller. Returns the parsed json results of that request.
         """
         op = lambda: self.session.get(url,
                                       allow_redirects=allow_redirects,
                                       params=params)
         try:
-            r = self._try_with_login(op)
-        except (RequestException, ConnectionError, HTTPError) as err:
+            response_json = self._try_with_login(op)
+        except (RequestException, ConnectionError, HTTPError, ValueError) as err:
             # reraise as promised GradingServiceError, but preserve stacktrace.
             #This is a dev_facing_error
             error_string = "Problem getting data from the grading controller.  URL: {0}, params: {1}".format(url, params)
             log.error(error_string)
             raise GradingServiceError(error_string)
 
-        return r.text
+        return response_json
 
     def _try_with_login(self, operation):
         """
@@ -101,35 +128,29 @@ def _try_with_login(self, operation):
             response = operation()
             response.raise_for_status()
 
-        return response
+        return resp_json
 
     def _render_rubric(self, response, view_only=False):
         """
-        Given an HTTP Response with the key 'rubric', render out the html
+        Given an HTTP Response json with the key 'rubric', render out the html
         required to display the rubric and put it back into the response
 
         returns the updated response as a dictionary that can be serialized later
 
         """
         try:
-            response_json = json.loads(response)
-        except:
-            response_json = response
-
-        try:
-            if 'rubric' in response_json:
-                rubric = response_json['rubric']
+            if 'rubric' in response:
+                rubric = response['rubric']
                 rubric_renderer = CombinedOpenEndedRubric(self.system, view_only)
                 rubric_dict = rubric_renderer.render_rubric(rubric)
                 success = rubric_dict['success']
                 rubric_html = rubric_dict['html']
-                response_json['rubric'] = rubric_html
-            return response_json
+                response['rubric'] = rubric_html
+            return response
         # if we can't parse the rubric into HTML,
-        except etree.XMLSyntaxError, RubricParsingError:
+        except (etree.XMLSyntaxError, RubricParsingError):
             #This is a dev_facing_error
-            log.exception("Cannot parse rubric string. Raw string: {0}"
-            .format(rubric))
+            log.exception("Cannot parse rubric string. Raw string: {0}".format(response['rubric']))
             return {'success': False,
                     'error': 'Error displaying submission'}
         except ValueError:

common/lib/xmodule/xmodule/open_ended_grading_classes/openendedchild.py

@@ -533,10 +533,6 @@ def check_for_url_in_text(self, string):
     def get_eta(self):
         if self.controller_qs:
             response = self.controller_qs.check_for_eta(self.location_string)
-            try:
-                response = json.loads(response)
-            except:
-                pass
         else:
             return ""