Your message dated Tue, 13 Feb 2018 17:34:29 +0000 with message-id <e1eletn-000ihz...@fasolo.debian.org> and subject line Bug#845455: fixed in sarg 2.3.11-1 has caused the Debian Bug report #845455, regarding sarg: Documentation update needed for sarg-reports to be marked as done.
This means that you claim that the problem has been dealt with. If this is not the case it is now your responsibility to reopen the Bug report if necessary, and/or fix the problem forthwith. (NB: If you are a system administrator and have no idea what this message is talking about, this may indicate a serious mail system misconfiguration somewhere. Please contact ow...@bugs.debian.org immediately.) -- 845455: https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=845455 Debian Bug Tracking System Contact ow...@bugs.debian.org with problems
--- Begin Message ---Package: sarg Version: 2.3.10-2 Severity: minor Dear Maintainer, I have been trying to set up sarg and while researching solutions to my problems I came across bug 818429 (https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=818429) whose proposed fix was merged into the version this report relates to. The fix adds functionality but documentation (both within the script /usr/sbin/sarg-reports and the manpage) has not been updated and I imagine that users may not understand that only minimal configuration changes are required to make things work in a useful way. In fact it seems that the Debian package maintainers have made several changes to the sarg-reports script over time (I haven't looked at the full change log) as can be seen by comparing the distribution version with the openSUSE version of the same file (https://build.opensuse.org/package/view_file/openSUSE:Factory/sarg/sarg-reports?expand=1) which carries the same version number. I would like to propose changes to the internal documentation of the script (a patch file follows) and to the man page (changes to the text alone follow, in patch format - I don't have experience working with man pages). The revised version number is only a suggestion, of course; I assume you will determine an appropriate version number. It seems to me that fixing the documentation would go some way towards solving the problem raised in bug 369693 (https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=369693), at least as far as sarg is concerned, and especially for users of sarg-reports. --------------------------<snip><Start of patch><snip>---------------------------- --- sarg-reports +++ sarg-reports.proposed @@ -6,7 +6,7 @@ # - martijn # - Stas Degteff https://sourceforge.net/users/stas_degteff/ -VER=20050202 +VER=debian-sarg-2.3.10-2 ## What is this? # sarg-reports (this file) is a simple bash script written to automate @@ -43,11 +43,14 @@ # 30 02 1 * * sarg-reports monthly # --- END ROOT CRONTAB --- # -# REMEMBER: if you use logrotate, configure it to rotate the logs within MONTHLY basis, -# AFTER sarg-reports created the monthly html report. +# REMEMBER: if you use logrotate, configure it to retain enough logs to ensure availability +# of data for the longest period for which you need a report. +# See https://sourceforge.net/p/sarg/wiki/Keeping%20enough%20log%20to%20process/ +# This version of sarg-reports will use the log file defined in sarg.conf and also +# prior log files which have been rotated out of that location # 3) Customize the following variables: -# (Please, configure accurately the sarg.conf file before) +# (Please, configure accurately the sarg-reports.conf file before) # # (SARG) The sarg executable location # (CONFIG) The sarg main configuration file location @@ -299,6 +302,9 @@ ## HISTORY: +# debian-sarg-2.3.10-2 - use all rotated log files, pass through options from command line +# debian-sarg-? - added reports_autorm function (not used) +# ... - ? # 20050502 - Stas Degteff added support for non latin Charset and added support for OpenBSD # 20030826 - FreeBSD support (thanks to martijn to let me coding on your FreeBSD server :-)) # 20030715 - Some cleanups @@ -314,6 +320,3 @@ # doesn't like this script do: "7 days ago to yesterday" # - Monthly recognition isn't so elegant (is very ugly, i know) # - Suggestions are welcome :-) -# - If you Rotate the squid logs before sarg-reports will run, -# it will not create any html reports -# (TIPS: Rotate the logs after sarg-reports) ---------------------------<snip><End of patch><snip>----------------------------- --------------------------<snip><Start of patch><snip>---------------------------- --- sarg-reports-manpage +++ sarg-reports-manpage.proposed @@ -8,7 +8,7 @@ This manual page documents briefly the sarg-reports command. sarg-reports is a script written to automate the SARG (a powerful squid - log analyzer) reports and log management. Sarg it self, provide to end + log analyzer) reports and log management. Sarg itself, provides to end user a generic interface to create reports based on squid access log (begin of log to current date). sarg-reports is useful because it allow you to easly create and manage Daily, Weekly and Monthly reports. @@ -28,6 +28,8 @@ monthly Create Monthly report + Any further parameters supplied will be passed through to sarg. + CRONTAB If you want the reports can be generated automatically insert the following lines (the today report creation time depend mostly of your @@ -39,8 +41,12 @@ 00 01 * * 1 sarg-reports weekly 30 02 1 * * sarg-reports monthly - REMEMBER: if you use logrotate, configure it to rotate the logs within - MONTHLY basis, AFTER sarg-reports created the monthly html report. + REMEMBER: if you use logrotate, configure it to retain enough logs to + ensure availability of data for the longest period for which you need + a report. Log rotation frequency is unimportant. See + https://sourceforge.net/p/sarg/wiki/Keeping%20enough%20log%20to%20process/ + This version of sarg-reports will use the log file defined in sarg.conf + and also prior log files which have been rotated out of that location. VARIABLES Check before using the sarg-reports that the following variables are ---------------------------<snip><End of patch><snip>-----------------------------
--- End Message ---
--- Begin Message ---Source: sarg Source-Version: 2.3.11-1 We believe that the bug you reported is fixed in the latest version of sarg, which is due to be installed in the Debian FTP archive. A summary of the changes between this version and the previous one is attached. Thank you for reporting the bug, which will now be closed. If you have further comments please address them to 845...@bugs.debian.org, and the maintainer will reopen the bug report if appropriate. Debian distribution maintenance software pp. Luigi Gangitano <lu...@debian.org> (supplier of updated sarg package) (This message was generated automatically at their request; if you believe that there is a problem with it please contact the archive administrators by mailing ftpmas...@ftp-master.debian.org) -----BEGIN PGP SIGNED MESSAGE----- Hash: SHA512 Format: 1.8 Date: Tue, 13 Feb 2018 17:12:57 +0100 Source: sarg Binary: sarg Architecture: source amd64 Version: 2.3.11-1 Distribution: unstable Urgency: medium Maintainer: Luigi Gangitano <lu...@debian.org> Changed-By: Luigi Gangitano <lu...@debian.org> Description: sarg - squid analysis report generator Closes: 845455 845546 850624 853651 872425 Changes: sarg (2.3.11-1) unstable; urgency=medium . * New upstream version - Fixes FTBFS with GCC 7 (Closes: #853651) - Removed gettext patch integrated upstream . * debian/control - Fix man directory (Closes: #850624, thanks to Michael Stapelberg) . * debian/sarg-reports{,.1,.conf} - Added EXCLUDELOG3 filter (Closes: #872425, thanks to Matus UHLAR) - Added documentation (Closes: #845455, thanks to r...@chardmore.net) - Added lastlog options (Closes: #845546, thanks to r...@chardmore.net) . * debian/patches/0002-fix-build-errors.patch - Fix more build errors . * debian/rules - Removed autotools-dev debhelper calls Checksums-Sha1: 0e9ef41a7457015a36854ed1e16c57cb34be3b24 1758 sarg_2.3.11-1.dsc c535d1534dd0c7e3a3725d98eb0dd50246e489b0 1344002 sarg_2.3.11.orig.tar.gz 96100cefaccd0a9f546056371ca88c5d32a06cd2 21800 sarg_2.3.11-1.debian.tar.xz 90813f1297d66db578473672500d1f7c27ca4620 281712 sarg-dbgsym_2.3.11-1_amd64.deb a131c6cff9cc8c15f6d2fa9c2f9cfb3b8910f8a0 6818 sarg_2.3.11-1_amd64.buildinfo 1cc299b32e03878ac1435e6454db579ad4ffaa72 170176 sarg_2.3.11-1_amd64.deb Checksums-Sha256: d220cbb646733a343f69ea4d3f0f3760ac93fabe15cc3dc716a63aea94253bf5 1758 sarg_2.3.11-1.dsc 499f698d4bba7d116dada83232a414adb2727fd8f6c048a022208848116fe4f3 1344002 sarg_2.3.11.orig.tar.gz 6afbf233acfebe38a934df2a2f10783b42dab7ec87f59665595dd8b0da8a727a 21800 sarg_2.3.11-1.debian.tar.xz ba062bd2bea7fe082935ddc98219073c56d9ff61e0179a5bd88a84441017f945 281712 sarg-dbgsym_2.3.11-1_amd64.deb 6a0ba52effaded9cf49154c9e1ac60d2b337e6963dc42a6b7a82a3dc3c6771e7 6818 sarg_2.3.11-1_amd64.buildinfo ddae2b881c10ac95d7d54b09ca50a7c300a0003d9fad4df529db96c7e8e65b2d 170176 sarg_2.3.11-1_amd64.deb Files: 12deda90f9a61d8d58c58f637027e2e4 1758 web optional sarg_2.3.11-1.dsc 5366f3a9fe4354043b43700362c5e84e 1344002 web optional sarg_2.3.11.orig.tar.gz d8ed7f0c614434a60e6e5106b4f78abd 21800 web optional sarg_2.3.11-1.debian.tar.xz 017f2b0241f7598da7d6c1bf073a761c 281712 debug optional sarg-dbgsym_2.3.11-1_amd64.deb 2feb7183197f718bdffc883d694d7a2c 6818 web optional sarg_2.3.11-1_amd64.buildinfo 19db5157bd868e6b084b297818ff8c04 170176 web optional sarg_2.3.11-1_amd64.deb -----BEGIN PGP SIGNATURE----- iQIzBAEBCgAdFiEEjUhaNf8ebreQ5Q9tAoTyDCupfO0FAlqDHjQACgkQAoTyDCup fO1nVxAAqjkpS6brbEMiMe+GIjjrnIU16QfMBWo5EVUZr2roMWcCp/90V+dkDyiB Qjscacyj3KUSB6kkHQfqEM2hauoNsC2H1feIFvaSnYhhB2CNFHvvLF9vmtomDApc i3Nc9w3t1aSTeytOkDYDVRFXWZA7gbw99/zDBq1K4gyF7RIzxHxCH9qEa5QDRXau mQ5RgSy7X5n0Ff/RTsye5f9CxxxfPVAfASom2TviBcC1DFjFE08o8v7oV+DssNaN B7pjxenZGDdMdXyPXf37a2yh8CMzSIH9LihDd7dfvce2ovs4iNU0loM93KyFDUJs RM633iK7rM/J0peIi1n4y8gCJ+qg9ucr/w8L3eXVyCUSZkAqjV9NT3O7Pldaga8p /MkYmH6p91iX0uyjR7GRW9r/t+2qecA5G6F9e/8r6r3wiCrq4WPm8fIUI2apAXCo zAhOZ7jukJZvcSa6m408IryrMmJmq9iSqyiPZJKcZgT9GhdEVcFk98Iu1rl0xBcD ukeyGJ2U+Q18ilUeRGzIW8TxVcHTSSQHxVOQ50E91dN21AdtfcpPFkC4IWbzqP6j 8HhNFdcWb1a6onFWbqsxWVyLCEs5JbD25ztYRY2MRMvknMgJt5Jh3z4rQwVhFYpn Ocv3q1IYUKRefdtX9gXyQrj6tMmAJTcxO4uQhy4oDqhKFy1SgL0= =l00p -----END PGP SIGNATURE-----
--- End Message ---
