收集 WP Engine 記錄

支援的服務：

本文說明如何使用 Google Cloud Storage V2，將 WP Engine 記錄檔擷取至 Google Security Operations。

WP Engine 是代管 WordPress 託管平台，提供企業級託管服務，內建安全性、效能最佳化和 CDN 服務。系統會產生存取記錄、錯誤記錄和 CDN 事件記錄，並可透過 WP Engine API 收集。

事前準備

請確認您符合下列必要條件：

  • Google SecOps 執行個體
  • 已啟用 Cloud Storage API 的 GCP 專案
  • 建立及管理 GCS bucket 的權限
  • 具備管理 GCS bucket IAM 政策的權限
  • 建立 Cloud Run 服務、Pub/Sub 主題和 Cloud Scheduler 工作的權限
  • 具備 API 存取權限，可存取 WP Engine 使用者入口網站
  • 已啟用 API 存取權的 WP Engine 帳戶

建立 Google Cloud Storage bucket

  1. 前往 Google Cloud 控制台。
  2. 選取專案或建立新專案。
  3. 在導覽選單中，依序前往「Cloud Storage」>「Bucket」。
  4. 按一下「建立值區」。

  5. 提供下列設定詳細資料：

    設定 值
    為 bucket 命名 輸入全域不重複的名稱 (例如 wpengine-logs)
    位置類型 請根據需求選擇 (單一區域、雙區域、多區域)
    位置 選取位置 (例如 us-central1)
    儲存空間級別 標準 (建議用於經常存取的記錄)
    存取控管 統一 (建議)
    保護工具 選用：啟用物件版本管理或資料保留政策

  6. 點選「建立」。

收集 WP Engine API 憑證

產生 API 憑證

  1. 登入 WP Engine 使用者入口網站。
  2. 按一下設定檔名稱，然後依序前往「設定檔」>「API 存取權」。
  3. 按一下「Generate Credentials」(產生憑證)。

  4. 複製下列詳細資料，並存放在安全的位置：

    • API 使用者名稱：產生的 API 使用者名稱
    • API 密碼：產生的 API 密碼 (僅顯示一次)

取得安裝名稱

  1. 登入 WP Engine 使用者入口網站。
  2. 前往導覽選單中的「網站」。
  3. 按一下要收集記錄的網站。
  4. 記下網站總覽頁面顯示的安裝名稱。每個環境 (實際工作、測試、開發) 都有獨立的安裝名稱。

測試 API 存取權

  • 請先測試憑證，再繼續整合：

    # Replace with your actual credentials
WPE_USER="your-api-username"
WPE_PASSWORD="your-api-password"

# Test API access - list installs
curl -v -u "${WPE_USER}:${WPE_PASSWORD}" "https://api.wpengineapi.com/v1/installs"

建立 Cloud Run 函式的服務帳戶

Cloud Run 函式需要服務帳戶，且該帳戶須具備寫入 GCS bucket 的權限，並可由 Pub/Sub 叫用。

建立服務帳戶

  1. 在 GCP 控制台中，依序前往「IAM & Admin」(IAM 與管理) >「Service Accounts」(服務帳戶)。
  2. 按一下「Create Service Account」(建立服務帳戶)。
  3. 提供下列設定詳細資料：
    • 服務帳戶名稱：輸入 wpengine-logs-collector-sa
    • 服務帳戶說明：輸入 Service account for Cloud Run function to collect WP Engine logs
  4. 按一下「建立並繼續」。
  5. 在「將專案存取權授予這個服務帳戶」部分，新增下列角色：
    1. 按一下「請選擇角色」。
    2. 搜尋並選取「Storage 物件管理員」。
    3. 點選「+ 新增其他角色」。
    4. 搜尋並選取「Cloud Run Invoker」。
    5. 點選「+ 新增其他角色」。
    6. 搜尋並選取「Cloud Functions 叫用者」。
  6. 按一下「繼續」。
  7. 按一下「完成」。

這些角色適用於：

  • Storage 物件管理員：將記錄檔寫入 GCS bucket 並管理狀態檔案
  • Cloud Run 叫用者：允許 Pub/Sub 叫用函式
  • Cloud Functions 叫用者：允許叫用函式

授予 GCS bucket 的 IAM 權限

