Varnish HTTP キャッシュ

Varnish の統合では、キャッシュとセッションの指標が収集されます。キャッシュを出入りするオブジェクトの数だけでなく、セッションとバックエンド接続の数もモニタリングされます。この統合では、Varnish のログも収集され、標準化された JSON ペイロードが生成されます。

Varnish の詳細については、Varnish HTTP キャッシュのドキュメントをご覧ください。

前提条件

Varnish テレメトリーを収集するには、Ops エージェントをインストールする必要があります。

指標の場合は、バージョン 2.15.0 以降をインストールします。
ログの場合は、バージョン 2.16.0 以降をインストールします。

この統合では、Varnish バージョン 6.x と 7.0.x がサポートされます。

Varnish インスタンスを構成する

Varnish ロギングプロセッサは、varnishncsa を使用してログを処理します。Varnish では、オペレーティングシステムに応じて varnishncsa ロギングを有効にできます。手順については、こちらのガイドをご覧ください。

デフォルトでは、ログは /var/log/varnish/varnishncsa.log に書き込まれます。別の宛先を選択する場合は、レシーバの構成を更新する必要があります。ログはデフォルトの形式が想定されています。また、ログローテーションを設定する必要があります。

Varnish 用に Ops エージェントを構成する

Ops エージェントの構成のガイドに沿って、Varnish インスタンスからテレメトリーを収集するために必要な要素を追加し、エージェントを再起動します。

構成の例

次のコマンドは、Varnish のテレメトリーを収集して取り込み、Linux で Ops エージェントを再起動するための構成を作成します。

# Configures Ops Agent to collect telemetry from the app and restart Ops Agent.

set -e

# Create a back up of the existing file so existing configurations are not lost.
sudo cp /etc/google-cloud-ops-agent/config.yaml /etc/google-cloud-ops-agent/config.yaml.bak

# Configure the Ops Agent.
sudo tee /etc/google-cloud-ops-agent/config.yaml > /dev/null << EOF
metrics:
  receivers:
    varnish:
      type: varnish
  service:
    pipelines:
      varnish:
        receivers:
          - varnish
logging:
  receivers:
    varnish:
      type: varnish
  service:
    pipelines:
      varnish:
        receivers:
          - varnish

EOF

sudo service google-cloud-ops-agent restart
sleep 30

ログの収集を構成する

Varnish からログを取り込むには、Varnish が生成するログのレシーバを作成してから、新しいレシーバ用のパイプラインを作成する必要があります。

varnish ログのレシーバを構成するには、次のフィールドを指定します。

フィールド	デフォルト	説明
`exclude_paths`		include_paths の照合で除外するファイルシステムパスのパターンのリスト。
`include_paths`	`[/var/log/varnish/varnishncsa.log]`	各ファイルのテーリングで読み込む varnishncsa のデフォルトログのパス。
`record_log_file_path`	`false`	`true` に設定すると、ログレコードの取得元のファイルのパスが `agent.googleapis.com/log_file_path` ラベルの値として出力ログエントリに表示されます。ワイルドカードを使用する場合、レコードを取得したファイルのパスのみが記録されます。
`type`		値は、`varnish` にする必要があります。
`wildcard_refresh_interval`	`60s`	include_paths のワイルドカードファイルパスの更新間隔。時間を指定します（例: 30s、2m）。このプロパティは、ログファイルのローテーションがデフォルトの間隔よりも速く、ロギングのスループットが高い場合に有用です。

ログの内容

logName は、構成で指定されたレシーバ ID から取得されます。LogEntry 内の詳細なフィールドは、次のとおりです。

varnish ログの LogEntry には次のフィールドが含まれます。

フィールド	タイプ	説明
`httpRequest`	オブジェクト	`HttpRequest` を参照
`jsonPayload.host`	文字列	Host ヘッダーの内容
`jsonPayload.user`	文字列	リクエストの認証済みユーザー名
`severity`	文字列（`LogSeverity`）	ログエントリレベル（変換済み）。

指標の収集を構成する

Varnish から指標を取り込むには、Varnish が生成する指標のレシーバーを作成してから、新しいレシーバー用のパイプラインを作成する必要があります。

このレシーバーでは、複数のエンドポイントのモニタリングなど、構成で複数のインスタンスを使用することはできません。このようなインスタンスはすべて同じ時系列に書き込まれるため、Cloud Monitoring ではインスタンスを区別できません。

varnish 指標のレシーバーを構成するには、次のフィールドを指定します。

フィールド	デフォルト	説明
`cache_dir`		指標を収集するときに使用するキャッシュディレクトリのインスタンス名を指定します。指定しない場合、デフォルトでホストが使用されます。
`collection_interval`	60s	`time.Duration` 値（`30s`、`5m` など）。
`exec_dir`		`varnishadm` 実行可能ファイルと `varnishstat` 実行可能ファイルが配置されているディレクトリ。指定しない場合は、ユーザーの `PATH` 設定が使用されます。
`type`		値は、`varnish` にする必要があります。

モニタリング対象

次の表に、Ops エージェントが Varnish インスタンスから収集する指標の一覧を示します。

