From eb0e6c909b40f66f70182e83d2d74e6aaf0f6469 Mon Sep 17 00:00:00 2001 From: Greg Price Date: Wed, 21 May 2014 15:44:12 -0400 Subject: [PATCH] Add page num to forum search tracking log events --- .../internal_data_formats/tracking_logs.rst | 18 ++++++++++-------- lms/lib/comment_client/thread.py | 5 ++++- 2 files changed, 14 insertions(+), 9 deletions(-) diff --git a/docs/en_us/data/source/internal_data_formats/tracking_logs.rst b/docs/en_us/data/source/internal_data_formats/tracking_logs.rst index a585c218dd..ba5b96ddf6 100644 --- a/docs/en_us/data/source/internal_data_formats/tracking_logs.rst +++ b/docs/en_us/data/source/internal_data_formats/tracking_logs.rst @@ -1783,13 +1783,15 @@ After a user executes a text search in the navigation sidebar of the Discussion ``event`` **Fields**: -+---------------------+---------------+---------------------------------------------------------------------+ -| Field | Type | Details | -+=====================+===============+=====================================================================+ -| ``query`` | string | The text entered into the search box by the user. | -+---------------------+---------------+---------------------------------------------------------------------+ -| ``total_results`` | integer | The total number of results matching the query. | -+---------------------+---------------+---------------------------------------------------------------------+ ++---------------------+---------------+----------------------------------------------------------------------------------------------------+ +| Field | Type | Details | ++=====================+===============+====================================================================================================+ +| ``query`` | string | The text entered into the search box by the user. | ++---------------------+---------------+----------------------------------------------------------------------------------------------------+ +| ``page`` | integer | Results are returned in sets of 20 per page. Identifies the page of results requested by the user. | ++---------------------+---------------+----------------------------------------------------------------------------------------------------+ +| ``total_results`` | integer | The total number of results matching the query. | ++---------------------+---------------+----------------------------------------------------------------------------------------------------+ .. _Instructor_Event_Types: @@ -2069,4 +2071,4 @@ members also generate enrollment events. enrollment. When this feature is used to unenroll students from a course, the server emits a ``edx.course.enrollment.deactivated`` for each unenrollment. -For details about the enrollment events, see :ref:`enrollment`. \ No newline at end of file +For details about the enrollment events, see :ref:`enrollment`. diff --git a/lms/lib/comment_client/thread.py b/lms/lib/comment_client/thread.py index bd6f96421a..55c6cc4707 100644 --- a/lms/lib/comment_client/thread.py +++ b/lms/lib/comment_client/thread.py @@ -61,6 +61,7 @@ class Thread(models.Model): if query_params.get('text'): search_query = query_params['text'] course_id = query_params['course_id'] + requested_page = params['page'] total_results = response.get('total_results') # Record search result metric to allow search quality analysis. # course_id is already included in the context for the event tracker @@ -68,13 +69,15 @@ class Thread(models.Model): 'edx.forum.searched', { 'query': search_query, + 'page': requested_page, 'total_results': total_results, } ) log.info( - 'forum_text_search query="{search_query}" course_id={course_id} total_results={total_results}'.format( + 'forum_text_search query="{search_query}" course_id={course_id} page={requested_page} total_results={total_results}'.format( search_query=search_query, course_id=course_id, + requested_page=requested_page, total_results=total_results ) )