varnish 相关说明

一、关于Varnish

Varnish 是一款高性能且开源的反向代理服务器和 HTTP 加速器，其采用全新的软件体系机构，和现在的硬件体系紧密配合，与传统的 squid 相比，varnish 具有性能更高、速度更快、管理更加方便等诸多优点，很多大型的网站都开始尝试使用 varnish 来替换 squid，这些都促进 varnish 迅速发展起来。挪威的最大的在线报纸 Verdens Gang(vg.no) 使用  台 Varnish 代替了原来的  台 Squid，性能比以前更好，这是 Varnish 最成功的应用案例。

、varnish系统架构

varnish主要运行两个进程：Management进程和Child进程(也叫Cache进程)。

Management进程主要实现应用新的配置、编译VCL、监控varnish、初始化varnish以及提供一个命令行接口等。Management进程会每隔几秒钟探测一下Child进程以判断其是否正常运行，如果在指定的时长内未得到Child进程的回应，Management将会重启此Child进程。

Child进程包含多种类型的线程，常见的如：
Acceptor线程：接收新的连接请求并响应；
Worker线程：child进程会为每个会话启动一个worker线程，因此，在高并发的场景中可能会出现数百个worker线程甚至更多；
Expiry线程：从缓存中清理过期内容；

Varnish依赖“工作区(workspace)”以降低线程在申请或修改内存时出现竞争的可能性。在varnish内部有多种不同的工作区，其中最关键的当属用于管理会话数据的session工作区。

、varnish日志

为了与系统的其它部分进行交互，Child进程使用了可以通过文件系统接口进行访问的共享内存日志(shared memory log)，因此，如果某线程需要记录信息，其仅需要持有一个锁，而后向共享内存中的某内存区域写入数据，再释放持有的锁即可。而为了减少竞争，每个worker线程都使用了日志数据缓存。

共享内存日志大小一般为90M，其分为两部分，前一部分为计数器，后半部分为客户端请求的数据。varnish提供了多个不同的工具如varnishlog、varnishncsa或varnishstat等来分析共享内存日志中的信息并能够以指定的方式进行显示。

、VCL

Varnish Configuration Language (VCL)是varnish配置缓存策略的工具，它是一种基于“域”(domain specific)的简单编程语言，它支持有限的算术运算和逻辑运算操作、允许使用正则表达式进行字符串匹配、允许用户使用set自定义变量、支持if判断语句，也有内置的函数和变量等。使用VCL编写的缓存策略通常保存至.vcl文件中，其需要编译成二进制的格式后才能由varnish调用。事实上，整个缓存策略就是由几个特定的子例程如vcl_recv、vcl_fetch等组成，它们分别在不同的位置(或时间)执行，如果没有事先为某个位置自定义子例程，varnish将会执行默认的定义。

VCL策略在启用前，会由management进程将其转换为C代码，而后再由gcc编译器将C代码编译成二进制程序。编译完成后，management负责将其连接至varnish实例，即child进程。正是由于编译工作在child进程之外完成，它避免了装载错误格式VCL的风险。因此，varnish修改配置的开销非常小，其可以同时保有几份尚在引用的旧版本配置，也能够让新的配置即刻生效。编译后的旧版本配置通常在varnish重启时才会被丢弃，如果需要手动清理，则可以使用varnishadm的vcl.discard命令完成。

、varnish的后端存储

varnish支持多种不同类型的后端存储，这可以在varnishd启动时使用-s选项指定。后端存储的类型包括：
()file：使用特定的文件存储全部的缓存数据，并通过操作系统的mmap()系统调用将整个缓存文件映射至内存区域(如果条件允许)；
()malloc：使用malloc()库调用在varnish启动时向操作系统申请指定大小的内存空间以存储缓存对象；
()persistent(experimental)：与file的功能相同，但可以持久存储数据(即重启varnish数据时不会被清除)；仍处于测试期；

varnish无法追踪某缓存对象是否存入了缓存文件，从而也就无从得知磁盘上的缓存文件是否可用，因此，file存储方法在varnish停止或重启时会清除数据。而persistent方法的出现对此有了一个弥补，但persistent仍处于测试阶段，例如目前尚无法有效处理要缓存对象总体大小超出缓存空间的情况，所以，其仅适用于有着巨大缓存空间的场景。

选择使用合适的存储方式有助于提升系统性，从经验的角度来看，建议在内存空间足以存储所有的缓存对象时使用malloc的方法，反之，file存储将有着更好的性能的表现。然而，需要注意的是，varnishd实际上使用的空间比使用-s选项指定的缓存空间更大，一般说来，其需要为每个缓存对象多使用差不多1K左右的存储空间，这意味着，对于100万个缓存对象的场景来说，其使用的缓存空间将超出指定大小1G左右。另外，为了保存数据结构等，varnish自身也会占去不小的内存空间。

为varnishd指定使用的缓存类型时，-s选项可接受的参数格式如下：
    malloc[,size] 或
    file[,path[,size[,granularity]]] 或
    persistent,path,size {experimental}

file中的granularity用于设定缓存空间分配单位，默认单位是字节，所有其它的大小都会被圆整。

二、安装varnish

三、HTTP协议与varnish

、缓存相关的HTTP首部

