home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 35 Internet / 35-Internet.zip / sarg1221.zip / readme < prev    next >
Text File  |  2002-06-13  |  11KB  |  423 lines
  1. Sarg is a Squid Analysis Report Generator that allow you to view "where" your users
  2. are going to on the Internet.
  3. Sarg generate reports in html, with many fields, like: users, IP Addresses, bytes, sites and times.
  4.  
  5. Support to SmartFilter added - 09/02/2000
  6.  
  7. Special thanks to:
  8. Matteo Colombo <matteo@calcol.it>             - Italian language
  9. Palamarchuk Eugen <eugen@cit.od.ukrtel.net>         - Russian language
  10. Csaba Kabai <ckabai@icnpharm.com>            - Hungarian language
  11. Evren Yurtesen <yurtesen@ispro.net.tr>              - Turkish language
  12. Andreas Piek <a.piesk@gmx.net>                - German language
  13. Fred Pacquier <fredp@dial.oleane.com>            - French language
  14. Leonardo A. D'Angelo <ldangelo@san-cayetano.com>    - Spanish language
  15. Seth Mos <stimpy@stimpy.multiweb.nl>            - Dutch language
  16. Milos Prudek <prudek@nembv.cz>                          - Czech language
  17. Dima I. Allaverdov <allav@ur.rags.ru>                   - Russian_windows1251 language
  18. V Gatut Harijiso <gatut@student.unpar.ac.id>        - Indonesian language
  19. Ivan Minchev <vanko@uni-svishtov.bg>            - Bulgarian_windows1251 language
  20. Akira Kitamura <click@anet.ne.jp>            - Japanese language
  21. Radovan Drobnjakovic <admin.rts@rts.co.yu>        - Serbian language
  22. Pieter Kooistra <pkooistra@hr.nl>            - Dutch language fix
  23. Andrew Okhmat <andy@crgu.com>                    - Russian Koi8 language fixed
  24. Nikolai V. Ivanyushin <koko@infocenter.bryansk.ru>    - Russian and Bulgarian language fix
  25. Juris Valdovskis <juris@auce.lv>            - Latvian language
  26. Jordan Kanev <dancho@globcom.net>            - Bulgarian language fix
  27. Wszebor Boksa <Wszebor_Boksa@koncept.pl>        - Polish language
  28. Adi Cretu <adi@usv.ro>                    - Romanian language
  29.  
  30. Translating
  31.    . Copy include/English to YourLanguage
  32.    . Translate YourLanguage
  33.    . Send YourLanguage to orso@onda.com.br to implement
  34.  
  35.  
  36. If you use native squid log format, the elapsed time will be in reports (emulate_httpd_log off).
  37.  
  38. 1. run ./configure
  39.  
  40.    configure options: --enable-bindir=where sarg binary will be saved
  41.                                 default: /usr/bin
  42.  
  43.                       --enable-sysconfdir - where the configuration directory is
  44.                                 default: /usr/local/sarg
  45.  
  46.  
  47. 3. make
  48.  
  49. 4. make install
  50.  
  51. 5. Go to /usr/local/sarg (or file entered with --sysconfdir on configure)
  52.    and change sarg.conf as you need.
  53.  
  54. 6. Notes about sarg:
  55.  
  56.    Date/Time report:
  57.          Every minute that a request is logged your time is incremented by the smaller
  58.          of 1 minute or the total time for the requests.
  59.  
  60. Usage: sarg -h
  61.  
  62. Source: http://web.onda.com.br/orso/index.html
  63.  
  64. Any suggests and/or comments, plase: orso@onda.com.br
  65.  
  66.  
  67. # sarg.conf
  68. #
  69. # TAG:  language 
  70. #    Available languages:
  71. #        Bulgarian_windows1251
  72. #        Czech
  73. #        Dutch
  74. #        English
  75. #        French
  76. #        German
  77. #        Hungarian
  78. #        Indonesian
  79. #        Italian
  80. #        Japanese
  81. #        Latvian
  82. #        Polish
  83. #        Portuguese
  84. #        Romanian
  85. #        Russian_koi8
  86. #        Russian_windows1251
  87. #        Serbian
  88. #        Spanish
  89. #        Turkish
  90. #
  91. #language English
  92.  
  93. # TAG:  access_log file
  94. #       Where is the access.log file
  95. #       sarg -l file
  96. #
  97. #access_log /usr/local/squid/logs/access.log
  98. #access_log /var/log/squid/access.log # RedHat version
  99.  
  100. # TAG:    title
  101. #     Especify the title for html page.
  102. #
  103. #title "Squid User Access Reports"
  104.  
  105. # TAG:    font_face
  106. #     Especify the font for html page.
  107. #
  108. #font_face Arial
  109.  
  110. # TAG:    header_color
  111. #     Especify the header color
  112. #
  113. #header_color darkblue
  114.  
  115. # TAG:    header_bgcolor
  116. #     Especify the header bgcolor
  117. #
  118. #header_bgcolor blanchedalmond
  119.  
  120. # TAG:    font_size
  121. # TAG:    font_size
  122. #     Especify the font size
  123. #
  124. #header_font_size -1
  125.  
  126. # TAG:    background_color
  127. # TAG:    background_color
  128. #    Html page background color
  129. #
  130. #background_color white
  131.  
  132. # TAG:    text_color
  133. #    Html page text color
  134. #
  135. #text_color black
  136.  
  137. # TAG:    text_bgcolor
  138. #    Html page text background color
  139. #
  140. #text_bgcolor beige
  141.  
  142. # TAG:    title_color
  143. #    Html page title color
  144. #
  145. #title_color green
  146.  
  147. # TAG:    logo_image
  148. #    Html page logo.
  149. #
  150. #logo_image none
  151.  
  152. # TAG:    logo_text
  153. #    Html page logo text.
  154. #
  155. #logo_text ""
  156.  
  157. # TAG:    logo_text_color
  158. #    Html page logo texti color.
  159. #
  160. #logo_text_color black
  161.  
  162. # TAG:    logo_image_size
  163. #    Html page logo image size. 
  164. #       width height
  165. #
  166. #image_size 80 45
  167.  
  168. # TAG:    background_image
  169. #    Html page background image
  170. #
  171. #background_image none
  172.  
  173. # TAG:  password
  174. #       User password file used by authentication
  175. #       If you put here, reports will be generated only for users in.
  176. #
  177. #password none
  178.  
  179. # TAG:  temporary_dir
  180. #       Temporary directory name
  181. #       sarg -w dir
  182. #
  183. #temporary_dir /tmp
  184.  
  185. # TAG:  output_dir
  186. #       Where is the reports will ne stored.
  187. #       sarg -o dir
  188. #
  189. #output_dir /usr/local/etc/httpd/htdocs/squid-reports
  190. #output_dir /home/httpd/html/squid-reports # RedHat version
  191.  
  192. # TAG:  output_email
  193. #       Email address to send the reports
  194. #       sarg -e email
  195. #
  196. #output_email none
  197.  
  198. # TAG:  resolve_ip yes/no
  199. #       Convert ip address to dns name
  200. #       sarg -n
  201. #resolve_ip no
  202.  
  203. # TAG:  user_ip yes/no
  204. #       Use Ip Address instead userid (reports)
  205. #       sarg -p
  206. #user_ip no
  207.  
  208. # TAG:  topuser_sort_field field normal/reverse
  209. #       Sort field for the Topuser Report.
  210. #       Allowed fields: USER CONNECT BYTES TIME
  211. #
  212. #topuser_sort_field BYTES reverse
  213.  
  214. # TAG:  user_sort_field field normal/reverse
  215. #       Sort field for the User Report.
  216. #       Allowed fields: SITE CONNECT BYTES TIME
  217. #
  218. #user_sort_field BYTES reverse
  219.  
  220. # TAG:  exclude_users file
  221. #       users within the file will be excluded from reports.
  222. #       you can use indexonly to have only index.html file.
  223. #
  224. #exclude_users none
  225.  
  226. # TAG:  exclude_hosts file
  227. #       Hosts, domains or subnets will be excluded from reports.
  228. #
  229. #       Eg.: 192.168.10.10 - exclude ip address only
  230. #            192.168.10.0  - exclude full C class
  231. #            s1.acme.foo   - exclude hostname only
  232. #            acme.foo      - exclude full domain name
  233. #
  234. #exclude_hosts none
  235.  
  236. # TAG:  useragent_log file
  237. #       Put here where is useragent.log to nable useragent report.
  238. #
  239. #useragent_log none
  240.  
  241. # TAG:  date_format
  242. #       Date format in reports: e (Europe=dd/mm/yy), u (USA=mm/dd/yy), w (Weekly=yy.ww)
  243. #date_format u
  244.  
  245. # TAG:  per_user_limit file MB
  246. #       Save userid on file if download exceed n MB.
  247. #       
  248. #       This option can be used to disable user access if user exceed a download limit.
  249. #per_user_limit none
  250.  
  251. # TAG: lastlog n
  252. #      How many reports files must be keept in reports directory.
  253. #      The oldest report file will be automatically removed.
  254. #      0 - no limit.
  255. #
  256. #lastlog 0
  257.  
  258. # TAG: remove_temp_files yes
  259. #      Remove temporary files: geral, usuarios, top, periodo from root report directory.
  260. #
  261. #remove_temp_files yes
  262.  
  263. # TAG: index yes|no|only
  264. #      Generate the main index.html.
  265. #      only - generate only the main index.html
  266. #
  267. #index yes
  268.  
  269. # TAG: overwrite_report yes|no
  270. #      yes - if report date already exist then will be overwrited.
  271. #       no - if report date already exist then will be renamed to filename.n, filename.n+1
  272. #
  273. #overwrite_report no
  274.  
  275. # TAG: records_without_userid ignore|ip|everybody
  276. #      What can I do with records without user id (no authentication) in access.log file ?
  277. #
  278. #      ignore - This record will be ignored.
  279. #          ip - Use ip address instead. (default)
  280. #   everybody - Use "everybody" instead.
  281. #
  282. #records_without_userid ip
  283.  
  284. # TAG: use_comma no|yes
  285. #      Use comma instead point in reports.
  286. #      Eg.: use_comma yes => 23,450,110
  287. #           use_comma no  => 23.450.110
  288. #
  289. #use_comma no
  290.  
  291. # TAG: mail_utility mail|mailx
  292. #      Mail command to use to send reports via SMTP
  293. #
  294. #mail_utility mailx
  295.  
  296. # TAG: topsites_num n
  297. #      How many sites in topsites report.
  298. #
  299. #topsites_num 100
  300.  
  301. # TAG: topsites_sort_order CONNECT|BYTES A|D
  302. #      Sort for topsites report, where A=Ascendent, D=Descendent
  303. #
  304. #topsites_sort_order CONNECT D
  305.  
  306. # TAG: exclude_codes file
  307. #      Ignore records with these codes. Eg.: NONE/400
  308. #
  309. #exclude_codes /usr/local/sarg/exclude_codes
  310.  
  311. # TAG: replace_index string
  312. #      Replace "index.html" in the main index file with this string
  313. #      If null "index.html" is used 
  314. #
  315. #replace_index <?php echo str_replace(".", "_", $REMOTE_ADDR); echo ".html"; ?>
  316.  
  317. # TAG: max_elapsed milliseconds
  318. #      If elapsed time is recorded in log is greater than max_elapsed use 0 for elapsed time.
  319. #      Use 0 for no checking 
  320. #
  321. #max_elapsed 0
  322. # 8 Hours
  323. max_elapsed 28800000
  324.  
  325. # TAG: report_type type
  326. #      What kind of reports to generate.
  327. #      topsites        - shows the site, connect and bytes
  328. #      sites_users    - shows which users were accessing a site
  329. #      users_sites    - shows sites accessed by the user
  330. #      date_time    - shows the amount of bytes used by day and hour
  331. #      denied        - show all denied sites with full URL
  332. #      auth_failures    - show autentication failures
  333. #
  334. #      Eg.: report_type topsites denied 
  335. #
  336. #report_type topsites users_sites sites_users date_time denied auth_failures site_user_time_date
  337.  
  338. # TAG: usertab filename
  339. #      You can change the "userid" or the "ip address" to be a real user name on the rpeorts.
  340. #      Table syntax:
  341. #         userid name   or   ip address name
  342. #      Eg:
  343. #        SirIsaac Isaac Newton
  344. #        vinci Leonardo da Vinci
  345. #        192.168.10.1 Karol Wojtyla
  346. #      
  347. #      Each line must be terminated with '\n'
  348. #
  349. #usertab none
  350.  
  351. # TAG: long_url yes|no
  352. #      If yes, the full url is showed in report.
  353. #      If no, only the site will be showed
  354. #
  355. #      YES option generate very big sort files and reports.
  356. #
  357. #long_url no
  358.  
  359. # TAG: date_time_by bytes|elap
  360. #      Date/Time reports will use bytes or elapsed time?
  361. #
  362. #date_time_by bytes
  363.  
  364. # TAG: charset name
  365. #      ISO 8859 is a full series of 10 standardized multilingual single-byte coded (8bit)
  366. #      graphic character sets for writing in alphabetic languages
  367. #      You can use the following charsets:
  368. #        Latin1         - West European
  369. #        Latin2         - East European 
  370. #        Latin3         - South European 
  371. #        Latin4         - North European 
  372. #        Cyrillic 
  373. #        Arabic 
  374. #        Greek 
  375. #        Hebrew 
  376. #        Latin5         - Turkish 
  377. #        Latin6
  378. #        Windows-1251
  379. #        Koi8-r
  380. #
  381. #charset Latin1
  382.  
  383. # TAG: user_invalid_char "&/"
  384. #      Records that contain invalid characters in userid will be ignored by Sarg.
  385. #
  386. #user_invalid_char "&/"
  387.  
  388. # TAG: privacy yes|no
  389. #      privacy_string "***.***.***.***"
  390. #      privacy_string_color blue
  391. #      In some countries the sysadm cannot see the visited sites by a restrictive law.
  392. #      Using privacy yes the visited url will be changes by privacy_string and the link
  393. #      will be removed from reports.
  394. #
  395. #privacy no
  396. #privacy_string "***.***.***.***"
  397. #privacy_string_color blue
  398.  
  399. # TAG: include_users "user1:user2:...:usern"
  400. #      Reports will be generated only for listed users.
  401. #
  402. #include_users none
  403.  
  404. # TAG: exclude_string "string1:string2:...:stringn"
  405. #      Records from access.log file that contain one of listed strings will be ignored.
  406. #
  407. #exclude_string none
  408.  
  409. # TAG: show_successful_message yes|no
  410. #      Show "Successful report generated on dir" at end of process.
  411. #
  412. # show_successful_message yes
  413.  
  414. # TAG: topuser_fields
  415. #      Which fields must be in Topuser report.
  416. #
  417. #topuser_fields NUM DATE_TIME USERID CONNECT BYTES %BYTES IN-CACHE-OUT USED_TIME MILISEC %TIME TOTAL AVERAGE
  418.  
  419. # TAG: topuser_num n
  420. #      How many users in topsites report. 0 = no limit
  421. #
  422. #topuser_num 0
  423.