授予服務帳戶 GCS bucket 的寫入權限：

  1. 依序前往「Cloud Storage」>「Bucket」。
  2. 點選 bucket 名稱 (例如 wpengine-logs)。
  3. 前往「權限」分頁。
  4. 按一下「授予存取權」。
  5. 提供下列設定詳細資料：
    • 新增主體：輸入服務帳戶電子郵件地址 (例如 wpengine-logs-collector-sa@PROJECT_ID.iam.gserviceaccount.com)
    • 指派角色：選取「Storage 物件管理員」
  6. 按一下「儲存」。

建立 Pub/Sub 主題

建立 Pub/Sub 主題，Cloud Scheduler 會發布至該主題，Cloud Run 函式則會訂閱該主題。

  1. 在 GCP 控制台中，依序前往「Pub/Sub」>「主題」。
  2. 按一下「建立主題」。
  3. 提供下列設定詳細資料：
    • 主題 ID：輸入 wpengine-logs-trigger
    • 其他設定保留預設值
  4. 點選「建立」。

建立 Cloud Run 函式來收集記錄

Cloud Run 函式會由 Cloud Scheduler 的 Pub/Sub 訊息觸發，從 WP Engine API 擷取記錄並寫入 GCS。

  1. 在 GCP 控制台中，前往「Cloud Run」。
  2. 按一下「Create service」(建立服務)。
  3. 選取「函式」(使用直接修改建立函式)。

  4. 在「Configure」(設定) 部分，提供下列設定詳細資料：

    設定 值
    服務名稱 wpengine-logs-collector
    區域 選取與 GCS bucket 相符的區域 (例如 us-central1)
    執行階段 選取「Python 3.12」或更新版本

  5. 在「Trigger (optional)」(觸發條件 (選用)) 部分：

    1. 按一下「+ 新增觸發條件」。
    2. 選取「Cloud Pub/Sub」。
    3. 在「Select a Cloud Pub/Sub topic」(選取 Cloud Pub/Sub 主題) 中，選擇主題 wpengine-logs-trigger。
    4. 按一下「儲存」。

  6. 在「Authentication」(驗證) 部分：

    1. 選取「需要驗證」。
    2. Identity and Access Management (IAM)。

  7. 向下捲動並展開「容器、網路、安全性」。

  8. 前往「安全性」分頁：

    • 「Service account」(服務帳戶)：選取服務帳戶 wpengine-logs-collector-sa。

  9. 前往「容器」分頁：

    1. 按一下「Variables & Secrets」(變數與密鑰)。
    2. 針對每個環境變數，按一下「+ 新增變數」：
    變數名稱 範例值 說明
    GCS_BUCKET wpengine-logs GCS bucket 名稱
    GCS_PREFIX wpengine 記錄檔的前置字串
    STATE_KEY wpengine/state.json 狀態檔案路徑
    WPE_API_USER your-api-username WP Engine API 使用者名稱
    WPE_API_PASSWORD your-api-password WP Engine API 密碼
    WPE_INSTALL_ID myinstall WP Engine 安裝名稱
    MAX_RECORDS 5000 每次執行的記錄數上限
    PAGE_SIZE 100 每頁記錄數
    LOOKBACK_HOURS 24 初始回溯期

  10. 在「Variables & Secrets」(變數與密鑰) 部分，向下捲動至「Requests」(要求)：

    • 要求逾時：輸入 600 秒 (10 分鐘)

  11. 前往「設定」分頁：

    • 在「Resources」(資源) 部分：
      • 「記憶體」：選取「512 MiB」或以上
      • CPU：選取「1」

  12. 在「Revision scaling」(修訂版本資源調度) 部分：

    • 「執行個體數量下限」：輸入 0
    • 「Maximum number of instances」(執行個體數量上限)：輸入 100 (或根據預期負載調整)

  13. 點選「建立」。

  14. 等待服務建立完成 (1 至 2 分鐘)。

  15. 服務建立後，內嵌程式碼編輯器會自動開啟。

新增函式程式碼

  1. 在「進入點」欄位中輸入 main。

  2. 在內嵌程式碼編輯器中，建立兩個檔案：

    • 第一個檔案：main.py:
    import functions_framework
from google.cloud import storage
import json
import os
import urllib3
from datetime import datetime, timezone, timedelta
import time
import base64

# Initialize HTTP client with timeouts
http = urllib3.PoolManager(
  timeout=urllib3.Timeout(connect=5.0, read=30.0),
  retries=False,
)

# Initialize Storage client
storage_client = storage.Client()

