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

按照「設定作業套件代理程式」指南操作,新增必要元素,從 Varnish 執行個體收集遙測資料,然後重新啟動代理程式

範例設定

下列指令會建立設定,收集及擷取 Varnish 的遙測資料:

# Configures Ops Agent to collect telemetry from the app. You must restart the agent for the configuration to take effect.

set -e

# Check if the file exists
if [ ! -f /etc/google-cloud-ops-agent/config.yaml ]; then
  # Create the file if it doesn't exist.
  sudo mkdir -p /etc/google-cloud-ops-agent
  sudo touch /etc/google-cloud-ops-agent/config.yaml
fi

# 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

如要讓這些變更生效,請重新啟動 Ops Agent:

Linux

  1. 如要重新啟動代理程式,請在執行個體上執行下列指令:
    sudo systemctl restart google-cloud-ops-agent
    
  2. 如要確定代理程式已重新啟動,請執行下列指令,並驗證「指標代理程式」和「Logging 代理程式」元件是否已啟動:
    sudo systemctl status "google-cloud-ops-agent*"
    

Windows

  1. 使用遠端桌面協定或類似工具連線至執行個體,並登入 Windows。
  2. 以滑鼠右鍵按一下 PowerShell 圖示,然後選取「以系統管理員身分執行」,以管理員權限開啟 PowerShell 終端機。
  3. 如要重新啟動代理程式,請執行下列 PowerShell 指令:
    Restart-Service google-cloud-ops-agent -Force
    
  4. 如要確定代理程式已重新啟動,請執行下列指令,並驗證「指標代理程式」和「Logging 代理程式」元件是否已啟動:
    Get-Service google-cloud-ops-agent*
    

設定記錄檔收集作業

如要從 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 中萬用字元檔案路徑的重新整理間隔。以時間長度表示,例如 30s2m。在記錄吞吐量較高的情況下,記錄檔的輪替速度會比預設間隔更快,這時這項屬性就可能派上用場。

記錄內容

logName 是從設定中指定的接收器 ID 衍生而來。LogEntry 內的詳細欄位如下。

varnish 記錄包含 LogEntry 中的下列欄位:

欄位 類型 說明
httpRequest 物件 查看HttpRequest
jsonPayload.host 字串 Host 標頭的內容
jsonPayload.user 字串 要求中經過驗證的使用者名稱
severity 字串 (LogSeverity) 記錄項目層級 (已翻譯)。

設定指標收集

如要從 Varnish 擷取指標,您必須為 Varnish 產生的指標建立接收器,然後為新接收器建立管道。

這個接收器不支援在設定中使用多個執行個體,例如監控多個端點。所有這類執行個體都會寫入相同的時間序列,而 Cloud Monitoring 無法區分這些執行個體。

如要為 varnish 指標設定接收器,請指定下列欄位:

欄位 預設 說明
cache_dir 這會指定收集指標時要使用的快取目錄執行個體名稱。如未指定,則預設為主機。
collection_interval 60s 時間長度值,例如 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

    如果您是使用搜尋列尋找這個頁面,請選取子標題為「Monitoring」的結果

  2. 在查詢建立工具窗格的工具列中,選取名稱為 「PromQL」PromQL的按鈕。
  3. 在編輯器中輸入下列查詢,然後按一下「執行查詢」
    {"workload.googleapis.com/varnish.backend.connection.count", monitored_resource="gce_instance"}
    

查看資訊主頁

如要查看 Varnish 指標,您必須設定圖表或資訊主頁。Varnish 整合包含一或多個資訊主頁。 設定整合作業後,系統就會自動安裝所有資訊主頁,而 Ops Agent 也會開始收集指標資料。

您也可以查看資訊主頁的靜態預覽畫面,不必安裝整合服務。

如要查看已安裝的資訊主頁,請按照下列步驟操作:

  1. 前往 Google Cloud 控制台的「Dashboards」(資訊主頁) 頁面:

    前往「Dashboards」(資訊主頁)

    如果您是使用搜尋列尋找這個頁面,請選取子標題為「Monitoring」的結果

  2. 選取「資訊主頁清單」分頁,然後選擇「整合」類別。
  3. 按一下要查看的資訊主頁名稱。

如果您已設定整合功能,但尚未安裝資訊主頁,請檢查 Ops Agent 是否正在執行。如果資訊主頁中的圖表沒有指標資料,資訊主頁安裝作業就會失敗。Ops Agent 開始收集指標後,系統就會為您安裝資訊主頁。

如要查看資訊主頁的靜態預覽畫面,請按照下列步驟操作:

  1. 在 Google Cloud 控制台中,前往 「Integrations」(整合) 頁面:

    前往「整合」

    如果您是使用搜尋列尋找這個頁面,請選取子標題為「Monitoring」的結果

  2. 按一下「Compute Engine」部署平台篩選器。
  3. 找出 Varnish 的項目,然後按一下「查看詳細資料」
  4. 選取「資訊主頁」分頁標籤,即可查看靜態預覽畫面。如果已安裝資訊主頁,請點選「查看資訊主頁」前往。

如要進一步瞭解 Cloud Monitoring 中的資訊主頁,請參閱「資訊主頁和圖表」。

如要進一步瞭解如何使用「整合」頁面,請參閱「管理整合」一文。

安裝快訊政策

警告政策會指示 Cloud Monitoring 在發生指定情況時通知您。Varnish 整合功能包含一或多項警告政策,供您使用。 您可以在 Monitoring 的「整合」頁面中查看及安裝這些快訊政策。

如要查看可用快訊政策的說明並安裝,請按照下列步驟操作:

  1. 在 Google Cloud 控制台中,前往 「Integrations」(整合) 頁面:

    前往「整合」

    如果您是使用搜尋列尋找這個頁面,請選取子標題為「Monitoring」的結果

  2. 找出 Varnish 的項目,然後按一下「查看詳細資料」
  3. 選取「快訊」分頁標籤。這個分頁會說明可用的快訊政策,並提供安裝介面。
  4. 安裝快訊政策。快訊政策需要知道在快訊觸發時要將通知傳送至何處,因此需要您提供安裝資訊。如要安裝快訊政策,請按照下列步驟操作:
    1. 從可用的警報政策清單中,選取要安裝的政策。
    2. 在「設定通知」部分,選取一或多個通知管道。您可以選擇停用通知管道,但如果這麼做,快訊政策就會在背景觸發。您可以在「監控」中查看狀態,但不會收到任何通知。

      如要進一步瞭解通知管道,請參閱「管理通知管道」。

    3. 按一下「建立政策」

如要進一步瞭解 Cloud Monitoring 中的快訊政策,請參閱「快訊簡介」。

如要進一步瞭解如何使用「整合」頁面,請參閱「管理整合」一文。

後續步驟

如要逐步瞭解如何使用 Ansible 安裝作業套件代理程式、設定第三方應用程式,以及安裝範例資訊主頁,請觀看「 安裝 Ops Agent 以排解第三方應用程式的問題」影片。