Changes between Version 2 and Version 3 of PlugIns/GenericEvents/generic-event-monitor


Ignore:
Timestamp:
10/04/17 12:56:50 (7 years ago)
Author:
pharms
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • PlugIns/GenericEvents/generic-event-monitor

    v2 v3  
    33= Monitor for Generic Events = 
    44 
    5 To analyse the usage of applications with AutoQUEST, their usage must first be recorded. For this, an application must be instrumented to intercept the events caused by the actions of the users. These events must then be stored somewhere. For this, the Generic Event Monitor can be used. The monitor is a standalone application for Java on Linux based on a Webserver. Via the web server, it receives the recorded event in a JSON format. An example for a set of recorded events is the following: 
     5To analyse the usage of applications with AutoQUEST, their usage must first be recorded. For this, an application must be instrumented to intercept the events caused by the actions of the users. These events must then be stored somewhere. For this, the Generic Event Monitor can be used. The monitor is a standalone application for Java on Linux based on a Webserver. Via the web server, it receives the recorded events in a JSON format via an HTTP post. An example for a JSON message with two recorded event is the following: 
    66 
    77{{{ 
    … …  
    1919      "children": 
    2020      [ { 
    21           "targetId":"target3", 
     21          "targetId":"target2", 
    2222          "index":"0", 
    2323        }, 
    2424        { 
    25           "targetId":"target2", 
     25          "targetId":"target3", 
    2626          "htmlId":"gsr", 
    2727        } 
    … …  
    3232        "time":"12345", 
    3333        "targetId":"target2", 
    34         "type":"gaze"," + 
     34        "type":"gaze", 
    3535        "xcoordinate": "194", 
    3636        "ycoordinate": "12" 
    37       }" + 
    38     ]" + 
    39   }" + 
    40 }"; 
     37      }, 
     38      { 
     39        "time":"12346", 
     40        "targetId":"target3", 
     41        "type":"use", 
     42        "param1": "value1", 
     43        "param2": "value2" 
     44      }" 
     45    ] 
     46  } 
     47} 
    4148}}} 
    4249 
     50The message starts with some client information. This is required to distinguish received messages regarding their sender (client id) and the application for which the events were recorded (app id). The monitor uses this information for structuring the locally stored log files into corresponding sub folders. The next part is the target structure. It provides information about relevant event targets. The targets can be substructured hierarchically in any depth. In the example, the event target with id "target1" has three parameters and two child targets. The target ids need to be unique within a message. Finally, the message contains the events. Each event has a time stamp, a reference to the event target for which it was recorded, and a type. In addition, an event can be refined using freely choosable parameters in form of key value pairs. 
    4351 
    4452== Installation of the Monitor == 
    4553 
    46 To install the monitor, it must first be downloaded. As AutoQUEST is under continuous development, it is always good to download the latest tested version from our continous integration environment which is available [https://trex.informatik.uni-goettingen.de/hudson/job/autoquest-htmlmonitor/lastSuccessfulBuild/de.ugoe.cs.autoquest$autoquest-htmlmonitor/ here]. There, just download the autoquest-htmlmonitor-version-bin.tar.gz. The current versions of the monitor require an installed Java Runtime Environment version 1.7 or higher. 
     54To install the monitor, it must first be downloaded. As AutoQUEST is under continuous development, it is always good to download the latest tested version from our continous integration environment which is available [https://trex.informatik.uni-goettingen.de/hudson/job/autoquest-generic-event-monitor/lastSuccessfulBuild/de.ugoe.cs.autoquest$autoquest-generic-event-monitor/ here]. There, just download the autoquest-generic-event-monitor-version-bin.tar.gz. The current versions of the monitor require an installed Java Runtime Environment version 1.8 or higher. 
    4755 
    4856Afterwards, the tar-file needs to be extracted to a preferred location. The resulting folder structure will look as follows: