Skip to content

E
edx-platform
Commit e396bf88 by Carlos Andrés Rocha
Options

Replace Language with Event Source in the tracking logs documentation 

Also:
  - Add some missing event descriptions
  - Reorganized rows to put relevant events together
parent 779ff4fd
Showing with 71 additions and 70 deletions
docs/data/source/internal_data_formats/tracking_logs.rst
......@@ -59,72 +59,59 @@ The Student Event Type table lists the event types logged for interaction with t
+-----------------------------------+-------------------------------+---------------------+-----------------+---------------------+---------------+---------------------------------------------------------------------+
| Event Type | Description | Component | Language | ``event`` Fields | Type | Details |
| Event Type | Description | Component | Event Source | ``event`` Fields | Type | Details |
+===================================+===============================+=====================+=================+=====================+===============+=====================================================================+
| ``seq_goto`` | Fired when a user jumps | Sequence | CoffeeScript/JS | ``old`` | integer | Index of the unit being jumped from. |
| ``seq_goto`` | Fired when a user jumps | Sequence | Browser | ``old`` | integer | Index of the unit being jumped from. |
| | between units in | | +---------------------+---------------+---------------------------------------------------------------------+
| | a sequence. | | | ``new`` | integer | Index of the unit being jumped to. |
| | | | +---------------------+---------------+---------------------------------------------------------------------+
| | | | | ``id`` | integer | edX ID of the sequence. |
+-----------------------------------+-------------------------------+---------------------+-----------------+---------------------+---------------+---------------------------------------------------------------------+
| ``seq_next`` | Fired when a user navigates | Sequence | CoffeeScript/JS | ``old`` | integer | Index of the unit being navigated |
| ``seq_next`` | Fired when a user navigates | Sequence | Browser | ``old`` | integer | Index of the unit being navigated |
| | to the next unit in a | | | | | away from. |
| | sequence. | | +---------------------+---------------+---------------------------------------------------------------------+
| | | | | ``new`` | integer | Index of the unit being navigated to. |
| | | | +---------------------+---------------+---------------------------------------------------------------------+
| | | | | ``id`` | integer | edX ID of the sequence. |
+-----------------------------------+-------------------------------+---------------------+-----------------+---------------------+---------------+---------------------------------------------------------------------+
| ``seq_prev`` | Fired when a user navigates | Sequence | CoffeeScript/JS | ``old`` | integer | Index of the unit being navigated away |
| ``seq_prev`` | Fired when a user navigates | Sequence | Browser | ``old`` | integer | Index of the unit being navigated away |
| | to the previous unit in a | | | | | from. |
| | sequence. | | +---------------------+---------------+---------------------------------------------------------------------+
| | | | | ``new`` | integer | Index of the unit being navigated to. |
| | | | +---------------------+---------------+---------------------------------------------------------------------+
| | | | | ``id`` | integer | edX ID of the sequence. |
+-----------------------------------+-------------------------------+---------------------+-----------------+---------------------+---------------+---------------------------------------------------------------------+
| ``problem_check`` | Fired when a user wants to | Capa | CoffeeScript/JS | | | The ``event`` field contains the |
| | check a problem. | | | | | values of all input fields from the problem |
| | | | | | | being checked, styled as GET parameters. |
+-----------------------------------+-------------------------------+---------------------+-----------------+---------------------+---------------+---------------------------------------------------------------------+
| ``problem_reset`` | Fired when a problem is | Capa | CoffeeScript/JS | | | |
| | reset. | | | | | |
+-----------------------------------+-------------------------------+---------------------+-----------------+---------------------+---------------+---------------------------------------------------------------------+
| ``problem_show`` | Fired when a problem is | Capa | CoffeeScript/JS | ``problem`` | string | ID of the problem being shown (e.g., |
| | shown. | | | | | i4x://MITx/6.00x/problem/L15:L15_Problem_2). |
+-----------------------------------+-------------------------------+---------------------+-----------------+---------------------+---------------+---------------------------------------------------------------------+
| ``problem_save`` | Fired when a problem is | Capa | CoffeeScript/JS | | | |
| | saved. | | | | | |
+-----------------------------------+-------------------------------+---------------------+-----------------+---------------------+---------------+---------------------------------------------------------------------+
| ``oe_hide_question`` / | | Combined Open-Ended | CoffeeScript/JS | ``location`` | string | The location of the question whose prompt is |
| ``oe_hide_question`` / | | Combined Open-Ended | Browser | ``location`` | string | The location of the question whose prompt is |
| ``oe_hide_problem`` | | | | | | being hidden. |
| ``peer_grading_hide_question`` / | | Peer Grading | | | | |
| ``peer_grading_hide_problem`` | | | | | | |
| ``staff_grading_hide_question`` / | | Staff Grading | | | | |
| ``staff_grading_hide_problem`` | | | | | | |
+-----------------------------------+-------------------------------+---------------------+-----------------+---------------------+---------------+---------------------------------------------------------------------+
| ``oe_show_question`` / | | Combined Open-Ended | CoffeeScript/JS | ``location`` | string | The location of the question whose prompt is |
| ``oe_show_question`` / | | Combined Open-Ended | Browser | ``location`` | string | The location of the question whose prompt is |
| ``oe_show_problem`` | | | | | | being shown. |
| ``peer_grading_show_question`` / | | Peer Grading | | | | |
| ``peer_grading_show_problem`` | | | | | | |
| ``staff_grading_show_question`` / | | Staff Grading | | | | |
| ``staff_grading_show_problem`` | | | | | | |
+-----------------------------------+-------------------------------+---------------------+-----------------+---------------------+---------------+---------------------------------------------------------------------+
| ``rubric_select`` | | Combined Open-Ended | CoffeeScript/JS | ``location`` | string | The location of the question whose rubric is |
| ``rubric_select`` | | Combined Open-Ended | Browser | ``location`` | string | The location of the question whose rubric is |
| | | | | | | being selected. |
| | | | +---------------------+---------------+---------------------------------------------------------------------+
| | | | | ``selection`` | integer | Value selected on rubric. |
| | | | +---------------------+---------------+---------------------------------------------------------------------+
| | | | | ``category`` | integer | Rubric category selected. |
+-----------------------------------+-------------------------------+---------------------+-----------------+---------------------+---------------+---------------------------------------------------------------------+
| ``oe_show_full_feedback`` | | Combined Open-Ended | CoffeeScript/JS | | | |
| ``oe_show_full_feedback`` | | Combined Open-Ended | Browser | | | |
| ``oe_show_respond_to_feedback`` | | | | | | |
+-----------------------------------+-------------------------------+---------------------+-----------------+---------------------+---------------+---------------------------------------------------------------------+
| ``oe_feedback_response_selected`` | | Combined Open-Ended | CoffeeScript/JS | ``value`` | integer | Value selected in the feedback response form. |
| ``oe_feedback_response_selected`` | | Combined Open-Ended | Browser | ``value`` | integer | Value selected in the feedback response form. |
+-----------------------------------+-------------------------------+---------------------+-----------------+---------------------+---------------+---------------------------------------------------------------------+
| ``page_close`` | This event type originates | Logger | CoffeeScript/JS | | | |
| ``page_close`` | This event type originates | Logger | Browser | | | |
| | from within the Logger | | | | | |
| | itself. | | | | | |
+-----------------------------------+-------------------------------+---------------------+-----------------+---------------------+---------------+---------------------------------------------------------------------+
| ``play_video`` | Fired on video play. | Video | CoffeeScript/JS | ``id`` | string | EdX ID of the video being watched (e.g., |
| ``play_video`` | Fired on video play. | Video | Browser | ``id`` | string | EdX ID of the video being watched (e.g., |
| | | | | | | i4x-HarvardX-PH207x-video-Simple_Random_Sample). |
| | | | +---------------------+---------------+---------------------------------------------------------------------+
| | | | | ``code`` | string | YouTube ID of the video being watched (e.g., |
......@@ -134,26 +121,18 @@ The Student Event Type table lists the event types logged for interaction with t
| | | | +---------------------+---------------+---------------------------------------------------------------------+
| | | | | ``speed`` | string | Video speed in use (i.e., 0.75, 1.0, 1.25, 1.50). |
+-----------------------------------+-------------------------------+---------------------+-----------------+---------------------+---------------+---------------------------------------------------------------------+
| ``book`` | Fired when a user is reading | PDF Viewer | JS | ``type`` | string | `'gotopage'`, `'prevpage'`, `'nextpage'` |
| ``book`` | Fired when a user is reading | PDF Viewer | Browser | ``type`` | string | `'gotopage'`, `'prevpage'`, `'nextpage'` |
| | a PDF book. | | +---------------------+---------------+---------------------------------------------------------------------+
| | | | | ``old`` | integer | Original page number. |
| | | | +---------------------+---------------+---------------------------------------------------------------------+
| | | | | ``new`` | integer | Destination page number. |
+-----------------------------------+-------------------------------+---------------------+-----------------+---------------------+---------------+---------------------------------------------------------------------+
| ``showanswer`` / | Server-side event which | Capa Module | Python | ``problem_id`` | string | EdX ID of the problem being shown. |
| ``show_answer`` | displays the answer to a | | | | | |
| | problem. | | | | | |
+-----------------------------------+-------------------------------+---------------------+-----------------+---------------------+---------------+---------------------------------------------------------------------+
| ``problem_check_fail`` | | Capa Module | Python | ``state`` | string / JSON | Current problem state. |
| | | | +---------------------+---------------+---------------------------------------------------------------------+
| | | | | ``problem_id`` | string | ID of the problem being checked. |
| | | | +---------------------+---------------+---------------------------------------------------------------------+
| | | | | ``answers`` | dict | |
| | | | +---------------------+---------------+---------------------------------------------------------------------+
| | | | | ``failure`` | string | `'closed'`, `'unreset'` |
| ``problem_check`` | Fired when a user wants to | Capa Module | Browser | | | The ``event`` field contains the |
| | check a problem. | | | | | values of all input fields from the problem |
| | | | | | | being checked, styled as GET parameters. |
+-----------------------------------+-------------------------------+---------------------+-----------------+---------------------+---------------+---------------------------------------------------------------------+
| ``problem_check`` / | | Capa Module | Python | ``state`` | string / JSON | Current problem state. |
| ``save_problem_check`` | | | +---------------------+---------------+---------------------------------------------------------------------+
| ``problem_check`` / | Fired when a problem has been | Capa Module | Server | ``state`` | string / JSON | Current problem state. |
| ``save_problem_check`` | checked successfully. | | +---------------------+---------------+---------------------------------------------------------------------+
| | | | | ``problem_id`` | string | ID of the problem being checked. |
| | | | +---------------------+---------------+---------------------------------------------------------------------+
| | | | | ``answers`` | dict | |
......@@ -169,14 +148,20 @@ The Student Event Type table lists the event types logged for interaction with t
| | | | | ``correct_map`` | string / JSON | **See the table in** |
| | | | | | | **Addendum:** ``correct_map`` **Fields and Values below** |
+-----------------------------------+-------------------------------+---------------------+-----------------+---------------------+---------------+---------------------------------------------------------------------+
| ``problem_rescore_fail`` | | Capa Module | Python | ``state`` | string / JSON | Current problem state. |
| ``problem_check_fail`` | Fired when a problem cannot be| Capa Module | Server | ``state`` | string / JSON | Current problem state. |
| | checked successfully. | | +---------------------+---------------+---------------------------------------------------------------------+
| | | | | ``problem_id`` | string | ID of the problem being checked. |
| | | | +---------------------+---------------+---------------------------------------------------------------------+
| | | | | ``problem_id`` | string | ID of the problem being rescored. |
| | | | | ``answers`` | dict | |
| | | | +---------------------+---------------+---------------------------------------------------------------------+
| | | | | ``failure`` | string | `'unsupported'`, `'unanswered'`, `'input_error'`, `'unexpected'` |
| | | | | ``failure`` | string | `'closed'`, `'unreset'` |
+-----------------------------------+-------------------------------+---------------------+-----------------+---------------------+---------------+---------------------------------------------------------------------+
| ``problem_rescore`` | | Capa Module | Python | ``state`` | string / JSON | Current problem state. |
| | | | +---------------------+---------------+---------------------------------------------------------------------+
| ``problem_reset`` | Fired when a user resets a | Capa Module | Browser | | | |
| | problem. | | | | | |
| | | | | | | |
+-----------------------------------+-------------------------------+---------------------+-----------------+---------------------+---------------+---------------------------------------------------------------------+
| ``problem_rescore`` | Fired when a problem is | Capa Module | Server | ``state`` | string / JSON | Current problem state. |
| | rescored sucessfully. | | +---------------------+---------------+---------------------------------------------------------------------+
| | | | | ``problem_id`` | string | ID of the problem being rescored. |
| | | | +---------------------+---------------+---------------------------------------------------------------------+
| | | | | ``orig_score`` | integer | |
......@@ -193,31 +178,47 @@ The Student Event Type table lists the event types logged for interaction with t
| | | | +---------------------+---------------+---------------------------------------------------------------------+
| | | | | ``attempts`` | integer | |
+-----------------------------------+-------------------------------+---------------------+-----------------+---------------------+---------------+---------------------------------------------------------------------+
| ``save_problem_fail`` | | Capa Module | Python | ``state`` | string / JSON | Current problem state. |
| | | | +---------------------+---------------+---------------------------------------------------------------------+
| | | | | ``problem_id`` | string | ID of the problem being saved. |
| | | | +---------------------+---------------+---------------------------------------------------------------------+
| | | | | ``failure`` | string | `'closed'`, `'done'` |
| ``problem_rescore_fail`` | Fired when a problem cannot be| Capa Module | Server | ``state`` | string / JSON | Current problem state. |
| | rescored successfully. | | +---------------------+---------------+---------------------------------------------------------------------+
| | | | | ``problem_id`` | string | ID of the problem being rescored. |
| | | | +---------------------+---------------+---------------------------------------------------------------------+
| | | | | ``answers`` | dict | |
| | | | | ``failure`` | string | `'unsupported'`, `'unanswered'`, `'input_error'`, `'unexpected'` |
+-----------------------------------+-------------------------------+---------------------+-----------------+---------------------+---------------+---------------------------------------------------------------------+
| ``save_problem_success`` | | Capa Module | Python | ``state`` | string / JSON | Current problem state. |
| | | | +---------------------+---------------+---------------------------------------------------------------------+
| | | | | ``problem_id`` | string | ID of the problem being saved. |
| | | | +---------------------+---------------+---------------------------------------------------------------------+
| | | | | ``answers`` | dict | |
| ``problem_show`` | Fired when a problem is | Capa Module | Browser | ``problem`` | string | ID of the problem being shown (e.g., |
| | shown. | | | | | i4x://MITx/6.00x/problem/L15:L15_Problem_2). |
+-----------------------------------+-------------------------------+---------------------+-----------------+---------------------+---------------+---------------------------------------------------------------------+
| ``reset_problem_fail`` | | Capa Module | Python | ``old_state`` | string / JSON | Current problem state. |
| ``problem_save`` | Fired when a problem is | Capa Module | Browser | | | |
| | saved. | | | | | |
+-----------------------------------+-------------------------------+---------------------+-----------------+---------------------+---------------+---------------------------------------------------------------------+
| ``reset_problem`` | Fired when a problem has been | Capa Module | Server | ``old_state`` | string / JSON | Current problem state. |
| | reset successfully. | | +---------------------+---------------+---------------------------------------------------------------------+
| | | | | ``problem_id`` | string | ID of the problem being reset. |
| | | | +---------------------+---------------+---------------------------------------------------------------------+
| | | | | ``new_state`` | string / JSON | New problem state. |
+-----------------------------------+-------------------------------+---------------------+-----------------+---------------------+---------------+---------------------------------------------------------------------+
| ``reset_problem_fail`` | Fired when a problem cannot be| Capa Module | Server | ``old_state`` | string / JSON | Current problem state. |
| | reset successfuly. | | +---------------------+---------------+---------------------------------------------------------------------+
| | | | | ``problem_id`` | string | ID of the problem being reset. |
| | | | +---------------------+---------------+---------------------------------------------------------------------+
| | | | | ``failure`` | string | `'closed'`, `'not_done'` |
+-----------------------------------+-------------------------------+---------------------+-----------------+---------------------+---------------+---------------------------------------------------------------------+
| ``reset_problem`` | | Capa Module | Python | ``old_state`` | string / JSON | Current problem state. |
| ``showanswer`` / | Server-side event which | Capa Module | Server | ``problem_id`` | string | EdX ID of the problem being shown. |
| ``show_answer`` | displays the answer to a | | | | | |
| | problem. | | | | | |
+-----------------------------------+-------------------------------+---------------------+-----------------+---------------------+---------------+---------------------------------------------------------------------+
| ``save_problem_fail`` | Fired when a problem cannot be| Capa Module | Server | ``state`` | string / JSON | Current problem state. |
| | saved successfully. | | +---------------------+---------------+---------------------------------------------------------------------+
| | | | | ``problem_id`` | string | ID of the problem being saved. |
| | | | +---------------------+---------------+---------------------------------------------------------------------+
| | | | | ``problem_id`` | string | ID of the problem being reset. |
| | | | | ``failure`` | string | `'closed'`, `'done'` |
| | | | +---------------------+---------------+---------------------------------------------------------------------+
| | | | | ``new_state`` | string / JSON | New problem state. |
| | | | | ``answers`` | dict | |
+-----------------------------------+-------------------------------+---------------------+-----------------+---------------------+---------------+---------------------------------------------------------------------+
| ``save_problem_success`` | Fired when a problem has been | Capa Module | Server | ``state`` | string / JSON | Current problem state. |
| | successfully saved. | | +---------------------+---------------+---------------------------------------------------------------------+
| | | | | ``problem_id`` | string | ID of the problem being saved. |
| | | | +---------------------+---------------+---------------------------------------------------------------------+
| | | | | ``answers`` | dict | |
+-----------------------------------+-------------------------------+---------------------+-----------------+---------------------+---------------+---------------------------------------------------------------------+
*Addendum:* ``correct_map`` *Fields and Values*
......@@ -255,9 +256,9 @@ The Instructor Event Type table lists the event types logged for course team int
+----------------------------------------+-------------------------------+----------------------+-----------------+---------------------+---------------+---------------------------------------------------------------------+
| Event Type | Description | Component | Language | ``event`` Fields | Type | Details |
| Event Type | Description | Component | Event Source | ``event`` Fields | Type | Details |
+----------------------------------------+-------------------------------+----------------------+-----------------+---------------------+---------------+---------------------------------------------------------------------+
| ``list-students``, | | Instructor Dashboard | Python | | | |
| ``list-students``, | | Instructor Dashboard | Server | | | |
| ``dump-grades``, | | | | | | |
| ``dump-grades-raw``, | | | | | | |
| ``dump-grades-csv``, | | | | | | |
......@@ -265,17 +266,17 @@ The Instructor Event Type table lists the event types logged for course team int
| ``dump-answer-dist-csv``, | | | | | | |
| ``dump-graded-assignments-config`` | | | | | | |
+----------------------------------------+-------------------------------+----------------------+-----------------+---------------------+---------------+---------------------------------------------------------------------+
| ``rescore-all-submissions``, | | Instructor Dashboard | Python | ``problem`` | string | |
| ``rescore-all-submissions``, | | Instructor Dashboard | Server | ``problem`` | string | |
| ``reset-all-attempts`` | | | +---------------------+---------------+---------------------------------------------------------------------+
| | | | | ``course`` | string | |
+----------------------------------------+-------------------------------+----------------------+-----------------+---------------------+---------------+---------------------------------------------------------------------+
| ``delete-student-module-state``, | | Instructor Dashboard | Python | ``problem`` | string | |
| ``delete-student-module-state``, | | Instructor Dashboard | Server | ``problem`` | string | |
| ``rescore-student-submission`` | | | +---------------------+---------------+---------------------------------------------------------------------+
| | | | | ``student`` | string | |
| | | | +---------------------+---------------+---------------------------------------------------------------------+
| | | | | ``course`` | string | |
+----------------------------------------+-------------------------------+----------------------+-----------------+---------------------+---------------+---------------------------------------------------------------------+
| ``reset-student-attempts`` | | Instructor Dashboard | Python | ``old_attempts`` | string | |
| ``reset-student-attempts`` | | Instructor Dashboard | Server | ``old_attempts`` | string | |
| | | | +---------------------+---------------+---------------------------------------------------------------------+
| | | | | ``student`` | string | |
| | | | +---------------------+---------------+---------------------------------------------------------------------+
......@@ -285,36 +286,36 @@ The Instructor Event Type table lists the event types logged for course team int
| | | | +---------------------+---------------+---------------------------------------------------------------------+
| | | | | ``course`` | string | |
+----------------------------------------+-------------------------------+----------------------+-----------------+---------------------+---------------+---------------------------------------------------------------------+
| ``get-student-progress-page`` | | Instructor Dashboard | Python | ``student`` | string | |
| ``get-student-progress-page`` | | Instructor Dashboard | Server | ``student`` | string | |
| | | | +---------------------+---------------+---------------------------------------------------------------------+
| | | | | ``instructor`` | string | |
| | | | +---------------------+---------------+---------------------------------------------------------------------+
| | | | | ``course`` | string | |
+----------------------------------------+-------------------------------+----------------------+-----------------+---------------------+---------------+---------------------------------------------------------------------+
| ``list-staff``, | | Instructor Dashboard | Python | | | |
| ``list-staff``, | | Instructor Dashboard | Server | | | |
| ``list-instructors``, | | | | | | |
| ``list-beta-testers`` | | | | | | |
+----------------------------------------+-------------------------------+----------------------+-----------------+---------------------+---------------+---------------------------------------------------------------------+
| ``add-instructor``, | | Instructor Dashboard | Python | ``instructor`` | string | |
| ``add-instructor``, | | Instructor Dashboard | Server | ``instructor`` | string | |
| ``remove-instructor`` | | | | | | |
| | | | | | | |
+----------------------------------------+-------------------------------+----------------------+-----------------+---------------------+---------------+---------------------------------------------------------------------+
| ``list-forum-admins``, | | Instructor Dashboard | Python | ``course`` | string | |
| ``list-forum-admins``, | | Instructor Dashboard | Server | ``course`` | string | |
| ``list-forum-mods``, | | | | | | |
| ``list-forum-community-TAs`` | | | | | | |
+----------------------------------------+-------------------------------+----------------------+-----------------+---------------------+---------------+---------------------------------------------------------------------+
| ``remove-forum-admin``, | | Instructor Dashboard | Python | ``username`` | string | |
| ``remove-forum-admin``, | | Instructor Dashboard | Server | ``username`` | string | |
| ``add-forum-admin``, | | | | | | |
| ``remove-forum-mod``, | | | | | | |
| ``add-forum-mod``, | | | +---------------------+---------------+---------------------------------------------------------------------+
| ``remove-forum-community-TA``, | | | | ``course`` | string | |
| ``add-forum-community-TA`` | | | | | | |
+----------------------------------------+-------------------------------+----------------------+-----------------+---------------------+---------------+---------------------------------------------------------------------+
| ``psychometrics-histogram-generation`` | | Instructor Dashboard | Python | ``problem`` | string | |
| ``psychometrics-histogram-generation`` | | Instructor Dashboard | Server | ``problem`` | string | |
| | | | | | | |
| | | | | | | |
+----------------------------------------+-------------------------------+----------------------+-----------------+---------------------+---------------+---------------------------------------------------------------------+
| ``add-or-remove-user-group`` | | Instructor Dashboard | Python | ``event_name`` | string | |
| ``add-or-remove-user-group`` | | Instructor Dashboard | Server | ``event_name`` | string | |
| | | | +---------------------+---------------+---------------------------------------------------------------------+
| | | | | ``user`` | string | |
| | | | +---------------------+---------------+---------------------------------------------------------------------+
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment