Varnish HTTP 缓存

Varnish 集成可收集缓存和会话指标。它会监控进入和退出缓存的对象数,以及会话数和后端连接数。该集成还会收集 Varnish 日志,并将其解析为标准化 JSON 载荷。

如需详细了解 Varnish,请参阅 Varnish HTTP 缓存文档

前提条件

如需收集 Varnish 遥测数据,您必须安装 Ops Agent

  • 对于指标,请安装 2.15.0 版或更高版本。
  • 对于日志,请安装 2.16.0 版或更高版本。

此集成支持 Varnish 6.x 和 7.0.x 版。

配置 Varnish 实例

Varnish 日志记录处理器使用 varnishncsa 处理日志。Varnish 可以按照本指南启用 varnishncsa 日志记录,具体取决于操作系统。

默认情况下,日志将写入 /var/log/varnish/varnishncsa.log。如果您选择其他目标位置,则必须更新接收器配置。日志应采用默认格式,并且应设置日志轮替。

为 Varnish 配置 Ops Agent

按照配置 Ops Agent 指南,添加从 Varnish 实例收集遥测数据所需的元素并重启代理

配置示例

以下命令会创建相关配置来收集和注入 Varnish 的遥测数据,并在 Linux 上重启 Ops Agent。

# 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 中通配符文件路径的刷新间隔。指定为时长,例如 30 秒或 2 分钟。该属性在高日志记录吞吐量下可能很有用,因为日志文件的轮替速度快于默认时间间隔。

记录的内容

logName 派生自配置中指定的接收器 ID。LogEntry 中的详细字段如下所示。

varnish 日志包含 LogEntry 中的以下字段:

字段 类型 说明
httpRequest 对象 参见HttpRequest
jsonPayload.host 字符串 Host 标头的内容
jsonPayload.user 字符串 请求经过身份验证的用户名
severity 字符串 (LogSeverity) 日志条目级别(已转换)。

配置指标收集

如需从 Varnish 注入指标,您必须为 Varnish 生成的指标创建接收器,然后为新的接收器创建流水线。

此接收器不支持在配置中使用多个实例,例如,监控多个端点。所有这些实例都会写入相同的时序,并且 Cloud Monitoring 无法区分它们。

如需为 varnish 指标配置接收器,请指定以下字段:

字段 默认 说明
cache_dir 这用于指定在收集指标时使用的缓存目录实例名称。如果未指定,则默认为主机。
collection_interval 60 秒 time.Duration 值,例如 30s5m
exec_dir varnishadmvarnishstat 可执行文件所在的目录。如果未提供,则使用用户的 PATH 设置。
type 该值必须为 varnish

监控的内容

下表提供了 Ops Agent 从 Varnish 实例收集的指标列表。

指标类型
种类、类型
受监控的资源
标签
workload.googleapis.com/varnish.backend.connection.count
CUMULATIVEINT64
gce_instance
kind
workload.googleapis.com/varnish.backend.request.count
CUMULATIVEINT64
gce_instance
 
workload.googleapis.com/varnish.cache.operation.count
CUMULATIVEINT64
gce_instance
operation
workload.googleapis.com/varnish.client.request.count
CUMULATIVEINT64
gce_instance
state
workload.googleapis.com/varnish.client.request.error.count
CUMULATIVEINT64
gce_instance
status_code
workload.googleapis.com/varnish.object.count
GAUGEINT64
gce_instance
 
workload.googleapis.com/varnish.object.expired
CUMULATIVEINT64
gce_instance
 
workload.googleapis.com/varnish.object.moved
CUMULATIVEINT64
gce_instance
 
workload.googleapis.com/varnish.object.nuked
CUMULATIVEINT64
gce_instance
 
workload.googleapis.com/varnish.session.count
CUMULATIVEINT64
gce_instance
kind
workload.googleapis.com/varnish.thread.operation.count
CUMULATIVEINT64
gce_instance
operation

验证配置

本部分介绍了如何验证您是否正确配置了 Varnish 接收器。Ops Agent 可能需要一两分钟才会开始收集遥测数据。