# Environment variables
GCS_BUCKET = os.environ.get('GCS_BUCKET')
GCS_PREFIX = os.environ.get('GCS_PREFIX', 'wpengine')
STATE_KEY = os.environ.get('STATE_KEY', 'wpengine/state.json')
WPE_API_USER = os.environ.get('WPE_API_USER')
WPE_API_PASSWORD = os.environ.get('WPE_API_PASSWORD')
WPE_INSTALL_ID = os.environ.get('WPE_INSTALL_ID')
MAX_RECORDS = int(os.environ.get('MAX_RECORDS', '5000'))
PAGE_SIZE = int(os.environ.get('PAGE_SIZE', '100'))
LOOKBACK_HOURS = int(os.environ.get('LOOKBACK_HOURS', '24'))

# WP Engine API base URL
API_BASE = 'https://api.wpengineapi.com/v1'

# Log types to fetch
LOG_TYPES = ['access', 'error']

def get_auth_header():
  """Generate HTTP Basic auth header for WP Engine API."""
  credentials = f"{WPE_API_USER}:{WPE_API_PASSWORD}"
  encoded = base64.b64encode(credentials.encode('utf-8')).decode('utf-8')
  return f"Basic {encoded}"

@functions_framework.cloud_event
def main(cloud_event):
  """
  Cloud Run function triggered by Pub/Sub to fetch WP Engine
  logs and write to GCS.

  Args:
    cloud_event: CloudEvent object containing Pub/Sub message
  """

  if not all([GCS_BUCKET, WPE_API_USER, WPE_API_PASSWORD, WPE_INSTALL_ID]):
    print('Error: Missing required environment variables')
    return

  try:
    bucket = storage_client.bucket(GCS_BUCKET)

    # Load state
    state = load_state(bucket, STATE_KEY)

    # Determine time window
    now = datetime.now(timezone.utc)
    last_offsets = {}

    if isinstance(state, dict) and state.get("last_offsets"):
      last_offsets = state["last_offsets"]

    print(f"Fetching logs for install: {WPE_INSTALL_ID}")

    auth_header = get_auth_header()
    all_records = []

    # Fetch both access and error log types
    for log_type in LOG_TYPES:
      last_offset = last_offsets.get(log_type, 0)

      records = fetch_logs(
        auth_header=auth_header,
        install_id=WPE_INSTALL_ID,
        log_type=log_type,
        start_offset=last_offset,
        page_size=PAGE_SIZE,
        max_records=MAX_RECORDS,
      )

      # Tag records with log type
      for record in records:
        record['_wpe_log_type'] = log_type

      all_records.extend(records)

      # Update offset for this log type
      if records:
        last_offsets[log_type] = last_offset + len(records)

      print(f"Fetched {len(records)} {log_type} log records")

    if not all_records:
      print("No new log records found.")
      save_state(bucket, STATE_KEY, last_offsets)
      return

    # Write to GCS as NDJSON
    timestamp = now.strftime('%Y%m%d_%H%M%S')
    object_key = f"{GCS_PREFIX}/logs_{timestamp}.ndjson"
    blob = bucket.blob(object_key)

    ndjson = '\n'.join([json.dumps(record, ensure_ascii=False) for record in all_records]) + '\n'
    blob.upload_from_string(ndjson, content_type='application/x-ndjson')

    print(f"Wrote {len(all_records)} records to gs://{GCS_BUCKET}/{object_key}")

    # Update state
    save_state(bucket, STATE_KEY, last_offsets)

    print(f"Successfully processed {len(all_records)} records")

  except Exception as e:
    print(f'Error processing logs: {str(e)}')
    raise

def load_state(bucket, key):
  """Load state from GCS."""
  try:
    blob = bucket.blob(key)
    if blob.exists():
      state_data = blob.download_as_text()
      return json.loads(state_data)
  except Exception as e:
    print(f"Warning: Could not load state: {e}")

  return {}

def save_state(bucket, key, last_offsets: dict):
  """Save the last offsets to GCS state file."""
  try:
    state = {'last_offsets': last_offsets}
    blob = bucket.blob(key)
    blob.upload_from_string(
      json.dumps(state, indent=2),
      content_type='application/json'
    )
    print(f"Saved state: last_offsets={last_offsets}")
  except Exception as e:
    print(f"Warning: Could not save state: {e}")