HTTP协议提供了多个首部用以实现页面缓存及缓存失效的相关功能，这其中最常用的有：
()Expires：用于指定某web对象的过期日期/时间，通常为GMT格式；一般不应该将此设定的未来过长的时间，一年的长度对大多场景来说足矣；其常用于为纯静态内容如JavaScripts样式表或图片指定缓存周期；
()Cache-Control：用于定义所有的缓存机制都必须遵循的缓存指示，这些指示是一些特定的指令，包括public、private、no-cache(表示可以存储，但在重新验正其有效性之前不能用于响应客户端请求)、no-store、max-age、s-maxage以及must-revalidate等；Cache-Control中设定的时间会覆盖Expires中指定的时间；
()Etag：响应首部，用于在响应报文中为某web资源定义版本标识符；
()Last-Mofified：响应首部，用于回应客户端关于Last-Modified-Since或If-None-Match首部的请求，以通知客户端其请求的web对象最近的修改时间；
()If-Modified-Since：条件式请求首部，如果在此首部指定的时间后其请求的web内容发生了更改，则服务器响应更改后的内容，否则，则响应304(not modified)；
()If-None-Match：条件式请求首部；web服务器为某web内容定义了Etag首部，客户端请求时能获取并保存这个首部的值(即标签)；而后在后续的请求中会通过If-None-Match首部附加其认可的标签列表并让服务器端检验其原始内容是否有可以与此列表中的某标签匹配的标签；如果有，则响应304，否则，则返回原始内容；
()Vary：响应首部，原始服务器根据请求来源的不同响应的可能会有所不同的首部，最常用的是Vary: Accept-Encoding，用于通知缓存机制其内容看起来可能不同于用户请求时Accept-Encoding-header首部标识的编码格式；
()Age：缓存服务器可以发送的一个额外的响应首部，用于指定响应的有效期限；浏览器通常根据此首部决定内容的缓存时长；如果响应报文首部还使用了max-age指令，那么缓存的有效时长为“max-age减去Age”的结果；

四、Varnish状态引擎(state engine)

VCL用于让管理员定义缓存策略，而定义好的策略将由varnish的management进程分析、转换成C代码、编译成二进制程序并连接至child进程。varnish内部有几个所谓的状态(state)，在这些状态上可以附加通过VCL定义的策略以完成相应的缓存处理机制，因此VCL也经常被称作“域专用”语言或状态引擎，“域专用”指的是有些数据仅出现于特定的状态中。

、VCL状态引擎

在VCL状态引擎中，状态之间具有相关性，但彼此间互相隔离，每个引擎使用return(x)来退出当前状态并指示varnish进入下一个状态。

varnish开始处理一个请求时，首先需要分析HTTP请求本身，比如从首部获取请求方法、验正其是否为一个合法的HTT请求等。当这些基本分析结束后就需要做出第一个决策，即varnish是否从缓存中查找请求的资源。这个决定的实现则需要由VCL来完成，简单来说，要由vcl_recv方法来完成。如果管理员没有自定义vcl_recv函数，varnish将会执行默认的vcl_recv函数。然而，即便管理员自定义了vcl_recv，但如果没有为自定义的vcl_recv函数指定其终止操作(terminating)，其仍将执行默认的vcl_recv函数。事实上，varnish官方强烈建议让varnish执行默认的vcl_recv以便处理自定义vcl_recv函数中的可能出现的漏洞。

、VCL语法

VCL的设计参考了C和Perl语言，因此，对有着C或Perl编程经验者来说，其非常易于理解。其基本语法说明如下：
()//、#或/* comment */用于注释
()sub $name 定义函数
()不支持循环，有内置变量
()使用终止语句，没有返回值
()域专用
()操作符：=(赋值)、==(等值比较)、~(模式匹配)、!(取反)、&&(逻辑与)、||(逻辑或)

VCL的函数不接受参数并且没有返回值，因此，其并非真正意义上的函数，这也限定了VCL内部的数据传递只能隐藏在HTTP首部内部进行。VCL的return语句用于将控制权从VCL状态引擎返回给Varnish，而非默认函数，这就是为什么VCL只有终止语句而没有返回值的原因。同时，对于每个“域”来说，可以定义一个或多个终止语句，以告诉Varnish下一步采取何种操作，如查询缓存或不查询缓存等。

、VCL的内置函数

VCL提供了几个函数来实现字符串的修改，添加bans，重启VCL状态引擎以及将控制权转回Varnish等。

regsub(str,regex,sub)
regsuball(str,regex,sub)：这两个用于基于正则表达式搜索指定的字符串并将其替换为指定的字符串；但regsuball()可以将str中能够被regex匹配到的字符串统统替换为sub，regsub()只替换一次；
ban(expression)：
ban_url(regex)：Bans所有其URL能够由regex匹配的缓存对象；
purge：从缓存中挑选出某对象以及其相关变种一并删除，这可以通过HTTP协议的PURGE方法完成；
hash_data(str)：
return()：当某VCL域运行结束时将控制权返回给Varnish，并指示Varnish如何进行后续的动作；其可以返回的指令包括：lookup、pass、pipe、hit_for_pass、fetch、deliver和hash等；但某特定域可能仅能返回某些特定的指令，而非前面列出的全部指令；
return(restart)：重新运行整个VCL，即重新从vcl_recv开始进行处理；每一次重启都会增加req.restarts变量中的值，而max_restarts参数则用于限定最大重启次数。

、vcl_recv

vcl_recv是在Varnish完成对请求报文的解码为基本数据结构后第一个要执行的子例程，它通常有四个主要用途：
()修改客户端数据以减少缓存对象差异性；比如删除URL中的www.等字符；
()基于客户端数据选用缓存策略；比如仅缓存特定的URL请求、不缓存POST请求等；
()为某web应用程序执行URL重写规则；
()挑选合适的后端Web服务器；

