From c5a21657d1a2d8c0f9836f0e1444e002db2aa5d2 Mon Sep 17 00:00:00 2001 From: des Date: Wed, 4 Jul 2007 14:30:22 +0000 Subject: [PATCH] The beginnings of "Inside the Varnish HTTP accelerator" git-svn-id: svn+ssh://projects.linpro.no/svn/varnish/trunk@1643 d4fa192b-c00b-0410-8231-f00ffab90ce4 --- varnish-doc/en/inside-varnish/article.xml | 301 ++++++++++++++++++++++ 1 file changed, 301 insertions(+) create mode 100644 varnish-doc/en/inside-varnish/article.xml diff --git a/varnish-doc/en/inside-varnish/article.xml b/varnish-doc/en/inside-varnish/article.xml new file mode 100644 index 00000000..64f83689 --- /dev/null +++ b/varnish-doc/en/inside-varnish/article.xml @@ -0,0 +1,301 @@ + + + +
+ + $Id$ + Inside the Varnish HTTP Accelerator + + +
+ Repository organization + + The Varnish SVN repository is organized as follows: + + + + branches + + Branches of the main source tree, mainly for release + engineering purposes. + + + + tags + + Static copies of past releases. + + + + trunk + + This is where active development takes place. Code + is merged from here to a branch prior to a release. + + + varnish-cache + + Varnish itself, with its accompanying tools, + code libraries and man pages. + + + bin + + Programs, including Varnish itself. + + + varnishadm + + A command-line interface to the + management port. + + + + varnishd + + The Varnish HTTP accelerator + itself. + + + + varnishhist + + A tool that displays a histogram + of requests grouped by processing time, + using different symbols for hits and + misses. + + + + varnishlog + + An all-purpose log-watching and + log-saving tool. Mostly used to store + log data for later processing by the + other log-watching tools. + + + + varnishncsa + + A log-watching tool that displays + log data in the Apache / NCSA combined + log format, suitable for further + processing by standard log analysis + tools such as AWStats. + + + + varnishreplay + + A tool that reads Varnish log data + and attempts to recreate the HTTP + traffic that resulted in said data; + useful for debugging and + benchmarking. + + + + varnishstat + + A tool that displays statistics + from a running Varnish server. + + + + varnishtop + + A tool that reads Varnish log data + and displays an ordered list of the most + frequently reoccurring log + entries. + + + + + + + include + + Header files for the code libraries. + + + compat + + Header files for libcompat. + + + + + + + lib + + Code libraries. + + + libcompat + + Compatibility library which + implements a number of functions (such + as strlcpy and + vasprintf) which + are present on some but not all of the + platforms Varnish runs on. + + + + libvarnish + + Utility library which implements a + number of non-Varnish-specific functions + (including a CRC32 implementation and a + generic binary heap implementation) + which are used both by Varnish and some + of the accompanying tools. + + + + libvarnishapi + + Interface library, not used by + Varnish itself, but used by applications + which need to interface with + Varnish. + + + + libvcl + + VCL to C translator. + + + + + + + man + + + + + + varnish-doc + + The Varnish documentation, except man pages, + which are kept alongside the source code. + + + + varnish-tools + + Various development and testing tools. + + + + + + +
+ +
+ The accelerator + +
+ Principles of operation + +
+ +
+ Subsystems + +
+ +
+ Data structures + +
+
+ +
+ The log tailers + +
+ varnishlog + +
+ +
+ varnishncsa + +
+
+ +
+ The statistics gatherers + +
+ varnishstat + +
+ +
+ varnishhist + +
+ +
+ varnishtop + +
+
+ +
+ The test framework + +
+ +
+ Plugins + + The trunk/varnish-tools directory in + the Varnish repository contains Varnish plugins for several + popular system monitoring and administration frameworks. + +
+ Munin + +
+ +
+ Nagios + +
+ +
+ Webmin + +
+
+ +
+ Other tools + +
+ varnishadm + +
+ +
+ varnishreplay + +
+ +
+ fetcher + +
+
+
-- 2.39.5