Varnish 入门

发表于 2019-03-13 阅读次数： Disqus：

Varnish是一款高性能、开源的反向代理服务器，支持负载均衡，经常被用作缓存服务，能够极大的提高网站的响应速度。

Varnish 进程分为master进程和worker进程，master进程负责读取配置文件、创建和管理子进程等，worker进程则负责处理请求。一旦子进程挂了，master进程会立即重新启动子进程。

安装

mac 上安装可以使用Homebrew

1	$ brew install varnish

启动命令（后台运行）

1	$ brew services start varnish

默认端口是8080，可以在plist中修改端口

~/Library/LaunchAgents/homebrew.mxcl.varnish.plist

n：运行目录路径
f: 配置文件路径
a: 启动端口
s：缓存方式

varnish的默认配置文件位置位于/usr/local/etc/varnish/default.vcl

通过homebrew安装的varnish，在调试配置文件时使用varnishlog会提示VSM: Could not get hold of varnishd, is it running?

Varnish 配置语言 VCL

运算符 Operator

= 赋值
== 比较
~ 匹配，可以使用正则表达式，或者ACLs
! 否定
&& 逻辑与
|| 逻辑或

条件语句

if、else、elseif（elsif | elif | else if 四个都一样）
没有循环语句

数据类型

五种数据类型：String， boolean，time，duration，integer
使用set 和 unset 设置或者移除

1 2	set req.http.User-Agent = "unknown"; unset req.http.Range;

字符串

基本的字符串形式使用双引号 “…”，不允许跨行
反斜杆不是特殊符号，所以不需要对反斜杠进行转义
比较长的字符串可以使用{“…”}，可以包含双引号、换行符等，不包含NUL（0x00）

Time

now 函数返回当前时间
在字符串上下文，返回格式化的字符串

Duration

number + 时间单位，比如： 1.5w

ms: milliseconds
s: seconds
m: minutes
h: hours
d: days
w: weeks
y: years

正则表达式

Varnish 使用 Perl-compatible regular expressions（pcre）

1
2
3

if (req.http.host !~ "(?i)example\.com$") {
    ...
}

include 引入VCL文件

1	include "foo.vcl";

import 加载 Varnish模块（VMODS）

import std;
sub vcl_recv {
    std.log("foo");
}

注释

单行注释： #、 ||
多行注释： /* block */

定义 backend

varnish中的backend 和 nginx里 upstream 中 server概念很像，一个backend对象指定服务的host和端口，包括类似于健康检查的机制

定义一个 backend 如下：

1
2
3

backend name {
    .attribute = "value";
}

常用属性有 host（必填）、port、probe（类似于健康检查机制，后面会写到）

定义 Probes

probe 用于请求 backend 状态，backend返回的状态不符合预期，则会标记该backend下线

定义一个name为 healthcheck的 probe

probe healthcheck {
    .url = "/health/check";
    .timeout = 2s;
    .interval = 5s;
    .expected_response = 200; # 服务正常返回的http状态码
}

结合 backend使用，定义一个

backend default {
    .host: "127.0.0.1";
    .port: 8080;
    .probe: healthcheck;
}

director 多个后端集合，负载均衡

director fed round-robin {
    {
        .backend = fed1;
    }
    {
        .backend = fed2;
    }
}

acl 权限控制列表（Access control lists）

acl local {
    "localhost";
    "127.0.0.1";
}

匹配ip地址的时候，使用匹配运算符

1
2
3

if (client.ip ~ local) {
    return (pipe);
}

子程序 Subroutines

sub pip_if_local {
    if (client.ip ~ local) {
        return (pipe);
    }
}

子程序中不能引入参数，也没有返回值
varnish 内置子程序命名为vcl.*，自定义子程序不能以vcl开头
调用子程序，使用关键字 call 后面跟上子程序名字
1
call pip_if_local;

几个常用的内置子程序

vcl_recv

用于接收和处理请求。

举个栗子：

sub vcl_recv {
    if (req.url ~ "/public/") {
        return (hash);
    }
    return (pass);
}

上面代码将请求中匹配/public/的请求，进入hash阶段，请求转到vcl_hash，其余请求进入pass模式，处理转到vcl_pass

return 支持5个参数：

hash：进入vcl_hash
pass: 进入vcl_pass
pipe: 进入vcl_pip
synth(status code, reason)：进入vcl_synth
purge：清除缓存

vcl_backend_fetch

在向后端发请求前执行，这个阶段可以修改请求。

sub vcl_backedn_fetch {
    unset bereq.http.Cookie;
    return (fetch);
}

return 支持两个参数

fetch：发送请求到后端
abandon：放弃请求后端。

vcl_backend_response

当从后端获取到请求响应头后执行，可以在这个阶段处理删除或添加响应头的事情。

sub vcl_backend_response {
    set beresp.ttl = 5m;
    unset beresp.http.Set-Cookie;
    return (deliver);
}

上面例子设置资源的缓存时间、删除请求响应头里的Set-Cookie。
return 支持三个参数

deliver：返回数据给用户端
abandon：放弃后端请求，resp.status 为 503，进入vcl_synth
retry：重试后端事务，达到最大次数限制后进入vcl_backend_error

vcl_deliver

当从后端获取到所有信息后，在返回用户前执行。

sub vcl_deliver {
    if (obj.hits > 0) {
        set resp.http.X-Varnish-Cache = "HIT";
    } else {
        set resp.http.X-Varnish-Cache = "MISS";
    }
    return (deliver);
}

上面代码中判断是否是命中缓存，并在响应头中显示。
return支持三个参数：

deliver 返回数据给用户端
restart 重新启动事务。增加了重新启动计数器。如果重启的次数超过了max_restarts的设置，就会抛出一个错误
synth(status code, reason) 带着synth的参数resp.status和resp.reason转到vcl_synth处理。

vcl_init

在VCL加载完成，请求进入之前执行，一般用来初始化VMODs

import directors;    # load the directors

backend server1 {
    .host = "127.0.0.1";
}
backend server2 {
    .host = "xxxxxxxxx";
}

sub vcl_init {
    new bar = directors.round_robin();
    bar.add_backend(server1);
    bar.add_backend(server2);
    return (ok);
}

sub vcl_recv {
    
    set req.backend_hint = bar.backend();
}