Varnish の設定ファイルである VCL はどういうものか(2)

に続き、Varnish で使われている VCL 言語について簡単に説明します。


VCL のサブルーチン

Varnish ではいくつかの VCL のサブルーチンを持っています。これは Varnish がリクエスト受信やキャッシュヒット時のような特定のタイミングで実行される関数で以下のように複数の種類があります。

vcl_init
VCL が読み込まれたタイミングで呼ばれます。

vcl_recv
リクエストの最初で呼ばれます。ここではこのリクエストを処理するかどうかやどう処理するかを定義します。この時の return に pass、pipe、lookup 等を指定することができます。lookup はキャッシュがあれば使うモードで、pass、pipe はこの後説明する vcl_pass、vcl_pipe に切り替わります。

vcl_pipe
pipe モードに切り替わった時に呼ばれます。pipe はクライアントからのコネクションをバックエンドにそのまま接続します。

vcl_pass
pass モードに切り替わった時に呼ばれます。pass はクライアントのリクエストをバックエンドに渡します。pipe と pass の違いは後で説明します。

vcl_hash
キャッシュを取り出すときに呼ばれるキー(hash)を追加する為に使用します。

vcl_hit
キャッシュが見つかった時に呼ばれます。

vcl_miss
キャッシュが見つからなかった時に呼ばれます。

vcl_fetch
バックエンドからコンテンツが取得できた時に呼ばれます。

vcl_deliver
キャッシュがクライアントに配送される前に呼ばれます。

vcl_error
バックエンドでエラーが発生した時に呼ばれます。

これらのサブルーチンの例として でも掲載しましたがデフォルトでサンプルとしてついてくる Varnish の default.vcl を見てみるのがいいかもしれません。

# This is a basic VCL configuration file for varnish.  See the vcl(7)
# man page for details on VCL syntax and semantics.
#
# Default backend definition.  Set this to point to your content
# server.
#
backend default {
    .host = "127.0.0.1";
    .port = "8080";
}
#
# Below is a commented-out copy of the default VCL logic.  If you
# redefine any of these subroutines, the built-in logic will be
# appended to your code.
# sub vcl_recv {
#     if (req.restarts == 0) {
#   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 || req.http.Cookie) {
#         /* Not cacheable by default */
#         return (pass);
#     }
#     return (lookup);
# }
#
# sub vcl_pipe {
#     # Note that only the first request to the backend will have
#     # X-Forwarded-For set.  If you use X-Forwarded-For and want to
#     # have it set for all requests, make sure to have:
#     # set bereq.http.connection = "close";
#     # here.  It is not set by default as it might break some broken web
#     # applications, like IIS with NTLM authentication.
#     return (pipe);
# }
#
# sub vcl_pass {
#     return (pass);
# }
#
# sub vcl_hash {
#     hash_data(req.url);
#     if (req.http.host) {
#         hash_data(req.http.host);
#     } else {
#         hash_data(server.ip);
#     }
#     return (hash);
# }
#
# sub vcl_hit {
#     return (deliver);
# }
#
# sub vcl_miss {
#     return (fetch);
# }
#
# sub vcl_fetch {
#     if (beresp.ttl <= 0s ||
#         beresp.http.Set-Cookie ||
#         beresp.http.Vary == "*") {
#       /*
#        * Mark as "Hit-For-Pass" for the next 2 minutes
#        */
#       set beresp.ttl = 120 s;
#       return (hit_for_pass);
#     }
#     return (deliver);
# }
#
# sub vcl_deliver {
#     return (deliver);
# }
#
# sub vcl_error {
#     set obj.http.Content-Type = "text/html; charset=utf-8";
#     set obj.http.Retry-After = "5";
#     synthetic {"
# <?xml version="1.0" encoding="utf-8"?>
# <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
#  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
# <html>
#   <head>
#     <title>"} + obj.status + " " + obj.response + {"</title>
#   </head>
#   <body>
#     <h1>Error "} + obj.status + " " + obj.response + {"</h1>
#     <p>"} + obj.response + {"</p>
#     <h3>Guru Meditation:</h3>
#     <p>XID: "} + req.xid + {"</p>
#     <hr>
#     <p>Varnish cache server</p>
#   </body>
# </html>
# "};
#     return (deliver);
# }
#
# sub vcl_init {
#   return (ok);
# }
#
# sub vcl_fini {
#   return (ok);
# }

最後に pipe と pass の違いを説明します。これらの説明は全て Varnish のドキュメントから得た情報である為、実際に計測したわけではありませんが、まず pass は通常の Proxy として思い描く動作をします。

pass はクライアントからのリクエストを受け取り、バックエンドに流します。Varnish では例えば同じ URL に 1000のリクエストが到達した時、バックエンドには 1つだけ流して他の 999のリクエストは待機状態とし、バックエンドから取得できた情報を残りの 999のリクエストにも流します。pass はこのような動作をします。

一方で pipe はリクエストをそのままバックエンドにつなげてしまう為、到達したリクエストを全てそのままバックエンドに送ってしまいます。この為、通常は pass を使うのがいいでしょう。

【お勧め】リバースプロキシ関連の記事

No Comments - Leave a comment

Leave a Reply

Your email address will not be published. Required fields are marked *

*