可以使用下面的终止语句，即通过return()向Varnish返回的指示操作：
pass：绕过缓存，即不从缓存中查询内容或不将内容存储至缓存中；
pipe：不对客户端进行检查或做出任何操作，而是在客户端与后端服务器之间建立专用“管道”，并直接将数据在二者之间进行传送；此时，keep-alive连接中后续传送的数据也都将通过此管道进行直接传送，并不会出现在任何日志中；
lookup：在缓存中查找用户请求的对象，如果缓存中没有其请求的对象，后续操作很可能会将其请求的对象进行缓存；
error：由Varnish自己合成一个响应报文，一般是响应一个错误类信息、重定向类信息或负载均衡器返回的后端web服务器健康状态检查类信息；

vcl_recv也可以通过精巧的策略完成一定意义上的安全功能，以将某些特定的攻击扼杀于摇篮中。同时，它也可以检查出一些拼写类的错误并将其进行修正等。

Varnish默认的vcl_recv专门设计用来实现安全的缓存策略，它主要完成两种功能：
()仅处理可以识别的HTTP方法，并且只缓存GET和HEAD方法；
()不缓存任何用户特有的数据；

安全起见，一般在自定义的vcl_recv中不要使用return()终止语句，而是再由默认vcl_recv进行处理，并由其做出相应的处理决策。

下面是一个自定义的使用示例：

sub vcl_recv {
    if (req.http.User-Agent ~ "iPad" ||
        req.http.User-Agent ~ "iPhone" ||
        req.http.User-Agent ~ "Android") {
            set req.http.X-Device = "mobile";
    } else {
            set req.http.X-Device = "desktop";
    }
}

此例中的VCL创建一个X-Device请求首部，其值可能为mobile或desktop，于是web服务器可以基于此完成不同类型的响应，以提高用户体验。

、vcl_fetch

如前面所述，相对于vcl_recv是根据客户端的请求作出缓存决策来说，vcl_fetch则是根据服务器端的响应作出缓存决策。在任何VCL状态引擎中返回的pass操作都将由vcl_fetch进行后续处理。vcl_fetch中有许多可用的内置变量，比如最常用的用于定义某对象缓存时长的beresp.ttl变量。通过return()返回给varnish的操作指示有：
()deliver：缓存此对象，并将其发送给客户端(经由vcl_deliver)；
()hit_for_pass：不缓存此对象，但可以导致后续对此对象的请求直接送达到vcl_pass进行处理；
()restart：重启整个VCL，并增加重启计数；超出max_restarts限定的最大重启次数后将会返回错误信息；
()error code [reason]：返回指定的错误代码给客户端并丢弃此请求；

默认的vcl_fetch放弃了缓存任何使用了Set-Cookie首部的响应。

五、修剪缓存对象

、缓存内容修剪

提高缓存命中率的最有效途径之一是增加缓存对象的生存时间(TTL)，但是这也可能会带来副作用，比如缓存的内容在到达为其指定的有效期之间已经失效。因此，手动检验缓存对象的有效性或者刷新缓存是缓存很有可能成为服务器管理员的日常工作之一，相应地，Varnish为完成这类的任务提供了三种途径：HTTP 修剪(HTTP purging)、禁用某类缓存对象(banning)和强制缓存未命令(forced cache misses)。

这里需要特殊说明的是，Varnish 2中的purge()操作在Varnish 3中被替换为了ban()操作，而Varnish 3也使用了purge操作，但为其赋予了新的功能，且只能用于vcl_hit或vcl_miss中替换Varnish 2中常用的set obj.ttl=0s。

在具体执行某清理工作时，需要事先确定如下问题：
()仅需要检验一个特定的缓存对象，还是多个？
()目的是释放内存空间，还是仅替换缓存的内容？
()是不是需要很长时间才能完成内容替换？
()这类操作是个日常工作，还是仅此一次的特殊需求？

、移除单个缓存对象

purge用于清理缓存中的某特定对象及其变种(variants)，因此，在有着明确要修剪的缓存对象时可以使用此种方式。HTTP协议的PURGE方法可以实现purge功能，不过，其仅能用于vcl_hit和vcl_miss中，它会释放内存工作并移除指定缓存对象的所有Vary:-变种，并等待下一个针对此内容的客户端请求到达时刷新此内容。另外，其一般要与return(restart)一起使用。下面是个在VCL中配置的示例。

acl purgers {
    "127.0.0.1";
    "192.168.0.0"/;
}

sub vcl_recv {
    if (req.request == "PURGE") {
        if (!client.ip ~ purgers) {
            error  "Method not allowed";
        }
        return (lookup);
    }
}
sub vcl_hit {
    if (req.request == "PURGE") {
        purge;
        error  "Purged";
    }
}
sub vcl_miss {
    if (req.request == "PURGE") {
        purge;
        error  "Not in cache";
    }
}
sub vcl_pass {
    if (req.request == "PURGE") {
        error  "PURGE on a passed object";
    }
}

客户端在发起HTTP请求时，只需要为所请求的URL使用PURGE方法即可，其命令使用方式如下：
# curl -I -X PURGE http://varniship/path/to/someurl

、强制缓存未命中