如需验证 Varnish 日志是否已发送到 Cloud Logging,请执行以下操作:

  1. 在 Google Cloud 控制台中,转到 Logs Explorer 页面。

    前往 Logs Explorer

    如果您使用搜索栏查找此页面,请选择子标题为 Logging 的结果。

  2. 在编辑器中输入以下查询,然后点击运行查询
    resource.type="gce_instance"
    log_id("varnish")
    

如需验证 Varnish 指标是否已发送到 Cloud Monitoring,请执行以下操作:

  1. 在 Google Cloud 控制台中,转到 Metrics Explorer 页面:

    进入 Metrics Explorer

    如果您使用搜索栏查找此页面,请选择子标题为监控的结果。

  2. 在查询构建器窗格的工具栏中,选择名为  MQL PromQL 的按钮。
  3. 验证已在语言切换开关中选择 MQL。语言切换开关位于同一工具栏中,用于设置查询的格式。
  4. 在编辑器中输入以下查询,然后点击运行查询
    fetch gce_instance
    | metric 'workload.googleapis.com/varnish.backend.connection.count'
    | every 1m
    

查看信息中心

如需查看 Varnish 指标,您必须配置一个图表或信息中心。 Varnish 集成服务可为您提供一个或多个信息中心。在您配置集成并且 Ops Agent 开始收集指标数据后,所有信息中心都会自动安装。

您还可以在不安装集成的情况下查看信息中心的静态预览。

如需查看已安装的信息中心,请执行以下操作:

  1. 在 Google Cloud 控制台中,转到 信息中心页面:

    前往信息中心

    如果您使用搜索栏查找此页面,请选择子标题为监控的结果。

  2. 选择信息中心列表标签页,然后选择集成类别。
  3. 点击您要查看的信息中心的名称。

如果您已配置集成,但尚未安装信息中心,请检查 Ops Agent 是否正在运行。如果信息中心内没有图表的指标数据,则信息中心的安装将失败。Ops Agent 开始收集指标后,系统会为您安装信息中心。

如需查看信息中心的静态预览,请执行以下操作:

  1. 在 Google Cloud 控制台中,转到 集成页面:

    前往集成

    如果您使用搜索栏查找此页面,请选择子标题为监控的结果。

  2. 点击 Compute Engine 部署平台过滤条件。
  3. 找到 Varnish 条目,然后点击 View Details
  4. 选择信息中心标签页以查看静态预览。如果信息中心已安装,您可以通过点击查看信息中心来转到信息中心。

如需详细了解 Cloud Monitoring 中的信息中心,请参阅信息中心和图表

如需详细了解如何使用集成页面,请参阅管理集成

安装提醒政策

提醒政策会指示 Cloud Monitoring 在满足指定条件时通知您。 Varnish 集成包含一项或多项提醒政策供您使用。您可以从 Monitoring 中的集成页面查看和安装这些提醒政策。

如需查看可用提醒政策的说明并安装它们,请执行以下操作:

  1. 在 Google Cloud 控制台中,转到 集成页面:

    前往集成

    如果您使用搜索栏查找此页面,请选择子标题为监控的结果。

  2. 找到 Varnish 的条目,然后点击 View Details
  3. 选择提醒标签页。此标签页提供可用提醒政策的说明,并提供一个安装政策的界面。
  4. 安装提醒政策。提醒政策需要知道将提醒触发的通知发送到何处,因此它们需要您提供信息才能进行安装。如需安装提醒政策,请执行以下操作:
    1. 从可用提醒政策列表中,选择您要安装的提醒政策。
    2. 配置通知部分中,选择一个或多个通知渠道。您可以选择禁止使用通知渠道,但如果您这样做,则您的提醒政策将以静默方式触发。您可以在 Monitoring 中查看其状态,但不会收到通知。

      如需详细了解通知渠道,请参阅管理通知渠道

    3. 点击创建政策

如需详细了解 Cloud Monitoring 中的提醒政策,请参阅提醒简介

如需详细了解如何使用集成页面,请参阅管理集成

后续步骤

如需查看如何使用 Ansible 安装 Ops Agent、配置第三方应用和安装示例信息中心的演示,请参阅安装 Ops Agent 以排查第三方应用的问题视频。