vlogger-1.3/0000755000372000037200000000000010216564717011763 5ustar shadeshadevlogger-1.3/vlogger.10000644000372000037200000001660010216564454013513 0ustar shadeshade.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.14 .\" .\" Standard preamble: .\" ======================================================================== .de Sh \" Subsection heading .br .if t .Sp .ne 5 .PP \fB\\$1\fR .PP .. .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. | will give a .\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to .\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C' .\" expand to `' in nroff, nothing in troff, for use with C<>. .tr \(*W-|\(bv\*(Tr .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' 'br\} .\" .\" If the F register is turned on, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . nr % 0 . rr F .\} .\" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .hy 0 .if n .na .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "VLOGGER 1" .TH VLOGGER 1 "2005-03-18" "perl v5.8.6" "User Contributed Perl Documentation" .SH "NAME" vlogger \- flexible log rotation and usage tracking in perl .SH "SYNOPSIS" .IX Header "SYNOPSIS" vlogger [\s-1OPTIONS\s0]... [\s-1LOGDIR\s0] .SH "DESCRIPTION" .IX Header "DESCRIPTION" Vlogger is designed to make webserver log rotation simple and easy to manage. It deals with VirtualHost logs automatically, so only one directive is required to manage all hosts on a webserver. Vlogger takes piped output from Apache or another webserver, splits off the first field, and writes the logs to logfiles in subdirectories. It uses a filehandle cache to avoid resource limitations. It will start a new logfile at the beginning of a new day, and optionally start new files when a certain filesize is reached. It can maintain a symlink to the most recent log for easy access. Optionally, host parsing can be disabled for use in ErrorLog directives. .PP To use vlogger, you need to add a \*(L"%v\*(R" to the first part of your LogFormat: .PP LogFormat \*(L"%v \f(CW%h\fR \f(CW%l\fR \f(CW%u\fR \f(CW%t\fR \e\*(R"%r\e\*(L" %>s \f(CW%b\fR \e\*(R"%{Referer}i\e\*(L" \e\*(R"%{User\-Agent}i\e"" combined .PP Then call it from a customlog: .PP CustomLog \*(L"| /usr/local/sbin/vlogger \-s access.log \-u www-logs \-g www-logs /var/log/apache\*(R" combined .SH "OPTIONS" .IX Header "OPTIONS" Options are given in short format on the command line. .PP \&\-a Do not autoflush files. This may improve performance but may break logfile analyzers that depend on full entries in the logs. .PP \&\-e ErrorLog mode. In this mode, the host parsing is disabled, and the file is written out using the template under the specified \s-1LOGDIR\s0. .PP \&\-n Disables rotation. This option disables rotation altogether. .PP \&\-f \s-1MAXFILES\s0 Maximum number of filehandles to keep open. Defaults to 100. Setting this value too high may result in the system running out of file descriptors. Setting it too low may affect performance. .PP \&\-u \s-1UID\s0 Change user to \s-1UID\s0 when running as root. .PP \&\-g \s-1GID\s0 Change group to \s-1GID\s0 when running as root. .PP \&\-t \s-1TEMPLATE\s0 Filename template using Date::Format codes. Default is \*(L"%m%d%Y\-access.log\*(R", or \*(L"%m%d%Y\-error.log\*(R". When using the \-r option, the default becomes \&\*(L"%m%d%Y\-%T\-access.log\*(R" or \*(L"%m%d%Y\-%T\-error.log\*(R". .PP \&\-s \s-1SYMLINK\s0 Specifies the name of a symlink to the current file. .PP \&\-r \s-1SIZE\s0 Rotate files when they reach \s-1SIZE\s0. \s-1SIZE\s0 is given in bytes. .PP \&\-d \s-1CONFIG\s0 Use the \s-1DBI\s0 usage tracker. .PP \&\-h Displays help. .PP \&\-v Prints version information. .SH "DBI USAGE TRACKER" .IX Header "DBI USAGE TRACKER" .Vb 9 \& Vlogger can automatically keep track of per-virtualhost usage statistics in a \&database. DBI and the relevant drivers (eg. DBD::mysql) needs to be installed for \&this to work. Create a table in your database to hold the data. A "mysql_create.sql" \&script is provided for using this feature with MySQL. Configure the dsn, user, pass \&and dump values in the vlogger-dbi.conf file. The "dump" parameter controls how often \&vlogger will dump its stats into the database (the default is 30 seconds). Copy this \&file to somewhere convienient on your filesystem (like /etc/apache/vlogger-dbi.conf) and \&start vlogger with "-d /etc/apache/vlogger-dbi.conf". You might want to use this feature \&to easily bill customers on a daily/weekly/monthly basis for bandwidth usage. .Ve .SH "SEE ALSO \fIcronolog\fP\|(1), \fIhttplog\fP\|(1)" .IX Header "SEE ALSO cronolog, httplog" .SH "BUGS None, yet." .IX Header "BUGS None, yet." .SH "AUTHORS Steve J. Kondik " .IX Header "AUTHORS Steve J. Kondik " \&\s-1WWW:\s0 http://n0rp.chemlab.org/vlogger vlogger-1.3/COPYING0000644000372000037200000006131407624547562013033 0ustar shadeshade GNU LIBRARY GENERAL PUBLIC LICENSE Version 2, June 1991 Copyright (C) 1991 Free Software Foundation, Inc. 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. [This is the first released version of the library GPL. It is numbered 2 because it goes with version 2 of the ordinary GPL.] Preamble The licenses for most software are designed to take away your freedom to share and change it. By contrast, the GNU General Public Licenses are intended to guarantee your freedom to share and change free software--to make sure the software is free for all its users. This license, the Library General Public License, applies to some specially designated Free Software Foundation software, and to any other libraries whose authors decide to use it. You can use it for your libraries, too. When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for this service if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs; and that you know you can do these things. To protect your rights, we need to make restrictions that forbid anyone to deny you these rights or to ask you to surrender the rights. These restrictions translate to certain responsibilities for you if you distribute copies of the library, or if you modify it. For example, if you distribute copies of the library, whether gratis or for a fee, you must give the recipients all the rights that we gave you. You must make sure that they, too, receive or can get the source code. If you link a program with the library, you must provide complete object files to the recipients so that they can relink them with the library, after making changes to the library and recompiling it. And you must show them these terms so they know their rights. Our method of protecting your rights has two steps: (1) copyright the library, and (2) offer you this license which gives you legal permission to copy, distribute and/or modify the library. Also, for each distributor's protection, we want to make certain that everyone understands that there is no warranty for this free library. If the library is modified by someone else and passed on, we want its recipients to know that what they have is not the original version, so that any problems introduced by others will not reflect on the original authors' reputations. Finally, any free program is threatened constantly by software patents. We wish to avoid the danger that companies distributing free software will individually obtain patent licenses, thus in effect transforming the program into proprietary software. To prevent this, we have made it clear that any patent must be licensed for everyone's free use or not licensed at all. Most GNU software, including some libraries, is covered by the ordinary GNU General Public License, which was designed for utility programs. This license, the GNU Library General Public License, applies to certain designated libraries. This license is quite different from the ordinary one; be sure to read it in full, and don't assume that anything in it is the same as in the ordinary license. The reason we have a separate public license for some libraries is that they blur the distinction we usually make between modifying or adding to a program and simply using it. Linking a program with a library, without changing the library, is in some sense simply using the library, and is analogous to running a utility program or application program. However, in a textual and legal sense, the linked executable is a combined work, a derivative of the original library, and the ordinary General Public License treats it as such. Because of this blurred distinction, using the ordinary General Public License for libraries did not effectively promote software sharing, because most developers did not use the libraries. We concluded that weaker conditions might promote sharing better. However, unrestricted linking of non-free programs would deprive the users of those programs of all benefit from the free status of the libraries themselves. This Library General Public License is intended to permit developers of non-free programs to use free libraries, while preserving your freedom as a user of such programs to change the free libraries that are incorporated in them. (We have not seen how to achieve this as regards changes in header files, but we have achieved it as regards changes in the actual functions of the Library.) The hope is that this will lead to faster development of free libraries. The precise terms and conditions for copying, distribution and modification follow. Pay close attention to the difference between a "work based on the library" and a "work that uses the library". The former contains code derived from the library, while the latter only works together with the library. Note that it is possible for a library to be covered by the ordinary General Public License rather than by this special one. GNU LIBRARY GENERAL PUBLIC LICENSE TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 0. This License Agreement applies to any software library which contains a notice placed by the copyright holder or other authorized party saying it may be distributed under the terms of this Library General Public License (also called "this License"). Each licensee is addressed as "you". A "library" means a collection of software functions and/or data prepared so as to be conveniently linked with application programs (which use some of those functions and data) to form executables. The "Library", below, refers to any such software library or work which has been distributed under these terms. A "work based on the Library" means either the Library or any derivative work under copyright law: that is to say, a work containing the Library or a portion of it, either verbatim or with modifications and/or translated straightforwardly into another language. (Hereinafter, translation is included without limitation in the term "modification".) "Source code" for a work means the preferred form of the work for making modifications to it. For a library, complete source code means all the source code for all modules it contains, plus any associated interface definition files, plus the scripts used to control compilation and installation of the library. Activities other than copying, distribution and modification are not covered by this License; they are outside its scope. The act of running a program using the Library is not restricted, and output from such a program is covered only if its contents constitute a work based on the Library (independent of the use of the Library in a tool for writing it). Whether that is true depends on what the Library does and what the program that uses the Library does. 1. You may copy and distribute verbatim copies of the Library's complete source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice and disclaimer of warranty; keep intact all the notices that refer to this License and to the absence of any warranty; and distribute a copy of this License along with the Library. You may charge a fee for the physical act of transferring a copy, and you may at your option offer warranty protection in exchange for a fee. 2. You may modify your copy or copies of the Library or any portion of it, thus forming a work based on the Library, and copy and distribute such modifications or work under the terms of Section 1 above, provided that you also meet all of these conditions: a) The modified work must itself be a software library. b) You must cause the files modified to carry prominent notices stating that you changed the files and the date of any change. c) You must cause the whole of the work to be licensed at no charge to all third parties under the terms of this License. d) If a facility in the modified Library refers to a function or a table of data to be supplied by an application program that uses the facility, other than as an argument passed when the facility is invoked, then you must make a good faith effort to ensure that, in the event an application does not supply such function or table, the facility still operates, and performs whatever part of its purpose remains meaningful. (For example, a function in a library to compute square roots has a purpose that is entirely well-defined independent of the application. Therefore, Subsection 2d requires that any application-supplied function or table used by this function must be optional: if the application does not supply it, the square root function must still compute square roots.) These requirements apply to the modified work as a whole. If identifiable sections of that work are not derived from the Library, and can be reasonably considered independent and separate works in themselves, then this License, and its terms, do not apply to those sections when you distribute them as separate works. But when you distribute the same sections as part of a whole which is a work based on the Library, the distribution of the whole must be on the terms of this License, whose permissions for other licensees extend to the entire whole, and thus to each and every part regardless of who wrote it. Thus, it is not the intent of this section to claim rights or contest your rights to work written entirely by you; rather, the intent is to exercise the right to control the distribution of derivative or collective works based on the Library. In addition, mere aggregation of another work not based on the Library with the Library (or with a work based on the Library) on a volume of a storage or distribution medium does not bring the other work under the scope of this License. 3. You may opt to apply the terms of the ordinary GNU General Public License instead of this License to a given copy of the Library. To do this, you must alter all the notices that refer to this License, so that they refer to the ordinary GNU General Public License, version 2, instead of to this License. (If a newer version than version 2 of the ordinary GNU General Public License has appeared, then you can specify that version instead if you wish.) Do not make any other change in these notices. Once this change is made in a given copy, it is irreversible for that copy, so the ordinary GNU General Public License applies to all subsequent copies and derivative works made from that copy. This option is useful when you wish to copy part of the code of the Library into a program that is not a library. 4. You may copy and distribute the Library (or a portion or derivative of it, under Section 2) in object code or executable form under the terms of Sections 1 and 2 above provided that you accompany it with the complete corresponding machine-readable source code, which must be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange. If distribution of object code is made by offering access to copy from a designated place, then offering equivalent access to copy the source code from the same place satisfies the requirement to distribute the source code, even though third parties are not compelled to copy the source along with the object code. 5. A program that contains no derivative of any portion of the Library, but is designed to work with the Library by being compiled or linked with it, is called a "work that uses the Library". Such a work, in isolation, is not a derivative work of the Library, and therefore falls outside the scope of this License. However, linking a "work that uses the Library" with the Library creates an executable that is a derivative of the Library (because it contains portions of the Library), rather than a "work that uses the library". The executable is therefore covered by this License. Section 6 states terms for distribution of such executables. When a "work that uses the Library" uses material from a header file that is part of the Library, the object code for the work may be a derivative work of the Library even though the source code is not. Whether this is true is especially significant if the work can be linked without the Library, or if the work is itself a library. The threshold for this to be true is not precisely defined by law. If such an object file uses only numerical parameters, data structure layouts and accessors, and small macros and small inline functions (ten lines or less in length), then the use of the object file is unrestricted, regardless of whether it is legally a derivative work. (Executables containing this object code plus portions of the Library will still fall under Section 6.) Otherwise, if the work is a derivative of the Library, you may distribute the object code for the work under the terms of Section 6. Any executables containing that work also fall under Section 6, whether or not they are linked directly with the Library itself. 6. As an exception to the Sections above, you may also compile or link a "work that uses the Library" with the Library to produce a work containing portions of the Library, and distribute that work under terms of your choice, provided that the terms permit modification of the work for the customer's own use and reverse engineering for debugging such modifications. You must give prominent notice with each copy of the work that the Library is used in it and that the Library and its use are covered by this License. You must supply a copy of this License. If the work during execution displays copyright notices, you must include the copyright notice for the Library among them, as well as a reference directing the user to the copy of this License. Also, you must do one of these things: a) Accompany the work with the complete corresponding machine-readable source code for the Library including whatever changes were used in the work (which must be distributed under Sections 1 and 2 above); and, if the work is an executable linked with the Library, with the complete machine-readable "work that uses the Library", as object code and/or source code, so that the user can modify the Library and then relink to produce a modified executable containing the modified Library. (It is understood that the user who changes the contents of definitions files in the Library will not necessarily be able to recompile the application to use the modified definitions.) b) Accompany the work with a written offer, valid for at least three years, to give the same user the materials specified in Subsection 6a, above, for a charge no more than the cost of performing this distribution. c) If distribution of the work is made by offering access to copy from a designated place, offer equivalent access to copy the above specified materials from the same place. d) Verify that the user has already received a copy of these materials or that you have already sent this user a copy. For an executable, the required form of the "work that uses the Library" must include any data and utility programs needed for reproducing the executable from it. However, as a special exception, the source code distributed need not include anything that is normally distributed (in either source or binary form) with the major components (compiler, kernel, and so on) of the operating system on which the executable runs, unless that component itself accompanies the executable. It may happen that this requirement contradicts the license restrictions of other proprietary libraries that do not normally accompany the operating system. Such a contradiction means you cannot use both them and the Library together in an executable that you distribute. 7. You may place library facilities that are a work based on the Library side-by-side in a single library together with other library facilities not covered by this License, and distribute such a combined library, provided that the separate distribution of the work based on the Library and of the other library facilities is otherwise permitted, and provided that you do these two things: a) Accompany the combined library with a copy of the same work based on the Library, uncombined with any other library facilities. This must be distributed under the terms of the Sections above. b) Give prominent notice with the combined library of the fact that part of it is a work based on the Library, and explaining where to find the accompanying uncombined form of the same work. 8. You may not copy, modify, sublicense, link with, or distribute the Library except as expressly provided under this License. Any attempt otherwise to copy, modify, sublicense, link with, or distribute the Library is void, and will automatically terminate your rights under this License. However, parties who have received copies, or rights, from you under this License will not have their licenses terminated so long as such parties remain in full compliance. 9. You are not required to accept this License, since you have not signed it. However, nothing else grants you permission to modify or distribute the Library or its derivative works. These actions are prohibited by law if you do not accept this License. Therefore, by modifying or distributing the Library (or any work based on the Library), you indicate your acceptance of this License to do so, and all its terms and conditions for copying, distributing or modifying the Library or works based on it. 10. Each time you redistribute the Library (or any work based on the Library), the recipient automatically receives a license from the original licensor to copy, distribute, link with or modify the Library subject to these terms and conditions. You may not impose any further restrictions on the recipients' exercise of the rights granted herein. You are not responsible for enforcing compliance by third parties to this License. 11. If, as a consequence of a court judgment or allegation of patent infringement or for any other reason (not limited to patent issues), conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot distribute so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not distribute the Library at all. For example, if a patent license would not permit royalty-free redistribution of the Library by all those who receive copies directly or indirectly through you, then the only way you could satisfy both it and this License would be to refrain entirely from distribution of the Library. If any portion of this section is held invalid or unenforceable under any particular circumstance, the balance of the section is intended to apply, and the section as a whole is intended to apply in other circumstances. It is not the purpose of this section to induce you to infringe any patents or other property right claims or to contest validity of any such claims; this section has the sole purpose of protecting the integrity of the free software distribution system which is implemented by public license practices. Many people have made generous contributions to the wide range of software distributed through that system in reliance on consistent application of that system; it is up to the author/donor to decide if he or she is willing to distribute software through any other system and a licensee cannot impose that choice. This section is intended to make thoroughly clear what is believed to be a consequence of the rest of this License. 12. If the distribution and/or use of the Library is restricted in certain countries either by patents or by copyrighted interfaces, the original copyright holder who places the Library under this License may add an explicit geographical distribution limitation excluding those countries, so that distribution is permitted only in or among countries not thus excluded. In such case, this License incorporates the limitation as if written in the body of this License. 13. The Free Software Foundation may publish revised and/or new versions of the Library General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Library specifies a version number of this License which applies to it and "any later version", you have the option of following the terms and conditions either of that version or of any later version published by the Free Software Foundation. If the Library does not specify a license version number, you may choose any version ever published by the Free Software Foundation. 14. If you wish to incorporate parts of the Library into other free programs whose distribution conditions are incompatible with these, write to the author to ask for permission. For software which is copyrighted by the Free Software Foundation, write to the Free Software Foundation; we sometimes make exceptions for this. Our decision will be guided by the two goals of preserving the free status of all derivatives of our free software and of promoting the sharing and reuse of software generally. NO WARRANTY 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. END OF TERMS AND CONDITIONS How to Apply These Terms to Your New Libraries If you develop a new library, and you want it to be of the greatest possible use to the public, we recommend making it free software that everyone can redistribute and change. You can do so by permitting redistribution under these terms (or, alternatively, under the terms of the ordinary General Public License). To apply these terms, attach the following notices to the library. It is safest to attach them to the start of each source file to most effectively convey the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found. Copyright (C) This library is free software; you can redistribute it and/or modify it under the terms of the GNU Library General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public License for more details. You should have received a copy of the GNU Library General Public License along with this library; if not, write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307 USA. Also add information on how to contact you by electronic and paper mail. You should also get your employer (if you work as a programmer) or your school, if any, to sign a "copyright disclaimer" for the library, if necessary. Here is a sample; alter the names: Yoyodyne, Inc., hereby disclaims all copyright interest in the library `Frob' (a library for tweaking knobs) written by James Random Hacker. , 1 April 1990 Ty Coon, President of Vice That's all there is to it! vlogger-1.3/vlogger-dbi.conf0000644000372000037200000000012407624547567015045 0ustar shadeshadedsn DBI:mysql:database=wwwusage;host=localhost user wwwusage pass wwwusage dump 30 vlogger-1.3/mysql_create.sql0000644000372000037200000000021210216170027015152 0ustar shadeshadeCREATE TABLE WWWUSAGE ( VHOST VARCHAR(128) NOT NULL, LDATE INT(8) UNSIGNED NOT NULL, BYTES INT(32) UNSIGNED NOT NULL DEFAULT '0' ); vlogger-1.3/vlogger0000755000372000037200000003764010216564426013365 0ustar shadeshade#!/usr/bin/perl -T # # vlogger - smarter logging for apache # steve j. kondik # # this script will take piped logs in STDIN, break off the first component # and log the line into the proper directory under $LOGDIR. it will roll the # logs over at midnight on-the-fly and maintain a symlink to the most recent log. # # # This library is free software; you can redistribute it and/or # modify it under the terms of the GNU Library General Public # License as published by the Free Software Foundation; either # version 2 of the License, or (at your option) any later version. # # This library is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU # Library General Public License for more details. # # # CHANGELOG: # 0.1 initial release # 0.2 cleanups, added -e option for errorlogs, added strict stuff # 0.3 cleanups, bugfixes, docs, added -r size rotation option # 0.4 added dbi usage tracking option, code cleanups from cz@digitalfreaks.org # 1.0 small bugfixes, first production release # 1.1 bugfix release # 1.2 support for mod_logio # 1.3 various contributed bugfixes # # # TODO: # configurable file compression using Compress::Zlib, maybe. # package vlogger; $ENV{PATH} = "/bin:/usr/bin"; my $VERSION = "1.3"; =head1 NAME vlogger - flexible log rotation and usage tracking in perl =head1 SYNOPSIS vlogger [OPTIONS]... [LOGDIR] =head1 DESCRIPTION Vlogger is designed to make webserver log rotation simple and easy to manage. It deals with VirtualHost logs automatically, so only one directive is required to manage all hosts on a webserver. Vlogger takes piped output from Apache or another webserver, splits off the first field, and writes the logs to logfiles in subdirectories. It uses a filehandle cache to avoid resource limitations. It will start a new logfile at the beginning of a new day, and optionally start new files when a certain filesize is reached. It can maintain a symlink to the most recent log for easy access. Optionally, host parsing can be disabled for use in ErrorLog directives. To use vlogger, you need to add a "%v" to the first part of your LogFormat: LogFormat "%v %h %l %u %t \"%r\" %>s %b \"%{Referer}i\" \"%{User-Agent}i\"" combined Then call it from a customlog: CustomLog "| /usr/local/sbin/vlogger -s access.log -u www-logs -g www-logs /var/log/apache" combined =head1 OPTIONS Options are given in short format on the command line. -a Do not autoflush files. This may improve performance but may break logfile analyzers that depend on full entries in the logs. -e ErrorLog mode. In this mode, the host parsing is disabled, and the file is written out using the template under the specified LOGDIR. -n Disables rotation. This option disables rotation altogether. -f MAXFILES Maximum number of filehandles to keep open. Defaults to 100. Setting this value too high may result in the system running out of file descriptors. Setting it too low may affect performance. -u UID Change user to UID when running as root. -g GID Change group to GID when running as root. -t TEMPLATE Filename template using Date::Format codes. Default is "%m%d%Y-access.log", or "%m%d%Y-error.log". When using the -r option, the default becomes "%m%d%Y-%T-access.log" or "%m%d%Y-%T-error.log". -s SYMLINK Specifies the name of a symlink to the current file. -r SIZE Rotate files when they reach SIZE. SIZE is given in bytes. -d CONFIG Use the DBI usage tracker. -h Displays help. -v Prints version information. =head1 DBI USAGE TRACKER Vlogger can automatically keep track of per-virtualhost usage statistics in a database. DBI and the relevant drivers (eg. DBD::mysql) needs to be installed for this to work. Create a table in your database to hold the data. A "mysql_create.sql" script is provided for using this feature with MySQL. Configure the dsn, user, pass and dump values in the vlogger-dbi.conf file. The "dump" parameter controls how often vlogger will dump its stats into the database (the default is 30 seconds). Copy this file to somewhere convienient on your filesystem (like /etc/apache/vlogger-dbi.conf) and start vlogger with "-d /etc/apache/vlogger-dbi.conf". You might want to use this feature to easily bill customers on a daily/weekly/monthly basis for bandwidth usage. =head1 SEE ALSO cronolog(1), httplog(1) =head1 BUGS None, yet. =head1 AUTHORS Steve J. Kondik WWW: http://n0rp.chemlab.org/vlogger =cut # a couple modules we need use strict; no strict "refs"; use warnings; use sigtrap qw(handler exitall HUP USR1 TERM INT PIPE); use Date::Format; use Getopt::Std; use IO::Handle; # get command line options our %OPTS; getopts( 'f:t:s:hu:g:aeivr:d:', \%OPTS ); # print out version if ( $OPTS{'v'} ) { print "VLogger $VERSION (apache logfile parser)\n"; print "Written by Steve J. Kondik \n\n"; print "This is free software; see the source for copying conditions. There is NO\n"; print "warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.\n"; exit; } # print help if ( $OPTS{'h'} || !$ARGV[0] ) { usage(); exit; } # log directory my $LOGDIR; if ( $ARGV[0] ) { if ( !-d $ARGV[0] ) { print STDERR "[vlogger] target directory $ARGV[0] does not exist - exiting.\n\n"; exit; } $LOGDIR = $ARGV[0]; } $LOGDIR =~ /(.*)/; $LOGDIR = $1; # change uid/gid if requested (and running as root) if ( $> == "0" ) { if ( $OPTS{'g'} ) { my $guid = getgrnam( $OPTS{'g'} ); if ( !defined $guid || $guid == 0 ) { print STDERR "[vlogger] cannot run as root or nonexistant group.\n\n"; exit; } $) = $guid; $( = $guid; if ( $) != $guid and $) != ( $guid - 2**32 ) ) { die "fatal: setgid to gid $guid failed\n"; } } if ( $OPTS{'u'} ) { my $uuid = getpwnam( $OPTS{'u'} ); if ( !defined $uuid || $uuid == 0 ) { print STDERR "[vlogger] cannot run as root or nonexistant user.\n\n"; exit; } $> = $uuid; $< = $uuid; if ( $> != $uuid and $> != ( $uuid - 2**32 ) ) { die "fatal: setuid to uid $uuid failed\n"; } } } # set up dbi stuffs my $DBI_DSN; my $DBI_USER; my $DBI_PASS; my $DBI_DUMP; if ( $OPTS{'d'} ) { if ( $OPTS{'e'} ) { print "-d not valid with -e. exiting.\n"; exit; } eval "use DBI"; open CONF, $OPTS{'d'}; while () { chomp; my @conf = split (/\s/); if ( $conf[0] eq "dsn" ) { $DBI_DSN = $conf[1]; } elsif ( $conf[0] eq "user" ) { $DBI_USER = $conf[1]; } elsif ( $conf[0] eq "pass" ) { $DBI_PASS = $conf[1]; } elsif ( $conf[0] eq "dump" ) { $DBI_DUMP = $conf[1]; } } close CONF; unless ( $DBI_DSN && $DBI_USER && $DBI_PASS && $DBI_DUMP ) { print "All values for DBI configuration are not properly defined.\n\n"; exit; } # test the connection my $dbh = DBI->connect( $DBI_DSN, $DBI_USER, $DBI_PASS ) or die "DBI Error: $!"; $dbh->disconnect; # SIGALRM dumps the tracker hash $SIG{ALRM} = \&dump_tracker; alarm $DBI_DUMP; } # max files to keep open my $MAXFILES; if ( $OPTS{'f'} ) { $MAXFILES = $OPTS{'f'}; } else { $MAXFILES = "100"; } # filesize rotation my $MAXSIZE; if ( $OPTS{'r'} ) { $MAXSIZE = $OPTS{'r'}; } # filename template my $TEMPLATE; if ( $OPTS{'t'} ) { $TEMPLATE = $OPTS{'t'}; $TEMPLATE =~ /(.*)/; $TEMPLATE = $1; } elsif ( $OPTS{'e'} ) { if ( $OPTS{'r'} ) { $TEMPLATE = "%m%d%Y-%T-error.log"; } else { $TEMPLATE = "%m%d%Y-error.log"; } } else { if ( $OPTS{'r'} ) { $TEMPLATE = "%m%d%Y-%T-access.log"; } else { $TEMPLATE = "%m%d%Y-access.log"; } } # symlink if ( $OPTS{'s'} ) { $OPTS{'s'} =~ /(.*)/; $OPTS{'s'} = $1; } # chroot to the logdir chdir($LOGDIR); chroot("."); my %logs = (); my %tracker = (); my $LASTDUMP = time(); # pick a mode if ( $OPTS{'e'} ) { $0 = "vlogger (error log)"; # errorlog mode open ELOG, ">>" . time2str( $TEMPLATE, time() ) or die ( "can't open $LOGDIR/" . time2str( $TEMPLATE, time() ) ); unless ( $OPTS{'a'} ) { ELOG->autoflush(1); } if ( $OPTS{'s'} ) { if ( -l $OPTS{'s'} ) { unlink( $OPTS{'s'} ); } symlink( time2str( $TEMPLATE, time() ), $OPTS{'s'} ); } my $LASTWRITE = time(); while ( my $log_line = ) { unless ( $OPTS{'n'} ) { if ( time2str( "%Y%m%d", time() ) > time2str( "%Y%m%d", $LASTWRITE ) ) { # open a new file close ELOG; open_errorlog(); } elsif ( $OPTS{'r'} ) { # check the size my @filesize = ELOG->stat; print $filesize[7] . "\n"; if ( $filesize[7] > $MAXSIZE ) { close ELOG; open_errorlog(); } } $LASTWRITE = time(); } # we dont need to do any other parsing at all, so write the line. print ELOG $log_line; } } else { # accesslog mode $0 = "vlogger (access log)"; while ( my $log_line = ) { # parse out the first word (the vhost) my @this_line = split ( /\s/, $log_line ); my ($vhost) = $this_line[0]; my $reqsize = $this_line[10]; $vhost = lc($vhost) || "default"; if ( $vhost =~ m#[/\\]# ) { $vhost = "default" } $vhost =~ /(.*)/o; $vhost = $1; if ( $OPTS{'i'} ) { $reqsize = $this_line[1] + $this_line[2]; } # if we're writing to a log, and it rolls to a new day, close all files. unless ( $OPTS{'n'} ) { if ( $logs{$vhost} && ( time2str( "%Y%m%d", time() ) > time2str( "%Y%m%d", $logs{$vhost} ) ) ) { foreach my $key ( keys %logs ) { close $key; } %logs = (); } elsif ( $OPTS{'r'} && $logs{$vhost} ) { # check the size my @filesize = $vhost->stat; if ( $filesize[7] > $MAXSIZE ) { close $vhost; delete( $logs{$vhost} ); } } } # open a new log if ( !$logs{$vhost} ) { # check how many files we have open, close the oldest one if ( keys(%logs) > $MAXFILES ) { my ( $key, $value ) = sort { $logs{$a} <=> $logs{$b} } ( keys(%logs) ); close $key; delete( $logs{$key} ); } # check if directory is there unless ( -d "${vhost}" ) { mkdir("${vhost}"); } # open the file using the template open $vhost, ">>${vhost}/" . time2str( $TEMPLATE, time() ) or die ( "can't open $LOGDIR/${vhost}/" . time2str( $TEMPLATE, time() ) ); # autoflush the handle unless -a if ( !$OPTS{'a'} ) { $vhost->autoflush(1); } # make a symlink if -s if ( $OPTS{'s'} ) { chdir("${vhost}"); if ( -l $OPTS{'s'} ) { unlink( $OPTS{'s'} ); } symlink( time2str( $TEMPLATE, time() ), $OPTS{'s'} ); chdir(".."); } } # update the timestamp and write the line $logs{$vhost} = time(); if ($OPTS{'i'}) { $log_line =~ s/^\S*\s+\S*\s+\S*\s+//o; } else { $log_line =~ s/^\S*\s+//o; } if ( $reqsize =~ m/\d|/ && $reqsize > 0 ) { $tracker{$vhost} += $reqsize; } print $vhost $log_line; } } # sub to close all files sub closeall { if ( $OPTS{'e'} ) { close ELOG; } else { foreach my $key ( keys %logs ) { close $key; } %logs = (); if ( $OPTS{'d'} ) { vlogger::dump_tracker(); } } } sub exitall { vlogger::closeall; exit; } # sub to open new errorlog sub open_errorlog { open ELOG, ">>" . time2str( $TEMPLATE, time() ) or die ( "can't open $LOGDIR/" . time2str( $TEMPLATE, time() ) ); if ( $OPTS{'s'} ) { if ( -l $OPTS{'s'} ) { unlink( $OPTS{'s'} ); } symlink( time2str( $TEMPLATE, time() ), $OPTS{'s'} ); } # autoflush it unless -a unless ( $OPTS{'a'} ) { ELOG->autoflush(1); } } # sub to update the database with the tracker data sub dump_tracker { if ( keys(%tracker) > 0 ) { my $dbh = DBI->connect( $DBI_DSN, $DBI_USER, $DBI_PASS ) or warn "DBI Error: $!"; foreach my $key ( keys(%tracker) ) { my $ts = time2str( "%m%d%Y", time() ); my $sth = $dbh->prepare( "select * from wwwusage where vhost='" . $key . "' and ldate='" . $ts . "'" ); $sth->execute; if ( $sth->rows ) { my $query = "update wwwusage set bytes=bytes+" . $tracker{$key} . " where vhost='" . $key . "' and ldate='" . $ts . "'"; $dbh->do($query); } else { my $query = "insert into wwwusage (vhost, ldate, bytes) values ('$key', '$ts', '$tracker{$key}')"; $dbh->do($query); } } $dbh->disconnect; %tracker = (); } alarm $DBI_DUMP; } # print usage info sub usage { print "Usage: vlogger [OPTIONS]... [LOGDIR]\n"; print "Handles a piped logfile from a webserver, splitting it into it's\n"; print "host components, and rotates the files daily.\n\n"; print " -a do not autoflush files\n"; print " -e errorlog mode\n"; print " -n don't rotate files\n"; print " -f MAXFILES max number of files to keep open\n"; print " -u UID uid to switch to when running as root\n"; print " -g GID gid to switch to when running as root\n"; print " -t TEMPLATE filename template (see perldoc Date::Format)\n"; print " -s SYMLINK maintain a symlink to most recent file\n"; print " -r SIZE rotate when file reaches SIZE\n"; print " -d CONFIG use DBI usage tracker (see perldoc vlogger)\n"; print " -i extract mod_logio instead of filesize\n"; print " -h display this help\n"; print " -v output version information\n\n"; print "TEMPLATE may be a filename with Date::Format codes. The default template\n"; print "is %m%d%Y-access.log. SYMLINK is the name of a file that will be linked to\n"; print "the most recent file inside the log directory. The default is access.log.\n"; print "MAXFILES is the maximum number of filehandles to cache. This defaults to 100.\n"; print "When running with -a, performance may improve, but this might confuse some\n"; print "log analysis software that expects complete log entries at all times.\n"; print "Errorlog mode is used when running with an Apache errorlog. In this mode,\n"; print "virtualhost parsing is disabled, and a single file is written in LOGDIR\n"; print "using the TEMPLATE (%m%d%Y-error.log is default for -e). When running with\n"; print "-r, the template becomes %m%d%Y-%T-xxx.log. SIZE is given in bytes.\n\n"; print "Report bugs to .\n"; } vlogger-1.3/README0000644000372000037200000000046110216564523012637 0ustar shadeshadevlogger - virtual web logfile rotater/parser (c) 2005 - steve j. kondik see COPYING for license information. vlogger requires perl and Date::Format, availiable from CPAN. optionally, DBI will be used for the tracker feature if enabled. see vlogger(1), or perldoc vlogger for usage.