在vcl_recv中使用return(pass)能够强制到上游服务器取得请求的内容，但这也会导致无法将其缓存。使用purge会移除旧的缓存对象，但如果上游服务器宕机而无法取得新版本的内容时，此内容将无法再响应给客户端。使用req.has_always_miss=ture，可以让Varnish在缓存中搜寻相应的内容但却总是回应“未命中”，于是vcl_miss将后续地负责启动vcl_fetch从上游服务器取得新内容，并以新内容缓存覆盖旧内容。此时，如果上游服务器宕机或未响应，旧的内容将保持原状，并能够继续服务于那些未使用req.has_always_miss=true的客户端，直到其过期失效或由其它方法移除。

、Banning

ban()是一种从已缓存对象中过滤(filter)出某此特定的对象并将其移除的缓存内容刷新机制，不过，它并不阻止新的内容进入缓存或响应于请求。在Varnish中，ban的实现是指将一个ban添加至ban列表(ban-list)中，这可以通过命令行接口或VCL实现，它们的使用语法是相同的。ban本身就是一个或多个VCL风格的语句，它会在Varnish从缓存哈希(cache hash)中查找某缓存对象时对搜寻的对象进行比较测试，因此，一个ban语句就是类似匹配所有“以/downloads开头的URL”，或“响应首部中包含nginx的对象”。例如：
    ban req.http.host == "magedu.com" && req.url ~ "\.gif$"

定义好的所有ban语句会生成一个ban列表(ban-list)，新添加的ban语句会被放置在列表的首部。缓存中的所有对象在响应给客户端之前都会被ban列表检查至少一次，检查完成后将会为每个缓存创建一个指向与其匹配的ban语句的指针。Varnish在从缓存中获取对象时，总是会检查此缓存对象的指针是否指向了ban列表的首部。如果没有指向ban列表的首部，其将对使用所有的新添加的ban语句对此缓存对象进行测试，如果没有任何ban语句能够匹配，则更新ban列表。

对ban这种实现方式持反对意见有有之，持赞成意见者亦有之。反对意见主要有两种，一是ban不会释放内存，缓存对象仅在有客户端访问时被测试一次；二是如果缓存对象曾经被访问到，但却很少被再次访问时ban列表将会变得非常大。赞成的意见则主要集中在ban可以让Varnish在恒定的时间内完成向ban列表添加ban的操作，例如在有着数百万个缓存对象的场景中，添加一个ban也只需要在恒定的时间内即可完成。其实现方法本处不再详细说明。

六、Varnish检测后端主机的健康状态

Varnish可以检测后端主机的健康状态，在判定后端主机失效时能自动将其从可用后端主机列表中移除，而一旦其重新变得可用还可以自动将其设定为可用。为了避免误判，Varnish在探测后端主机的健康状态发生转变时(比如某次探测时某后端主机突然成为不可用状态)，通常需要连续执行几次探测均为新状态才将其标记为转换后的状态。

每个后端服务器当前探测的健康状态探测方法通过.probe进行设定，其结果可由req.backend.healthy变量获取，也可通过varnishlog中的Backend_health查看或varnishadm的debug.health查看。

backend web1 {
    .host = "www.magedu.com";
    .probe = {
        .url = "/.healthtest.html";
        .interval = 1s;
        .window = ;
        .threshold = ;
    }
}

.probe中的探测指令常用的有：
() .url：探测后端主机健康状态时请求的URL，默认为“/”；
() .request: 探测后端主机健康状态时所请求内容的详细格式，定义后，它会替换.url指定的探测方式；比如：
    .request =
        "GET /.healthtest.html HTTP/1.1"
        "Host: www.magedu.com"
        "Connection: close";
() .window：设定在判定后端主机健康状态时基于最近多少次的探测进行，默认是8；
() .threshold：在.window中指定的次数中，至少有多少次是成功的才判定后端主机正健康运行；默认是3；
() .initial：Varnish启动时对后端主机至少需要多少次的成功探测，默认同.threshold；
() .expected_response：期望后端主机响应的状态码，默认为200；
() .interval：探测请求的发送周期，默认为5秒；
() .timeout：每次探测请求的过期时长，默认为2秒；

因此，如上示例中表示每隔1秒对此后端主机www.magedu.com探测一次，请求的URL为http://www.magedu.com/.healthtest.html，在最近5次的探测请求中至少有2次是成功的(响应码为200)就判定此后端主机为正常工作状态。

如果Varnish在某时刻没有任何可用的后端主机，它将尝试使用缓存对象的“宽容副本”(graced copy)，当然，此时VCL中的各种规则依然有效。因此，更好的办法是在VCL规则中判断req.backend.healthy变量显示某后端主机不可用时，为此后端主机增大req.grace变量的值以设定适用的宽容期限长度。

七、Varnish使用多台后端主机

Varnish中可以使用director指令将一个或多个近似的后端主机定义为一个逻辑组，并可以指定的调度方式(也叫挑选方法)来轮流将请求发送至这些主机上。不同的director可以使用同一个后端主机，而某director也可以使用“匿名”后端主机(在director中直接进行定义)。每个director都必须有其专用名，且在定义后必须在VCL中进行调用，VCL中任何可以指定后端主机的位置均可以按需将其替换为调用某已定义的director。

backend web1 {
    .host = "backweb1.magedu.com";
    .port = "";
}

director webservers random {
  .retries = ;
  {
    .backend = web1;
    .weight  = ;
  }
  {
    .backend  = {
      .host = "backweb2.magedu.com";
      .port = "";
    }
      .weight         = ;
  }
}

