searcher/tsrc/logplayer/logplayer-guide.txt
changeset 0 671dee74050a
equal deleted inserted replaced
-1:000000000000 0:671dee74050a
       
     1 General
       
     2 =======
       
     3 
       
     4 Log Player framework contains two components: Log Player recorder and
       
     5 Log Player for executing recorded log files. Log Player recorder is 
       
     6 part of Search Server. By default Search Server does not record log files and
       
     7 Search Server must be instrumented separately to generate log files. 
       
     8 Log Player is separate program used to execute stored log files.
       
     9 
       
    10 Recording log file
       
    11 ==================
       
    12 
       
    13 Log file recording is disabled by default. To enable recording:
       
    14 1) Open file cfg/searchserverdefs.h
       
    15 2) This file should contain following line
       
    16    //#define RECORD_FOR_LOG_PLAYER
       
    17    Uncomment this to enable log recording
       
    18 3) Recompile Search Server and reinstall sis-file to phone.
       
    19 4) Create folder C:\logs\CPix\LogPlayer
       
    20 5) All search/indexing activities will be logged to
       
    21    c:\logs\CPix\LogPlayer\LogPlayer.txt
       
    22    This will work on urel and udeb builds.
       
    23 Note: Remember to delete old log file before recording new logs. If there
       
    24 exists old file then new data is added to start of file.
       
    25 
       
    26 Executing stored log file
       
    27 =========================
       
    28 
       
    29 LogPlayer.exe is used to execute stored log file. Steps to execute log:
       
    30 1) Compile LogPlayer. This is also included from main bld.inf file.
       
    31    (LogPlayer is test component so build with "abld test build")
       
    32 2) Install LogPlayer to phone
       
    33    (Generate sis-file from s60\test\LogPlayer\sis\logplayer.pkg)
       
    34 3) Move stored log file to place where Log Player can find it. There are
       
    35    2 possibilities
       
    36 
       
    37    Option 1. Create file c:\data\LPConf.txt. 
       
    38    
       
    39    Content of this file should be absolute paths to log files.
       
    40    Each line should be in own line.
       
    41    
       
    42    Example content:
       
    43 
       
    44    c:\data\MyLogPlayer1.txt
       
    45    c:\data\MyLogPlayer2.txt
       
    46    
       
    47    Log Player will execute each specified log file in given order
       
    48 
       
    49 
       
    50    Option 2. Move log data to file C:\data\LPDefault.txt.
       
    51    
       
    52    Log Player will execute log data from that file. Note: LPConf.txt must
       
    53    be deleted or Log Player will never read log data from LPDefault.txt
       
    54 
       
    55 4) Start LogPlayer.exe
       
    56    - Run from Applications menu or
       
    57    - From eshell typing "LogPlayer"
       
    58 
       
    59    Log Player starts interpreting given log file. Log Player will 
       
    60    print latest command to console.