def fetch_logs(auth_header: str, install_id: str, log_type: str, start_offset: int, page_size: int, max_records: int):
  """
  Fetch logs from WP Engine API with offset-based pagination
  and rate limiting.

  Args:
    auth_header: HTTP Basic auth header
    install_id: WP Engine install name
    log_type: Log type to fetch (access or error)
    start_offset: Starting offset for pagination
    page_size: Number of records per page
    max_records: Maximum total records to fetch

  Returns:
    List of log records
  """
  headers = {
    'Authorization': auth_header,
    'Accept': 'application/json',
    'User-Agent': 'GoogleSecOps-WPEngineCollector/1.0'
  }

  records = []
  offset = start_offset
  page_num = 0
  backoff = 1.0

  while True:
    page_num += 1

    if len(records) >= max_records:
      print(f"Reached max_records limit ({max_records}) for {log_type}")
      break

    limit = min(page_size, max_records - len(records))
    url = f"{API_BASE}/installs/{install_id}/logs?type={log_type}&limit={limit}&offset={offset}"

    try:
      response = http.request('GET', url, headers=headers)

      # Handle rate limiting with exponential backoff
      if response.status == 429:
        retry_after = int(response.headers.get('Retry-After', str(int(backoff))))
        print(f"Rate limited (429). Retrying after {retry_after}s...")
        time.sleep(retry_after)
        backoff = min(backoff * 2, 30.0)
        continue

      backoff = 1.0

      if response.status != 200:
        print(f"HTTP Error: {response.status}")
        response_text = response.data.decode('utf-8')
        print(f"Response body: {response_text}")
        return []

      data = json.loads(response.data.decode('utf-8'))

      page_results = data.get('results', data.get('data', []))

      if not page_results:
        print(f"No more results (empty page) for {log_type}")
        break

      print(f"Page {page_num}: Retrieved {len(page_results)} {log_type} events")
      records.extend(page_results)

      offset += len(page_results)

      # If we got fewer results than requested, no more pages
      if len(page_results) < limit:
        print(f"Last page reached for {log_type}")
        break

    except Exception as e:
      print(f"Error fetching {log_type} logs: {e}")
      return []

  print(f"Retrieved {len(records)} total {log_type} records from {page_num} pages")
  return records
    • 第二個檔案：requirements.txt:
    functions-framework==3.*
google-cloud-storage==2.*
urllib3>=2.0.0

  3. 按一下「部署」，即可儲存並部署函式。

  4. 等待部署作業完成 (2 至 3 分鐘)。

建立 Cloud Scheduler 工作

Cloud Scheduler 會定期將訊息發布至 Pub/Sub 主題，觸發 Cloud Run 函式。

  1. 在 GCP 控制台中，前往「Cloud Scheduler」。
  2. 點選「建立工作」。

  3. 提供下列設定詳細資料：

    設定 值
    名稱 wpengine-logs-collector-hourly
    區域 選取與 Cloud Run 函式相同的區域
    頻率 0 * * * * (每小時整點)
    時區 選取時區 (建議選取世界標準時間)
    目標類型 Pub/Sub
    主題 選取主題「wpengine-logs-trigger」
    郵件內文 {} (空白 JSON 物件)

  4. 點選「建立」。

排程頻率選項

根據記錄量和延遲時間需求選擇頻率：

頻率 Cron 運算式 用途
每 5 分鐘 */5 * * * * 高流量、低延遲
每 15 分鐘 */15 * * * * 中等音量
每小時 0 * * * * 標準 (建議)
每 6 小時 0 */6 * * * 低量、批次處理
每天 0 0 * * * 歷來資料集合

測試整合

  1. 在 Cloud Scheduler 控制台中找到您的工作。
  2. 按一下「強制執行」，手動觸發工作。
  3. 稍等幾秒鐘。
  4. 依序前往「Cloud Run」>「服務」。
  5. 按一下「wpengine-logs-collector」。
  6. 點選「記錄」分頁標籤。

  7. 確認函式是否執行成功。尋找：

    Fetching logs for install: myinstall
Page 1: Retrieved X access events
Fetched X access log records
Page 1: Retrieved X error events
Fetched X error log records
Wrote X records to gs://wpengine-logs/wpengine/logs_YYYYMMDD_HHMMSS.ndjson
Successfully processed X records

  8. 依序前往「Cloud Storage」>「Bucket」。

  9. 點選 bucket 名稱 (wpengine-logs)。

  10. 前往 wpengine/ 資料夾。

  11. 確認系統已建立新的 .ndjson 檔案，並加上目前的時間戳記。