如上示例中，web1为显式定义的后端主机，而webservers这个directors还包含了一个“匿名”后端主机(backweb2.magedu.com)。webservers从这两个后端主机中挑选一个主机的方法为random，即以随机方式挑选。

Varnish的director支持的挑选方法中比较简单的有round-robin和random两种。其中，round-robin类型没有任何参数，只需要为其指定各后端主机即可，挑选方式为“轮叫”，并在某后端主机故障时不再将其视作挑选对象；random方法随机从可用后端主机中进行挑选，每一个后端主机都需要一个.weight参数以指定其权重，同时还可以director级别使用.retires参数来设定查找一个健康后端主机时的尝试次数。

Varnish 2.1.0后，random挑选方法又多了两种变化形式client和hash。client类型的director使用client.identity作为挑选因子，这意味着client.identity相同的请求都将被发送至同一个后端主机。client.identity默认为client.ip，但也可以在VCL中将其修改为所需要的标识符。类似地，hash类型的director使用hash数据作为挑选因子，这意味着对同一个URL的请求将被发往同一个后端主机，其常用于多级缓存的场景中。然而，无论是client还hash，当其倾向于使用后端主机不可用时将会重新挑选新的后端其机。

另外还有一种称作fallback的director，用于定义备用服务器，如下所示：

director b3 fallback {
  { .backend = www1; }
  { .backend = www2; } // will only be used if www1 is unhealthy.
  { .backend = www3; } // will only be used if both www1 and www2
                       // are unhealthy.
}

在vcl_recv上，一般要用
    set req.backend = DIRECTOR

八、varnish管理进阶

、可调参数

Varnish有许多参数，虽然大多数场景中这些参数的默认值都可以工作得很好，然而特定的工作场景中要想有着更好的性能的表现，则需要调整某些参数。可以在管理接口中使用param.show命令查看这些参数，而使用param.set则能修改这些参数的值。然而，在命令行接口中进行的修改不会保存至任何位置，因此，重启varnish后这些设定会消失。此时，可以通过启动脚本使用-p选项在varnishd启动时为其设定参数的值。然而，除非特别需要对其进行修改，保持这些参数为默认值可以有效降低管理复杂度。

、共享内存日志

共享内存日志(shared memory log)通常被简称为shm-log，它用于记录日志相关的数据，大小为80M。varnish以轮转(round-robin)的方式使用其存储空间。一般不需要对shm-log做出更多的设定，但应该避免其产生I/O，这可以使用tmpfs实现，其方法为在/etc/fstab中设定一个挂载至/var/lib/varnish目录(或其它自定义的位置)临时文件系统即可。

、线程模型(Trheading model)

varnish的child进程由多种不同的线程组成，分别用于完成不同的工作。例如：
    cache-worker线程：每连接一个，用于处理请求；
    cache-main线程：全局只有一个，用于启动cache；
    ban lurker线程：一个，用于清理bans；
    acceptor线程：一个，用于接收新的连接请求；
    epoll/kqueue线程：数量可配置，默认为2，用于管理线程池；
    expire线程：一个，用于移除老化的内容；
    backend poll线程：每个后端服务器一个，用于检测后端服务器的健康状况；

在配置varnish时，一般只需为关注cache-worker线程，而且也只能配置其线程池的数量，而除此之外的其它均非可配置参数。与此同时，线程池的数量也只能在流量较大的场景下才需要增加，而且经验表明其多于2个对提升性能并无益处。

、线程相关的参数(Threading parameters)

varnish为每个连接使用一个线程，因此，其worker线程的最大数决定了varnish的并发响应能力。下面是线程池相关的各参数及其配置：

thread_pool_add_delay       [milliseconds]
thread_pool_add_threshold   [requests]
thread_pool_fail_delay      [milliseconds]
thread_pool_max             [threads]
thread_pool_min             [threads]
thread_pool_purge_delay     [milliseconds]
thread_pool_stack           [bytes]
thread_pool_timeout         [seconds]
thread_pool_workspace       [bytes]
thread_pools                [pools]
thread_stats_rate           [requests]

其中最关键的当属thread_pool_max和thread_pool_min，它们分别用于定义每个线程池中的最大线程数和最少线程数。因此，在某个时刻，至少有thread_pool_min*thread_pools个worker线程在运行，但至多不能超出thread_pool_max*thread_pools个。根据需要，这两个参数的数量可以进行调整，varnishstat命令的n_wrk_queued可以显示当前varnish的线程数量是否足够，如果队列中始终有不少的线程等待运行，则可以适当调大thread_pool_max参数的值。但一般建议每台varnish服务器上最多运行的worker线程数不要超出5000个。

当某连接请求到达时，varnish选择一个线程池负责处理此请求。而如果此线程池中的线程数量已经达到最大值，新的请求将会被放置于队列中或被直接丢弃。默认线程池的数量为2，这对最繁忙的varnish服务器来说也已经足够。

、

九、Varnish的命令行工具

、varnishadm命令

命令语法：varnishadm [-t timeout] [-S secret_file] [-T address:port] [-n name] [command [...]]

通过命令行的方式连接至varnishd进行管理操作的工具，指定要连接的varnish实例的方法有两种：
-n name —— 连接至名称为“name”的实例；
-T address:port —— 连接至指定套接字上的实例；

其运行模式有两种，当不在命令行中给出要执行的"command"时，其将进入交互式模式；否则，varnishadm将执行指定的"command"并退出。要查看本地启用的缓存，可使用如下命令进行。
# varnishadm -S /etc/varnish/secret -T 127.0.0.1: storage.list

