Varnishを使う際に覚えておきたいデフォルトの罠

5月 302012

最近とある人が嵌っていて聞かれたので
Varnishを使う上で覚えておきたいデフォルト設定の罠を説明したいと思います。

デフォルトのLISTENポートは6081、VCLでなく起動パラメータで設定する

そのかたはbackendの設定をLISTENポートと勘違いしていました。
Varnishの設定は主に2つにわかれています

起動パラメータ

VCL設定(default.vcl)

起動パラメータはキャッシュを保存するストレージのサイズを指定したり、保持するスレッド数や、ワークスペースのサイズ、LISTENポートを指定したりなどと
主に変更する場合はVarnish自体の再起動が必要などと即時に反映できないものが多いです。
（デフォルトのTTLなどもあり、必ずしも全てではない）

そしてVCL設定はリクエストに対してVarnishがどのように振る舞うかを定義しています。

redhat系の場合起動パラメータは
/etc/sysconfig/varnish
に記述されており、LISTENポートは以下のように定義されています

1# # Default address and port to bind to
2# # Blank address means all IPv4 and IPv6 interfaces, otherwise specify
3# # a host name, an IPv4 dotted quad, or an IPv6 address in brackets.
4# VARNISH_LISTEN_ADDRESS=
5VARNISH_LISTEN_PORT=6081

if-modified-sinceに対して常に304を返そうとするが動作が不安定

保存されている画像などが変更されずに、URLに対してユニークであることが保証できる場合
if-modified-sinceを受け取った段階で、即304を返す場合があります。

たとえば以下のようなコードです

1...バックエンドの設定...
2sub vcl_recv{
3  if(req.http.If-Modified-Since) {
4    error 304 "Not Modified";
5  }
6}

特に問題もなく動くブラウザと動かないブラウザが出てくると思います。
Varnishの304時のレスポンスをよく観察してみると、ボディがくっついているのが確認できると思います。

ステータス304はレスポンスボディを含んではならないため
ブラウザによっては予期せぬ動作になったりします。

これはVarnishのデフォルト設定が原因です。
まずVarnishがユーザーの記述したVCLコードと、デフォルトのVCLコードをどのように扱っているかを説明します。

Varnishはユーザの入力したVCLコードの後に、デフォルトのVCLコードを挿入します。

そのため、たとえば以下のようにvcl_recvを指定した場合でも

1sub vcl_recv{
2  if(req.http.If-Modified-Since) {
3    error 304 "Not Modified";
4  }
5}

実際にVarnishは以下のように解釈します

01sub vcl_recv{
02  //ユーザの設定したvcl_recv
03  {
04    if(req.http.If-Modified-Since) {
05      error 304 "Not Modified";
06    }
07  }
08  //Varnishのデフォルトのvcl_recv
09  {
10    if (req.restarts == 0) {
11        if (req.http.x-forwarded-for) {
12            set req.http.X-Forwarded-For =
13                req.http.X-Forwarded-For + ", " + client.ip;
14        } else {
15            set req.http.X-Forwarded-For = client.ip;
16        }
17    }
18    if (req.request != "GET" &&
19      req.request != "HEAD" &&
20      req.request != "PUT" &&
21      req.request != "POST" &&
22      req.request != "TRACE" &&
23      req.request != "OPTIONS" &&
24      req.request != "DELETE") {
25        /* Non-RFC2616 or CONNECT which is weird. */
26        return (pipe);
27    }
28    if (req.request != "GET" && req.request != "HEAD") {
29        /* We only deal with GET and HEAD by default */
30        return (pass);
31    }
32    if (req.http.Authorization || req.http.Cookie) {
33        /* Not cacheable by default */
34        return (pass);
35    }
36    return (lookup);
37  }
38}

つまり、ユーザが何も指定しないアクションは全てデフォルトの動作となります。

vcl_errorのデフォルト設定は以下のとおりです

01sub vcl_error {
02    set obj.http.Content-Type = "text/html; charset=utf-8";
03    set obj.http.Retry-After = "5";
04    synthetic {"
05<?xml version="1.0" encoding="utf-8"?>
06<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
07 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
08<html>
09  <head>
10    <title>"} + obj.status + " " + obj.response + {"</title>
11  </head>
12  <body>
13    <h1>Error "} + obj.status + " " + obj.response + {"</h1>
14    <p>"} + obj.response + {"</p>
15    <h3>Guru Meditation:</h3>
16    <p>XID: "} + req.xid + {"</p>
17    <hr>
18    <p>Varnish cache server</p>
19  </body>
20</html>
21"};
22    return (deliver);
23}

つまり、以下のようにデフォルトの設定が動いてしまいレスポンスボディが生成されたため
ブラウザによって不具合が起きてしまいます。

これを防ぐためには、vcl_errorで以下のような記述をする必要があります。

1sub vcl_error {
2    if(obj.status == 304){
3        return (deliver);
4    }
5}

この設定によりerrorで304を発行する場合、
デフォルトの設定を行わずそのまま次の処理に移動します。

また204 No Contentや1XXについてもレスポンスボディを含んではいけないので

1sub vcl_error {
2    if((obj.status >= 100 && obj.status < 200) || obj.status == 204 || obj.status == 304){
3        return (deliver);
4    }
5}

とするのも良いでしょう。

キャッシュできるはずなのにキャッシュできない

全て静的コンテンツで、バックエンドは200を返しているのにキャッシュされない場合があります。
これは先程のデフォルトの設定と絡んでいます。

vcl_recvのデフォルト設定を見てみましょう。

01sub vcl_recv {
02    if (req.restarts == 0) {
03        if (req.http.x-forwarded-for) {
04            set req.http.X-Forwarded-For =
05                req.http.X-Forwarded-For + ", " + client.ip;
06        } else {
07            set req.http.X-Forwarded-For = client.ip;
08        }
09    }
10    if (req.request != "GET" &&
11      req.request != "HEAD" &&
12      req.request != "PUT" &&
13      req.request != "POST" &&
14      req.request != "TRACE" &&
15      req.request != "OPTIONS" &&
16      req.request != "DELETE") {
17        /* Non-RFC2616 or CONNECT which is weird. */
18        return (pipe);
19    }
20    if (req.request != "GET" && req.request != "HEAD") {
21        /* We only deal with GET and HEAD by default */
22        return (pass);
23    }
24    if (req.http.Authorization || req.http.Cookie) {
25        /* Not cacheable by default */
26        return (pass);
27    }
28    return (lookup);
29}

見ての通り、認証時やクッキーが付いている場合はデフォルトではpass動作となりキャッシュされません。
VCLの記述をする際は、必ず自分の書いたコードの後にデフォルトのコードが付与されることを意識して書く必要があります。
全て自分の記述したコードで完結し、デフォルトの設定を動かしたくない場合は
必ずreturn(XXXX)で終わるようにしましょう。

以上
意外と嵌りやすいんじゃないかなーという点を解説しました。
（僕も触り始めの頃デフォルト設定が動いて嵌りました）
何かの参考になればと思います。

This site uses Akismet to reduce spam. Learn how your comment data is processed.

cat /dev/random > /dev/null &

Varnishを使う際に覚えておきたいデフォルトの罠

デフォルトのLISTENポートは6081、VCLでなく起動パラメータで設定する

if-modified-sinceに対して常に304を返そうとするが動作が不安定

キャッシュできるはずなのにキャッシュできない

Leave a Reply