home *** CD-ROM | disk | FTP | other *** search
/ ftp.wwiv.com / ftp.wwiv.com.zip / ftp.wwiv.com / pub / BBS / UBBSLA33.ZIP / UBBSLA.DOC < prev    next >
Text File  |  1991-12-18  |  15KB  |  294 lines
  1.                                UBBSLA v3.3
  2.                            (UBBS Log Analyzer)
  3.                        Written for Ultra BBS 2.xx
  4.  
  5.  
  6. Simply put, UBBSLA will read your caller log file and create bulletins
  7. for including in your BBS Bulletin files or to be used for your own
  8. reference. UBBSLA tracks more than 50 variables extracted from the caller
  9. log file in producing the output files.
  10.  
  11. This is the sixth release of the program. With UBBS v2.xx the syntax in the
  12. log file has changed and UBBSLA has changed with it. A new daily and previous
  13. day activity bulletin is also added. New to version 3.0 is a greatly
  14. expanded activity report and a door statistics file. With the release of
  15. UBBSLA v3.0 the program will only remain compatible with UBBS v2.xx and
  16. later releases, UBBS v1.xx activity log compatibility is no longer
  17. supported.
  18.  
  19.  
  20. Here is a sample of an output file produced by UBBSLA:
  21.  
  22. ╓──────────────────────────────────────╖       Corporate Headquarters BBS
  23. ║ Total Number Of Callers   =   6,204  ║     UBBSLA v3.3 - By: Robert Neal
  24. ║      300 Baud Callers =      0    0% ║
  25. ║     1200 Baud Callers =    197    3% ║     Log Analysis Since 06/09/91
  26. ║     2400 Baud Callers =   3908   62% ║  Last Updated: 12-18-1991 at 03:01
  27. ║    9600+ Baud Callers =    942   15% ╟──────────────────────────────────────╖
  28. ║         Local Callers =   1166   18% ║ Number of New Users added    :   447 ║
  29. ╟──────────────────────────────────────╫──────────────────────────────────────╢
  30. ║      Normal Logoff    =   5059   81% ║ Minutes System Used          :103398 ║
  31. ║       Dropped Carrier  =   625   10% ╟──────────────────────────────────────╢
  32. ║       Time Exceed      =   377    6% ║ Average Minutes Per Call     :    16 ║
  33. ║       Forced Off       =   107    1% ╟──────────────────────────────────────╢
  34. ║       No Activity      =     9    0% ║ Longest Call in Minutes      :   675 ║
  35. ╟──────────────────────────────────────╫──────────────────────────────────────╢
  36. ║ Times Sysop Was Paged        :   217 ║ Times Conferences Joined     :  3620 ║
  37. ╟──────────────────────────────────────╫──────────────────────────────────────╢
  38. ║ Times Doors Opened           :  3203 ║ Total Messages Left          :  1842 ║
  39. ╟──────────────────────────────────────╫──────────────────────────────────────╢
  40. ║ Users Using Color Graphics   :  4253 ║ Messages recd via mail reader:   561 ║
  41. ║ Users Using Non-Graphics     :  1628 ╟──────────────────────────────────────╢
  42. ║ Users Using Black / White    :   335 ║ Time Mail Packet Downloaded  :   520 ║
  43. ╙──────────────────────────────────────╨──────────────────────────────────────╜
  44.  
  45. ╓──────────────────────────────────────╥──────────────────────────────────────╖
  46. ║ Total Number of Downloads =   4,237  ║ Total Number of Uploads  =      868  ║
  47. ║  Xmodem Checksum   =    115    2%    ║  Xmodem Checksum   =     47    5%    ║
  48. ║  Xmodem CRC        =    250    5%    ║  Xmodem CRC        =     29    3%    ║
  49. ║  Ymodem-G Batch    =    213    5%    ║  Ymodem-G Batch    =     19    2%    ║
  50. ║  Xmodem-1K         =    226    5%    ║  Xmodem-1K         =     23    2%    ║
  51. ║  Ymodem Batch      =    142    3%    ║  Ymodem Batch      =     30    3%    ║
  52. ║  Zmodem Batch      =   3283   77%    ║  Zmodem Batch      =    536   61%    ║
  53. ║  HS/Link           =      6    0%    ║  HS/Link           =     18    2%    ║
  54. ║  Other             =      2    0%    ║  Other             =    166   19%    ║
  55. ╟──────────────────────────────────────╫──────────────────────────────────────╢
  56. ║ Count Download Rejections    :   206 ║ K-Byte Download Rejections   :     0 ║
  57. ╟──────────────────────────────────────╫──────────────────────────────────────╢
  58. ║ Events Processed             :   238 ║ Total Compressed Files Viewed:   393 ║
  59. ╙──────────────────────────────────────╨──────────────────────────────────────╜
  60.  
  61.  
  62. In addition, new to v2.0, a daily log analysis will be kept. The same format
  63. as above is used, but will include only current day activity. UBBSLA will
  64. also automatically rename the current day file to the previous day file
  65. when a new day rollover occurs. New to v2.1 is color bulletins have been
  66. added in addition to the straight ascii text output files.
  67.  
  68. New to v2.1 is a door statistics bulletin. This bulletin will list all
  69. doors included in your DOORS.DAT file and create a bulletin listing showing
  70. the security level needed to access it, the percentage of use compared to
  71. other doors and the number of times used. On my system I am using this
  72. bulletin in place of a static text file for my DOORS MENU. Here is a
  73. sample of what the output looks like:
  74.  
  75.  
  76.  
  77.                            Corporate Headquarters BBS
  78.                  Door Statistics - Updated: 09-07-1991 12:26:33
  79.  
  80.       #    Door                       Last Used   Sec Lev   % Used   # Used
  81.     ╔════╤═════════════════════════╤════════════╤═════════╤════════╤════════╗
  82.     ║  1 │ Links Golf              │ 09-07-1991 │     60  │    1.3 │     26 ║
  83.     ║  2 │ Scrabble                │ 09-07-1991 │     60  │   25.7 │    504 ║
  84.     ║  3 │ Card Sharks             │ 09-07-1991 │     60  │   25.8 │    506 ║
  85.     ║  4 │ Global Wars             │ 09-03-1991 │     60  │    4.2 │     82 ║
  86.     ║  5 │ Yankee Trader           │ 09-07-1991 │     60  │   36.0 │    706 ║
  87.     ║  6 │ Stack-Em                │ 08-25-1991 │     60  │    2.0 │     39 ║
  88.     ║  7 │ Mega Door v1.11         │ 08-24-1991 │     60  │    0.7 │     14 ║
  89.     ║  8 │ Robo Wars               │ 08-28-1991 │     60  │    1.9 │     37 ║
  90.     ║  9 │ Total Recall            │ 08-24-1991 │     60  │    0.9 │     17 ║
  91.     ║ 10 │ 4SQUARE                 │ 08-25-1991 │     60  │    0.9 │     17 ║
  92.     ║ 11 │ PegJump                 │ 08-24-1991 │     60  │    0.7 │     13 ║
  93.     ╚════╧═════════════════════════╧════════════╧═════════╧════════╧════════╝
  94.                                                                  UBBSLA v3.3
  95.  
  96. This report format has been enhanced in UBBSLA v3.0 compared to prior UBBSLA
  97. releases. Up to 75 doors may be included in this listing and I feel that
  98. no system will operate more than 75 doors. If the need arises I can increase
  99. this limit.
  100.  
  101. In addition, UBBSLA will produce a standard DOS text file listing callers
  102. who have dropped carrier on you. This might be helpful in seeing who is
  103. playing around on your system. UBBS is written well enough that this type
  104. of activity doesn't cause problems, but still common BBS courtesy, where
  105. users properly log off is always encouraged.
  106.  
  107.  
  108. *** GETTING STARTED ***
  109.  
  110.  
  111. First thing you need to do is create a file called UBBSLA.CFG (or you can
  112. simply edit the sample file that came in this archive. Here is the sample
  113. UBBSLA.CFG file that is included:
  114.  
  115.  
  116. Corporate Headquarters BBS  <-Name of your BBS
  117. Bob Neal                    <-Sysop's Name
  118. D:\UBBS\FILES\CALLER1       <-Name of your CALLER LOG FILE
  119. D:\UBBS\FILES\DOORS.DAT     <-Filename and path of your DOORS DAT file
  120. D:\UBBS\BLTS\LASCUM         <-Name of bulletin for cummulative system stats
  121. D:\UBBS\BLTS\LASDAY         <-Name of bulletin for current day stats
  122. D:\UBBS\BLTS\LASPRE         <-Name of bulletin for previous day stats
  123. D:\UBBS\BLTS\LASDOR         <-Name of bulletin for door statistics
  124. D:\UBBS\FILES\DROPCAR.TXT   <-Filename of file listing dropped carrier users
  125. N                           <-Exclude local upload from stats (Y/N)
  126. 0                           <-Registration number (or leave as 0)
  127. Xmodem Checksum             <-Protocols to be included in statistics
  128. Xmodem CRC                  <- (new to v3.3 - if you are upgrading you
  129. Ymodem-G Batch              <-  must modify your configuration file
  130. Xmodem-1K                   <-  before using this program. Up to
  131. Ymodem Batch                <-  7 protocols may be listed.)
  132. Zmodem Batch                <-
  133. HS/Link                     <-
  134.  
  135.  
  136. When entering the name of the protocols you wish to have tracked, you
  137. must enter the exact same name that was entered in the protocol menu
  138. of the SETUP program of UBBS. Up to 7 protocols will be tracked, any
  139. other protocols will be lumped as "other" in the listing.
  140.  
  141. For those upgrading from a prior UBBSLA release, v3.2 now adds the option
  142. to include or exclude local uploads from being included in the upload
  143. stats.
  144.  
  145. It is important that you make the filenames of your bulletin files 7
  146. characters or less in size as UBBSLA will append each filename listed
  147. with a "G" for the color bulletins created.
  148.  
  149. In place of the filename for dropped carrier listing, if you enter NONE
  150. UBBSLA will not maintain a listing of users who have dropped carrier.
  151.  
  152. To run UBBSLA, enter the following from the command line or your batch file:
  153.  
  154.    UBBSLA [Config Filename]
  155.  
  156. The Config Filename is optional. If it is not included the program will
  157. default to using UBBSLA.CFG. If you are operating a multi-node operation
  158. you will need to create seperate config files which contain the name
  159. of the CALLER LOG for each node.
  160.  
  161. You may run UBBSLA from any directory as long as you put the full path of
  162. where your caller logs is contained in the config file.
  163.  
  164. When run, UBBSLA will quickly scan your caller log and analyze the info
  165. contained within it. The first time UBBSLA is run it may take a minute
  166. or so (depending on size of your current caller log file) for UBBSLA to
  167. analyze your data. On my system, a 1,500K+ log file took only several
  168. minutes on it's initial pass.  On each subsequent read UBBSLA will
  169. need only to read the data added since the last time it was run.
  170.  
  171. By doing this, UBBSLA is able to be operated each time the BBS resets
  172. (between each caller). The log to be processed is minimal and only takes
  173. a couple of seconds on my system to process after each call. UBBSLA will
  174. create a file called UBBSLA.DAT which will it contains the values of
  175. the variables to date.
  176.  
  177. You could also run UBBSLA as part of your nitely batch routines. This
  178. method would update your bulletin daily, and depending on your needs
  179. may be more than sufficient.
  180.  
  181. You can also run UBBSLA manually when you feel the need. UBBSLA is
  182. flexible enough to operate whenever you want it. The stats are not
  183. corrupted in anyway if you run UBBSLA on an irregular basis because
  184. UBBSLA only processes new information each time.
  185.  
  186. As written, UBBSLA is able to process multi-node caller files (simply
  187. create seperate config files for each node). It will though cummulate
  188. the stats into one output file. This means that you can track your
  189. System To Date information in one bulletin. If there is a demand I'll
  190. look to produce multiple data files for each node operated, but felt
  191. that total System To Date information was more useful and informative,
  192. unless you want to know just how busy a particular node is I suppose.
  193.  
  194. UBBSLA is released as shareware. It is not crippled in anyway. You are
  195. free to use UBBSLA regardless if you register the program or not. Your
  196. registration though will help to encourage me to continue to write
  197. utilities for UBBS. I've writen utilities in the past for another BBS
  198. program and look to use my experience to write some interesting utils for
  199. UBBS as well.
  200.  
  201. To register, send $10.00 to:  Robert Neal
  202.                               317 Hickory
  203.                               Romeoville, IL  60441
  204.  
  205. Discounts are available if you register other utilities I've written,
  206. see MAILER.TXT for pricing.
  207.  
  208. Upon receipt of your check I will send you the current version of the
  209. program along with your registration number for the program.
  210.  
  211. Feel free to give my BBS a call at (815) 886-3233, operating at 1200,
  212. 2400 and 9600 (v.32) baud, 24 hours with your comments and suggestions.
  213. You may also reach me on Prodigy (PNSP01A) as well as on America On Line
  214. (RobertN70)  though my use of those systems is irregular so for
  215. immediate response my BBS should be called.
  216.  
  217.  
  218. Version History:
  219.  
  220. v1.0 - Initial Release
  221.  
  222. v2.0 - Modified code to work with new syntax found in log file maintained
  223. 6/15   by UBBS v2.xx. UBBSLA will work with either UBBS 1.0 or 2.0, but
  224.        future support in UBBSLA will be for UBBS 2.x and later.
  225.  
  226.        Added option to not track callers who have dropped carrier.
  227.  
  228.        Added feature where the daily activity as well as the previous
  229.        day activity is tracked and created in a bulletin.
  230.  
  231.        Found bug where system would return an overflow error if program
  232.        was run and there was no total minutes used.
  233.  
  234.        If you are upgrading you will need to edit your configuration
  235.        file according to the example shown in the above documentation.
  236.  
  237. v2.1 - Never officially released
  238. 7/3
  239.        Added color bulletins.
  240.  
  241.        Added statistics bulletin for door useage.
  242.  
  243.        For those operating multi-node system, modified code so that all
  244.        I/O operations are now opened in SHARED ACCESS mode.
  245.  
  246. v2.2 - Modified door tracking routine to read the UBBS DOORS DAT file
  247. 7/17   and automatically read in current doors used. As doors are added
  248.        or deleted, UBBSLA will automatically add or delete files to the
  249.        UBBSLA door statistics file (no sysop maint required by UBBSLA).
  250.  
  251.        **HINT** If you have been operating a BBS and have a large
  252.        caller log file you might want to have UBBSLA scan your caller
  253.        log file and create your door statistics file with all your
  254.        door information contained in that caller log. Simply run the
  255.        program from another temporary directory and let the program
  256.        scan your entire caller log. Once completed, copy over the
  257.        LASTAT.DOR file to the directory where you normally run UBBSLA
  258.        from.
  259.  
  260. v2.3 - Fixed problem with invalid path/filename error message showing
  261. 7/22   up. This occurred when a filename was used for the dropped
  262.        carrier file.
  263.  
  264. v3.0 - Major upgrade to the program. Now more than 50 variables are
  265. 9/06   tracked and a new report format has been added. This update
  266.        requires a total rescan of your caller log to recreate the
  267.        necessary data. The program will automatically delete the
  268.        prior statistics file and recreate this data.
  269.  
  270. v3.01  Fixed bug where converting from prior version of UBBSLA would
  271. 9/14   cause program to abort as the UBBSLA.DOR file was not being
  272.        deleted. Thanks to David Silver for finding this one.
  273.  
  274. v3.10  In fixing bug above, I've created another for first time users.
  275. 9/16   Program returned an error message for users who were using UBBSLA
  276.        for the first time, now fixed.
  277.  
  278. v3.2  A sysop reported that 14,400 baud callers were not being logged.
  279. 9/28  With my modem only 9600 baud was ever logged. I've now changed
  280.       the caller stat from 9600 to 9600+ baud callers and include the
  281.       14,400 baud rate callers in this stat.
  282.  
  283.       Sysop suggested that he would like to exclude local uploads from
  284.       his upload stats that UBBSLA maintain. Added option in .CFG file
  285.       to either include or exclude local uploads from stats.
  286.  
  287. v3.3  With the recent popularity of HS/Link, I have modified the program
  288. 12/18 so you can enter your own protocols that will be included in the
  289.       statistic listing.
  290.  
  291.       Users who were being logged off due to an event time were not being
  292.       included in any logoff statistics. Users logged off now due to
  293.       event time will be included in the statistics for normal log offs.
  294.