sub vcl_deliver {

  if (obj.hits > ) {
    set resp.http.X-Cache = "HIT";
  } else {
    set resp.http.X-Cache = "MISS";
  }
}

sub vcl_deliver {
        if (obj.hits > ) {
                set resp.http.X-Cache = "HIT via" + " " + server.hostname;
        } else {
                set resp.http.X-Cache = "MISS via" + " " + server.hostname;
        }
}

sub vcl_recv {
        if (req.url ~ "^/test.html$") {
                return(pass);
        }
}

sub vcl_fetch {

        if (req.request == "GET" && req.url ~ "\.(html|jpg|jpeg)$") {
                set beresp.ttl = 3600s;
        }
}

sub vcl_fetch {
    if (beresp.http.cache-control !~ "s-maxage") {
        if (req.url ~ "\.jpg(\?|$)") {
            set beresp.ttl = 30s;
            unset beresp.http.Set-Cookie;
        }
        if (req.url ~ "\.html(\?|$)") {
            set beresp.ttl = 10s;
            unset beresp.http.Set-Cookie;
        }
    } else {
        if (beresp.ttl > 0s) {
            unset beresp.http.Set-Cookie;
        }
    }
}

sub vcl_error {
    synthetic "<html><body><!-- Something was wrong! --></body></html>";
    set obj.status = ;
    return (deliver);
}

1.1,
request
response

Cache-Control   = "Cache-Control" ":" #cache-directive
    cache-directive = cache-request-directive
         | cache-response-directive
    cache-request-directive =
           "no-cache"
         | "no-store" (backup)
         | "max-age" "=" delta-seconds
         | "max-stale" [ "=" delta-seconds ]
         | "min-fresh" "=" delta-seconds
         | "no-transform"
         | "only-if-cached"
         | cache-extension
     cache-response-directive =
           "public"
         | "private" [ "=" <"> 1#field-name <"> ]
         | "no-cache" [ "=" <"> 1#field-name <"> ]
         | "no-store"
         | "no-transform"
         | "must-revalidate"
         | "proxy-revalidate"
         | "max-age" "=" delta-seconds
         | "s-maxage" "=" delta-seconds
         | cache-extension                        

sub vcl_deliver {
        set resp.http.X-Age = resp.http.Age;
        unset resp.http.Age;

        if (obj.hits > ) {
                set resp.http.X-Cache = “HIT”;
        } else {
                set resp.http.X-Cache = “MISS”;
        }
}

acl purgers {
        “127.0.0.1”;
        “192.168.0.0”/;
}

sub vcl_recv {
        if (req.request == “PURGE”) {
                if (!client.ip ~ purgers) {
                        error  “Method not allowed”;
                }
                return (lookup);
        }
}

sub vcl_hit {
        if (req.request == “PURGE”) {
                purge;
                error  “Purged”;
        }
}
sub vcl_miss {
        if (req.request == “PURGE”) {
                purge;
                error  “Not in cache”;
        }
}
sub vcl_pass {
        if (req.request == “PURGE”) {
                error  “PURGE on a passed object”;
        }
}

sed /pattern/string/g

在请求的时候使用curl -H PURGE URL

regsub(str, regex, sub)
regsub($req.url, www\.maged\.com, www.mageedu.com)

purge: 让缓存失效的；
ban()

URL rewrite

VCL - functions
  regsub(str, regex, sub)
  regsuball(str, regex, sub)
  ban_url(regex)
  ban(expression)
  purge;
  return(restart)
  return()
  hash_data()

子例程

vcl_recv {

}

cookie

# Drop any cookies sent to Wordpress.
    sub vcl_recv {
        if (!(req.url ~ "wp-(login|admin)")) {
            unset req.http.cookie;
        }
    }

    # Drop any cookies Wordpress tries to send back to the client.
    sub vcl_fetch {
        if (!(req.url ~ "wp-(login|admin)")) {
            unset beresp.http.set-cookie;
        }
    }

Variables

Although subroutines take no arguments, the necessary information is made available to the handler subroutines through global variables.

The following variables are always available:

now
The current time, in seconds since the epoch. When used in string context it returns a formatted string.

The following variables are available in backend declarations:

.host
    Host name or IP address of a backend.
.port
    Service name or port number of a backend.

The following variables are available while processing a request:

client.ip
    The client's IP address.

client.identity
    Identification of the client, used to load balance in the client director.

server.hostname
    The host name of the server.

server.identity
    The identity of the server, as set by the -i parameter. If the -i parameter is not passed to varnishd, server.identity will be set to the name of the instance, as specified by the -n parameter.

server.ip
    The IP address of the socket on which the client connection was received.

server.port
    The port number of the socket on which the client connection was received.

req.request
    The request type (e.g. "GET", "HEAD").

req.url
    The requested URL.

req.proto
    The HTTP protocol version used by the client.

req.backend
    The backend to use to service the request.

req.backend.healthy
    Whether the backend is healthy or not. Requires an active probe to be set on the backend.

req.http.HEADER
    The corresponding HTTP header.

    req.http.connection
    req.http.accept-encoding

req.hash_always_miss
    Force a cache miss for this request. If set to true Varnish will disregard any existing objects and always (re)fetch from the backend.

req.hash_ignore_busy
    Ignore any busy object during cache lookup. You would want to do this if you have two server looking up content from each other to avoid potential deadlocks.

req.can_gzip
    Does the client accept the gzip transfer encoding.