指標タイプ
種類、タイプモニタリング対象リソース	ラベル
`workload.googleapis.com/varnish.backend.connection.count`
`CUMULATIVE`、`INT64` gce_instance	`kind`
`workload.googleapis.com/varnish.backend.request.count`
`CUMULATIVE`、`INT64` gce_instance
`workload.googleapis.com/varnish.cache.operation.count`
`CUMULATIVE`、`INT64` gce_instance	`operation`
`workload.googleapis.com/varnish.client.request.count`
`CUMULATIVE`、`INT64` gce_instance	`state`
`workload.googleapis.com/varnish.client.request.error.count`
`CUMULATIVE`、`INT64` gce_instance	`status_code`
`workload.googleapis.com/varnish.object.count`
`GAUGE`、`INT64` gce_instance
`workload.googleapis.com/varnish.object.expired`
`CUMULATIVE`、`INT64` gce_instance
`workload.googleapis.com/varnish.object.moved`
`CUMULATIVE`、`INT64` gce_instance
`workload.googleapis.com/varnish.object.nuked`
`CUMULATIVE`、`INT64` gce_instance
`workload.googleapis.com/varnish.session.count`
`CUMULATIVE`、`INT64` gce_instance	`kind`
`workload.googleapis.com/varnish.thread.operation.count`
`CUMULATIVE`、`INT64` gce_instance	`operation`

構成を確認する

このセクションでは、Varnish レシーバが正しく構成されていることを確認する方法について説明します。Ops エージェントがテレメトリーの収集を開始するまでに 1～2 分かかる場合があります。

Varnish ログが Cloud Logging に送信されていることを確認するには、次のようにします。

Google Cloud コンソールで、[ログエクスプローラ] ページに移動します。
[ログエクスプローラ] に移動

検索バーを使用してこのページを検索する場合は、小見出しが [Logging] である結果を選択します。
エディタに次のクエリを入力し、[クエリを実行] をクリックします。
```
resource.type="gce_instance"
log_id("varnish")
```

Varnish 指標が Cloud Monitoring に送信されていることを確認するには、次のようにします。

Google Cloud コンソールで、 [Metrics Explorer] ページに移動します。
Metrics Explorer に移動

検索バーを使用してこのページを検索する場合は、小見出しが [Monitoring] である結果を選択します。
クエリビルダーペインのツールバーで、[MQL] または [PROMQL] という名前のボタンを選択します。
[言語] 切り替えで [MQL] が選択されていることを確認します。言語切り替えボタンは、クエリの書式設定を行うのと同じツールバーにあります。

エディタに次のクエリを入力し、[クエリを実行] をクリックします。

fetch gce_instance
| metric 'workload.googleapis.com/varnish.backend.connection.count'
| every 1m

ダッシュボードを表示する

Varnish 指標を表示するには、グラフまたはダッシュボードが構成されている必要があります。Varnish インテグレーションには、1 つ以上のダッシュボードが含まれています。インテグレーションを構成して Ops エージェントが指標データの収集を開始すると、ダッシュボードは自動的にインストールされます。

インテグレーションをインストールすることなく、ダッシュボードの静的プレビューを表示することもできます。

インストールされているダッシュボードを表示する手順は次のとおりです。

Google Cloud コンソールで [ダッシュボード] ページに移動します。
[ダッシュボード] に移動

検索バーを使用してこのページを検索する場合は、小見出しが [Monitoring] である結果を選択します。
[ダッシュボードリスト] タブを選択し、[統合] カテゴリを選択します。
表示するダッシュボードの名前をクリックします。

インテグレーションを構成してもダッシュボードがインストールされていない場合は、Ops エージェントが実行されていることを確認します。ダッシュボードにグラフの指標データがない場合、ダッシュボードのインストールは失敗します。Ops エージェントが指標の収集を開始した後に、ダッシュボードがインストールされます。

ダッシュボードの静的プレビューを表示する手順は次のとおりです。

Google Cloud コンソールで、 [インテグレーション] ページに移動します。
[インテグレーション] に移動

検索バーを使用してこのページを検索する場合は、小見出しが [Monitoring] である結果を選択します。
[デプロイメントプラットフォーム] フィルタの [Compute Engine] をクリックします。
Varnish のエントリを見つけて、[詳細を表示] をクリックします。
[ダッシュボード] タブを選択すると、静的プレビューが表示されます。ダッシュボードがインストールされている場合は、[ダッシュボードを表示] をクリックして移動できます。

Cloud Monitoring のダッシュボードについて詳しくは、ダッシュボードとグラフをご覧ください。

[インテグレーション] ページの使用方法については、インテグレーションを管理するをご覧ください。

アラートポリシーをインストールする

アラートポリシーは、指定した条件が成立した際に通知するように Cloud Monitoring に指示します。Varnish インテグレーションには、1 つ以上のアラートポリシーが含まれています。これらのアラートポリシーは、Monitoring の [インテグレーション] ページで表示してインストールできます。

使用可能なアラートポリシーの説明を表示してインストールする手順は次のとおりです。

Google Cloud コンソールで、 [インテグレーション] ページに移動します。
[インテグレーション] に移動

検索バーを使用してこのページを検索する場合は、小見出しが [Monitoring] である結果を選択します。
Varnish のエントリを見つけて、[詳細を表示] をクリックします。
[アラート] タブを選択します。このタブには、利用可能なアラートポリシーの説明と、それらをインストールするためのインターフェースが表示されます。
アラートポリシーをインストールします。アラートポリシーでは、アラートがトリガーされた通知の送信先を特定する必要があるため、インストール環境の情報が必要になります。アラートポリシーをインストールする手順は次のとおりです。
1. 利用可能なアラートポリシーのリストから、インストールするアラートポリシーを選択します。
2. [通知の構成] セクションで、1 つ以上の通知チャンネルを選択します。通知チャンネルの使用を無効にすることもできますが、無効にすると、アラートポリシーは通知なく起動します。Monitoring でステータスを確認できますが、通知は受信しません。
  
  通知チャンネルの詳細については、通知チャンネルを管理するをご覧ください。
3. [ポリシーの作成] をクリックします。

Cloud Monitoring のアラートポリシーの詳細については、アラートの概要をご覧ください。