如果記錄中顯示錯誤：

  • HTTP 401：檢查環境變數中的 API 憑證
  • HTTP 403：確認 WP Engine 使用者入口網站已啟用 API 存取權
  • HTTP 429：頻率限制 - 函式會自動重試，並採用輪詢機制
  • 缺少環境變數：確認已設定所有必要變數

在 Google SecOps 中設定動態饋給，以便擷取 WP Engine 記錄

  1. 依序前往「設定」>「資料管理」>「動態饋給」。如果使用的是 SIEM 專用平台，請依序前往「設定」>「動態饋給」。
  2. 按一下「新增動態饋給」。
  3. 按一下「設定單一動態饋給」。
  4. 在「Feed name」(動態饋給名稱) 欄位中，輸入動態饋給名稱 (例如 WP Engine Logs)。
  5. 選取「Google Cloud Storage V2」做為「來源類型」。
  6. 選取「WPEngine」做為「記錄類型」。

  7. 按一下「Get Service Account」。系統會顯示專屬服務帳戶電子郵件地址，例如：

    chronicle-12345678@chronicle-gcp-prod.iam.gserviceaccount.com

  8. 複製這個電子郵件地址。

  9. 點選「下一步」。

  10. 指定下列輸入參數的值：

    • Storage bucket URL：輸入 GCS bucket URI，並加上前置字元路徑：

      gs://wpengine-logs/wpengine/
      • 取代：
        • wpengine-logs：GCS bucket 名稱。
        • wpengine：儲存記錄檔的選用前置字元/資料夾路徑 (留空則為根目錄)。

    • 來源刪除選項：根據偏好選取刪除選項：

      • Never：轉移後一律不刪除任何檔案 (建議用於測試)。
      • 刪除已轉移的檔案：在成功轉移後刪除檔案。

      • 刪除已轉移的檔案和空白目錄：成功轉移後，刪除檔案和空白目錄。

    • 檔案存在時間上限：納入過去幾天內修改過的檔案 (預設為 180 天)

    • 資產命名空間：資產命名空間

    • 擷取標籤：要套用至這個動態饋給事件的標籤

  11. 點選「下一步」。

  12. 在「完成」畫面中檢查新的新聞動態消息設定，然後按一下「提交」。

將 IAM 權限授予 Google SecOps 服務帳戶

Google SecOps 服務帳戶需要 GCS bucket 的 Storage 物件檢視者角色。

  1. 依序前往「Cloud Storage」>「Bucket」。
  2. 點按 bucket 名稱。
  3. 前往「權限」分頁。
  4. 按一下「授予存取權」。
  5. 提供下列設定詳細資料：
    • 新增主體：貼上 Google SecOps 服務帳戶電子郵件地址
    • 指派角色：選取「Storage 物件檢視者」
  6. 按一下「儲存」。

UDM 對應表

記錄欄位 UDM 對應 邏輯
request, sig, blog_id, kind, name, slug, ver additional.fields 與要求中的標籤 (request_label)、sig (sig_label)、blog_id (blog_id_label)、kind (kind_label)、name (name_label)、slug (slug_label)、ver (ver_label) 合併 (如果各項不為空白)
msg metadata.description 直接複製值
metadata.event_type 如果 has_principal 為 true，請設為「STATUS_UPDATE」，否則設為「GENERIC_EVENT」
通訊協定 network.application_protocol 直接複製值
版本 network.application_protocol_version 已轉換為字串
方法 network.http.method 直接複製值
user_agent network.http.parsed_user_agent 已轉換為 parseduseragent
secure_url network.http.referral_url 直接複製值
response_code network.http.response_code 先轉換為字串，再轉換為整數
user_agent network.http.user_agent 直接複製值
received_bytes network.received_bytes 先轉換為字串，再轉換為無正負號整數
主機名稱 principal.asset.hostname 直接複製值
client_ip principal.asset.ip 直接複製值
主機名稱 principal.hostname 直接複製值
client_ip principal.ip 直接複製值
通訊埠 principal.port 先轉換為字串，再轉換為整數
pid principal.process.pid 已轉換為字串
scan_type, scan_value security_result.description 如果 scan_value 不為空值，則為 scan_value 的值，否則為 scan_type 的值 (如果不為空值)

變更記錄

查看這個剖析器的變更記錄

還有其他問題嗎？向社群成員和 Google SecOps 專業人員尋求解答。