req.restarts
    A count of how many times this request has been restarted.

    http://www.magedu.com/123.jgp http://www.magedu.com/12/3.jpg

req.esi
Boolean. Set to false to disable ESI processing regardless of any value in beresp.do_esi. Defaults to true. This variable is subject to change in future versions, you should avoid using it.

req.esi_level
A count of how many levels of ESI requests we're currently at.

req.grace
Set to a period to enable grace.

req.xid
Unique ID of this request.

The following variables are available while preparing a backend request (either for a cache miss or for pass or pipe mode):

bereq.request
    The request type (e.g. "GET", "HEAD").

bereq.url
    The requested URL.

bereq.proto
    The HTTP protocol version used to talk to the server.

bereq.http.header
    The corresponding HTTP header.

bereq.connect_timeout
    The time in seconds to wait for a backend connection.

bereq.first_byte_timeout
    The time in seconds to wait for the first byte from the backend. Not available in pipe mode.

bereq.between_bytes_timeout
    The time in seconds to wait between each received byte from the backend. Not available in pipe mode.

The following variables are available after the requested object has been retrieved from the backend, before it is entered into the cache. In other words, they are available in vcl_fetch:

beresp.do_stream
Deliver the object to the client directly without fetching the whole object into varnish. If this request is pass'ed it will not be stored in memory. As of Varnish Cache 3.0 the object will marked as busy as it is delivered so only client can access the object.

beresp.do_esi
Boolean. ESI-process the object after fetching it. Defaults to false. Set it to true to parse the object for ESI directives. Will only be honored if
req.esi is true.

beresp.do_gzip
Boolean. Gzip the object before storing it. Defaults to false.

beresp.do_gunzip
Boolean. Unzip the object before storing it in the cache. Defaults to false.

beresp.http.header
    The corresponding HTTP header.

beresp.proto
    The HTTP protocol version used the backend replied with.

beresp.status
    The HTTP status code returned by the server.

beresp.response
    The HTTP status message returned by the server.

beresp.ttl
The object's remaining time to live, in seconds. beresp.ttl is writable.

beresp.grace
Set to a period to enable grace.

beresp.saintmode
Set to a period to enable saint mode.

beresp.backend.name
Name of the backend this response was fetched from.

beresp.backend.ip
    IP of the backend this response was fetched from.

beresp.backend.port
    Port of the backend this response was fetched from.

beresp.storage
Set to force Varnish to save this object to a particular storage backend.

After the object is entered into the cache, the following (mostly read-only) variables are available when the object has been located in cache, typically in vcl_hit, or when constructing a synthetic reply in vcl_error:

obj.proto
    The HTTP protocol version used when the object was retrieved.

obj.status
    The HTTP status code returned by the server.

obj.response
    The HTTP status message returned by the server.

obj.ttl
    The object's remaining time to live, in seconds. obj.ttl is writable.

obj.lastuse
The approximate time elapsed since the object was last requests, in seconds. This variable is also available in vcl_deliver.

obj.hits
    The approximate number of times the object has been delivered. A value of  indicates a cache miss. This variable is also available in vcl_deliver.

obj.grace
The object's grace period in seconds. obj.grace is writable.

obj.http.header
    The corresponding HTTP header.

The following variables are available while determining the hash key of an object:

req.hash
The hash key used to refer to an object in the cache. Used when both reading from and writing to the cache.
The following variables are available while preparing a response to the client:

resp.proto
    The HTTP protocol version to use for the response.

resp.status
    The HTTP status code that will be returned.

resp.response
    The HTTP status message that will be returned.

resp.http.header
    The corresponding HTTP header.

Values may be assigned to variables using the set keyword:

sub vcl_recv {
  # Normalize the Host: header
  if (req.http.host ~ "(?i)^(www.)?magedu.com$") {
    set req.http.host = "www.magedu.com";
  }
}

HTTP headers can be removed entirely using the remove keyword:

sub vcl_fetch {
  # Don't cache cookies
  remove beresp.http.Set-Cookie;
}

例子：

backend www {
  .host = "www.magedu.com";
  .port = "";
}

backend images {
  .host = "images.magedu.com";
  .port = "";
}

sub vcl_recv {
  if (req.http.host ~ "(?i)^(www.)?magedu.com$") {
    set req.http.host = "www.magedu.com";
    set req.backend = www;
  } elsif (req.http.host ~ "(?i)^images.magedu.com$") {
    set req.backend = images;
  } else {
    error  "Unknown virtual host";
  }
}

即使用户的请求中使用了cookie，仍然查找缓存；但用于设定cookie的内容则不做缓存；

sub vcl_recv {
  if (req.request == "GET" && req.http.cookie) {
     return(lookup);
  }
}

sub vcl_fetch {
  if (beresp.http.Set-Cookie) {
     return(deliver);
 }
}

Backend probes：

Backends can be probed to see whether they should be considered healthy or not. The return status can also be checked by using req.backend.healthy.

Probes take the following parameters:

.url
    Specify a URL to request from the backend. Defaults to "/".

.request
    Specify a full HTTP request using multiple strings. .request will have \r\n automatically inserted after every string. If specified, .request will take precedence over .url.

.window
    How many of the latest polls we examine to determine backend health. Defaults to .

.threshold
    How many of the polls in .window must have succeeded for us to consider the backend healthy. Defaults to .

.initial
    How many of the probes are considered good when Varnish starts. Defaults to the same amount as the threshold.

.expected_response
    The expected backend HTTP response code. Defaults to .

.interval
    Defines how often the probe should check the backend. Default is every  seconds.

.timeout
    How fast each probe times out. Default is  seconds.

A backend with a probe can be defined like this, together with the backend or director:

backend www {
  .host = "www.magedu.com";
  .port = "http";
  .probe = {
    .url = "/test.jpg";
    .timeout = 0.3 s;
    .window = ;
    .threshold = ;
    .initial = ;
  }
}

Or it can be defined separately and then referenced:

probe healthcheck {
   .url = "/status.cgi";
   .interval = 60s;
   .timeout = 0.3 s;
   .window = ;
   .threshold = ;
   .initial = ;
   .expected_response = ;
}

backend www {
  .host = "www.magedu.com";
  .port = "http";
  .probe = healthcheck;
}

If you have many backends this can simplify the config a lot.

It is also possible to specify the raw HTTP request:

probe rawprobe {
    # NB: \r\n automatically inserted after each string!
    .request =
      "GET / HTTP/1.1"
      "Host: www.magedu.com"
      "Connection: close";
}

生产环境案例：

acl purge {
  "localhost";
  "127.0.0.1";
  "10.1.0.0"/;
  "192.168.0.0"/;
}

sub vcl_hash {
  hash_data(req.url);
  return (hash);
}

sub vcl_recv {
  set req.backend = shopweb;
#  set req.grace = 4h;
  if (req.request == "PURGE") {
    if (!client.ip ~ purge) {
      error  "Not allowed.";
    }
    return(lookup);
  }
  if (req.request == "REPURGE") {
    if (!client.ip ~ purge) {
      error  "Not allowed.";
    }
    ban("req.http.host == " + req.http.host + " && req.url ~ " + req.url);
    error  "Ban OK";
  }
  if (req.restarts == ) {
    if (req.http.x-forwarded-for) {
      set req.http.X-Forwarded-For = req.http.X-Forwarded-For + ", " + client.ip;
    }
    else {
      set req.http.X-Forwarded-For = client.ip;
    }
  }
  if (req.request != "GET" &&
    req.request != "HEAD" &&
    req.request != "PUT" &&
    req.request != "POST" &&
    req.request != "TRACE" &&
    req.request != "OPTIONS" &&
    req.request != "DELETE") {
    /* Non-RFC2616 or CONNECT which is weird. */
    return (pipe);
  }
  if (req.request != "GET" && req.request != "HEAD") {
    /* We only deal with GET and HEAD by default */
    return (pass);
  }
  if (req.http.Authorization) {
    /* Not cacheable by default */
    return (pass);
  }

  if ( req.url == "/Heartbeat.html" ) {
    return (pipe);
  }
  if ( req.url == "/" ) {
    return (pipe);
  }
  if ( req.url == "/index.jsp" ) {
    return (pipe);
  }

  if (req.http.Cookie ~ "dper=") {
    return (pass);
  }
  if (req.http.Cookie ~ "sqltrace=") {
    return (pass);
  }
  if (req.http.Cookie ~ "errortrace=") {
    return (pass);
  }
#   if ( req.request == "GET" && req.url ~ "req.url ~ "^/shop/[-]+$" ) {
  if ( req.url ~ "^/shop/[0-9]+$" || req.url ~ "^/shop/[0-9]?.*" ) {
    return (lookup);
  }

 if ( req.url ~ "^/shop/(\d{1,})/editmember" || req.url ~ "^/shop/(\d{1,})/map" || req.url ~ "^/shop/(\d+)/dish-([^/]+)" ) {
    return (lookup);
  } 

  return (pass);
#   return (lookup);
}

sub vcl_pipe {
  return (pipe);
}

sub vcl_pass {
  return (pass);
}

sub vcl_hit {
  if (req.request == "PURGE") {
    purge;
    error  "Purged.";
  }
  return (deliver);
}

sub vcl_miss {
  if (req.request == "PURGE") {
    error  "Not in cache.";
  }
#   if (object needs ESI processing) {
#     unset bereq.http.accept-encoding;
#   }
  return (fetch);
}

sub vcl_fetch {
  set beresp.ttl = 3600s;
  set beresp.http.expires = beresp.ttl;
  #set beresp.grace = 4h;
#   if (object needs ESI processing) {
#     set beresp.do_esi = true;
#     set beresp.do_gzip = true;
#   }

  if ( req.url ~ "^/shop/[0-9]+$" || req.url ~ "^/shop/[0-9]?.*" ) {
    set beresp.ttl = 4h;
  }

 if ( req.url ~ "^/shop/(\d{1,})/editmember" || req.url ~ "^/shop/(\d{1,})/map" || req.url ~ "^/shop/(\d+)/dish-([^/]+)" ) {
     set beresp.ttl = 24h;
  } 

  if (beresp.status != ){
    return (hit_for_pass);
  }
  return (deliver);
}

sub vcl_deliver {
  if (obj.hits > ){
    set resp.http.X-Cache = "HIT";
  }
  else {
    set resp.http.X-Cache = "MISS";
  }
  set resp.http.X-Powered-By = "Cache on " + server.ip;
  set resp.http.X-Age = resp.http.Age;
  return (deliver);
}

sub vcl_error {
  set obj.http.Content-Type = "text/html; charset=utf-8";
  set obj.http.Retry-After = "";
  synthetic {""} + obj.status + " " + obj.response + {""};
  return (deliver);
}

sub vcl_init {
  return (ok);
}

sub vcl_fini {
  return (ok);
}