收集 Nagios XI 記錄

支援的國家/地區：

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

Nagios XI 是全方位的基礎架構監控解決方案，可監控伺服器、網路、應用程式和服務。這項解決方案會透過 REST API 追蹤主機和服務狀態、效能指標，並針對 IT 基礎架構問題產生快訊。

事前準備

請確認您已完成下列事前準備事項：

  • Google SecOps 執行個體
  • 已啟用 Cloud Storage、Cloud Run、Pub/Sub 和 Cloud Scheduler API 的 GCP 專案
  • 建立及管理 GCS bucket 的權限
  • 管理 Google Cloud Storage 值區 IAM 政策的權限
  • 建立 Cloud Run 服務、Pub/Sub 主題和 Cloud Scheduler 工作的權限
  • 具備使用者管理權限的 Nagios XI 特殊存取權
  • Nagios XI 5 以上版本 (支援 REST API)

設定 Nagios XI API 存取權

如要讓 Google SecOps 擷取監控資料，您必須建立具備 API 存取權和唯讀權限的使用者帳戶。

建立具備 API 存取權的唯讀權限使用者

  1. 以管理員權限登入 Nagios XI 網頁介面。
  2. 依序前往「管理」>「管理使用者」。
  3. 按一下「新增使用者」。
  4. 請提供下列設定詳細資料：
    • 使用者名稱：輸入描述性名稱 (例如 chronicle-integration)
    • 密碼：輸入安全密碼
    • 「Name」(名稱)：輸入 Chronicle Integration User
    • 電子郵件地址：輸入有效的電子郵件地址
  5. 在「安全性設定」部分，設定下列項目：
    • 授權層級：選取「使用者」
    • 可查看所有主機和服務：勾選這個選項
    • 唯讀存取權：勾選這個選項
    • API 存取權：勾選這個選項
  6. 取消勾選下列選項：
    • 下次登入時強制變更密碼
    • 透過電子郵件傳送使用者帳戶資訊
    • 建立為監控聯絡人
  7. 確認已勾選「帳戶已啟用」。
  8. 點選「Add User」。

擷取 API 金鑰

  1. 在「管理使用者」頁面中，按一下使用者帳戶 (chronicle-integration)。
  2. 在使用者帳戶設定頁面中，找出「API 金鑰」欄位。

  3. 複製 API 金鑰值。

驗證權限

如要確認帳戶是否具備必要權限，請按照下列步驟操作：

  1. 使用 chronicle-integration 使用者帳戶登入 Nagios XI。
  2. 依序前往「首頁」>「主機狀態」。
  3. 如果可以查看所有受監控的主機和服務，表示您具備必要權限。
  4. 如果看不到主機或服務，請與管理員聯絡，請對方授予「可查看所有主機和服務」權限。

測試 API 存取權

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

    # Replace with your actual values
NAGIOS_HOST="https://your-nagios-server.example.com"
API_KEY="your-api-key"

# Test API access - query host status
curl -k "${NAGIOS_HOST}/nagiosxi/api/v1/objects/hoststatus?apikey=${API_KEY}&pretty=1"

    成功的回應會傳回包含主機狀態資訊的 JSON 物件。

建立 Google Cloud Storage bucket

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

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

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

  6. 點選「建立」。

為 Cloud Run 函式建立服務帳戶

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

授予 GCS 值區的 IAM 權限

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

建立 Pub/Sub 主題

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

建立 Cloud Run 函式來收集記錄

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

  1. 前往 GCP Console 的「Cloud Run」。
  2. 按一下「Create service」(建立服務)。
  3. 選取「函式」 (使用內嵌編輯器建立函式)。

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

    設定 值
    服務名稱 nagios-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 主題) 中，選擇 nagios-logs-trigger。
    4. 按一下 [儲存]。

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

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

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

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

    • 服務帳戶：選取 nagios-logs-collector-sa

  9. 前往「容器」分頁：

    1. 按一下「變數與密鑰」。
    2. 針對每個環境變數，按一下「+ 新增變數」：
    變數名稱 範例值 說明
    GCS_BUCKET nagios-xi-logs GCS bucket 名稱
    GCS_PREFIX nagios-xi 記錄檔的前置字串
    STATE_KEY nagios-xi/state.json 狀態檔案路徑
    NAGIOS_BASE_URL https://your-nagios-server.example.com Nagios XI 基準網址
    NAGIOS_API_KEY your-api-key Nagios XI API 金鑰
    MAX_RECORDS 1000 每個端點每次執行的記錄數上限
    PAGE_SIZE 200 每個 API 頁面的記錄
    LOOKBACK_HOURS 24 初始回溯期

  10. 在「變數與密鑰」部分，向下捲動至「要求」：

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

  11. 前往「設定」分頁：

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

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

    • 執行個體數量下限：輸入 0
    • 執行個體數量上限：輸入 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

http = urllib3.PoolManager(
  timeout=urllib3.Timeout(connect=5.0, read=30.0),
  retries=False,
)

storage_client = storage.Client()

GCS_BUCKET = os.environ.get('GCS_BUCKET')
GCS_PREFIX = os.environ.get('GCS_PREFIX', 'nagios-xi')
STATE_KEY = os.environ.get('STATE_KEY', 'nagios-xi/state.json')
NAGIOS_BASE_URL = os.environ.get('NAGIOS_BASE_URL', '').rstrip('/')
NAGIOS_API_KEY = os.environ.get('NAGIOS_API_KEY')
MAX_RECORDS = int(os.environ.get('MAX_RECORDS', '1000'))
PAGE_SIZE = int(os.environ.get('PAGE_SIZE', '200'))
LOOKBACK_HOURS = int(os.environ.get('LOOKBACK_HOURS', '24'))

ENDPOINTS = [
  'hoststatus',
  'servicestatus',
  'statehistory',
  'logentries',
]

@functions_framework.cloud_event
def main(cloud_event):
  if not all([GCS_BUCKET, NAGIOS_BASE_URL, NAGIOS_API_KEY]):
    print('Error: Missing required environment variables')
    return

  try:
    bucket = storage_client.bucket(GCS_BUCKET)
    state = load_state(bucket)
    now = datetime.now(timezone.utc)

    if isinstance(state, dict) and state.get('last_event_time'):
      try:
        last_val = state['last_event_time']
        if last_val.endswith('Z'):
          last_val = last_val[:-1] + '+00:00'
        last_time = datetime.fromisoformat(last_val)
        last_time = last_time - timedelta(minutes=2)
      except Exception as e:
        print(f"Warning: Could not parse last_event_time: {e}")
        last_time = now - timedelta(hours=LOOKBACK_HOURS)
    else:
      last_time = now - timedelta(hours=LOOKBACK_HOURS)

    print(f"Fetching logs from {last_time.isoformat()} to {now.isoformat()}")

    start_ts = int(last_time.timestamp())
    end_ts = int(now.timestamp())

    all_records = []
    newest_time = None

    for endpoint in ENDPOINTS:
      records, endpoint_newest = fetch_nagios_endpoint(
        endpoint, start_ts, end_ts
      )
      for record in records:
        record['_nagios_endpoint'] = endpoint
      all_records.extend(records)

      if endpoint_newest:
        if newest_time is None or endpoint_newest > newest_time:
          newest_time = endpoint_newest

    if not all_records:
      print("No new records found.")
      save_state(bucket, now.isoformat())
      return

    timestamp = now.strftime('%Y%m%d_%H%M%S')
    object_key = f"{GCS_PREFIX}/nagios_logs_{timestamp}.ndjson"
    blob = bucket.blob(object_key)

    ndjson = '\n'.join(
      [json.dumps(r, ensure_ascii=False, default=str) for r 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}")

    if newest_time:
      save_state(bucket, newest_time)
    else:
      save_state(bucket, now.isoformat())

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

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

def fetch_nagios_endpoint(endpoint, start_ts, end_ts):
  base_url = f"{NAGIOS_BASE_URL}/nagiosxi/api/v1/objects/{endpoint}"

  records = []
  newest_time = None
  start_index = 0
  page_num = 0
  backoff = 1.0

  while True:
    page_num += 1

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

    remaining = min(PAGE_SIZE, MAX_RECORDS - len(records))
    params = [
      f"apikey={NAGIOS_API_KEY}",
      f"starttime={start_ts}",
      f"endtime={end_ts}",
      f"records={remaining}",
      f"start={start_index}",
    ]
    url = f"{base_url}?{'&'.join(params)}"

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

      if response.status == 429:
        retry_after = int(response.headers.get('Retry-After', str(int(backoff))))
        print(f"{endpoint}: 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"{endpoint}: HTTP Error {response.status}")
        response_text = response.data.decode('utf-8')
        print(f"Response body: {response_text}")
        break

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

      record_count = data.get('recordcount', 0)
      result_key = get_result_key(endpoint)
      page_results = data.get(result_key, [])

      if not page_results:
        print(f"{endpoint}: No more results at offset {start_index}")
        break

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

      for event in page_results:
        try:
          event_time = event.get('state_time') or event.get('status_update_time') or event.get('entry_time')
          if event_time:
            if newest_time is None or event_time > newest_time:
              newest_time = event_time
        except Exception as e:
          print(f"Warning: Could not parse event time: {e}")

      if len(page_results) < remaining:
        print(f"{endpoint}: Reached last page (returned {len(page_results)} < {remaining})")
        break

      start_index += len(page_results)

    except Exception as e:
      print(f"{endpoint}: Error fetching logs: {e}")
      break

  print(f"{endpoint}: Retrieved {len(records)} total records from {page_num} pages")
  return records, newest_time

def get_result_key(endpoint):
  key_map = {
    'hoststatus': 'hoststatus',
    'servicestatus': 'servicestatus',
    'statehistory': 'statehistory',
    'logentries': 'logentry',
  }
  return key_map.get(endpoint, endpoint)

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

def save_state(bucket, last_event_time_iso):
  try:
    state = {
      'last_event_time': last_event_time_iso,
      'last_run': datetime.now(timezone.utc).isoformat()
    }
    blob = bucket.blob(STATE_KEY)
    blob.upload_from_string(
      json.dumps(state, indent=2),
      content_type='application/json'
    )
    print(f"Saved state: last_event_time={last_event_time_iso}")
  except Exception as e:
    print(f"Warning: Could not save state: {e}")

    • requirements.txt:

      functions-framework==3.*
google-cloud-storage==2.*
urllib3>=2.0.0

  3. 點選「部署」即可儲存並部署函式。

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

建立 Cloud Scheduler 工作

  1. 前往 GCP 主控台的「Cloud Scheduler」。
  2. 點選「建立工作」。

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

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

  4. 點選「建立」。

排程頻率選項

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

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

測試整合項目

  1. 在 Cloud Scheduler 控制台中，找出您的工作 (nagios-logs-collector-hourly)。
  2. 按一下「強制執行」即可手動觸發工作。
  3. 稍等幾秒鐘。
  4. 前往「Cloud Run」>「Services」。
  5. 按一下 nagios-logs-collector。
  6. 按一下 [Logs] (記錄) 分頁標籤。

  7. 確認函式是否已順利執行。請注意以下事項：

    Fetching logs from YYYY-MM-DDTHH:MM:SS+00:00 to YYYY-MM-DDTHH:MM:SS+00:00
hoststatus page 1: Retrieved X events
servicestatus page 1: Retrieved X events
statehistory page 1: Retrieved X events
logentries page 1: Retrieved X events
Wrote X records to gs://nagios-xi-logs/nagios-xi/nagios_logs_YYYYMMDD_HHMMSS.ndjson
Successfully processed X records

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

  9. 按一下 nagios-xi-logs。

  10. 前往 nagios-xi/ 資料夾。

  11. 確認是否已建立新的 .ndjson 檔案，且檔案名稱包含目前的時間戳記。

如果記錄中顯示錯誤：

  • HTTP 401：確認 NAGIOS_API_KEY 環境變數正確無誤，且使用者已啟用 API 存取權
  • HTTP 403：確認使用者帳戶具有「可查看所有主機和服務」權限
  • HTTP 429：頻率限制，函式會自動重試並延遲
  • 缺少環境變數：確認 Cloud Run 函式設定中已設定所有必要變數

擷取 Google SecOps 服務帳戶

  1. 依序前往「SIEM 設定」>「動態饋給」。
  2. 按一下「新增動態消息」。
  3. 按一下「設定單一動態饋給」。
  4. 在「動態饋給名稱」欄位中輸入動態饋給名稱 (例如 Nagios XI Logs GCS)。
  5. 選取「Google Cloud Storage V2」做為「來源類型」。
  6. 選取「Nagios」做為「記錄類型」。
  7. 按一下「取得服務帳戶」。

  8. 系統會顯示專屬的服務帳戶電子郵件地址。例如：

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

  9. 複製這個電子郵件地址，以便在下一步中使用。

  10. 點選「下一步」。

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

    • 儲存空間 bucket URL：輸入 GCS bucket URI，並加上前置路徑：

      gs://nagios-xi-logs/nagios-xi/

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

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

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

    • 檔案存在時間上限：包含在過去天數內修改的檔案 (預設為 180 天)

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

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

  12. 點選「下一步」。

  13. 在「Finalize」(完成) 畫面中檢查新的動態饋給設定，然後按一下「Submit」(提交)。

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

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

  6. 按一下 [儲存]。

UDM 對應表

記錄欄位 UDM 對應 邏輯
src_ip has_principal 如果 src_ip 合併至 principal.ip 和 principal.asset.ip 的作業成功，請設為「true」
src_ip principal.asset.ip 直接複製值
src_ip principal.ip 直接複製值
jobid jobid_label.key 設為「Jobid」
jobid jobid_label.value 直接複製值
jobid_label principal.resource.attribute.labels 從 jobid_label 合併
pid principal.process.pid 直接複製值
ent metadata.product_event_type 直接複製值
說明 metadata.description 直接複製值
msg_ip has_target 如果 msg_ip 合併至 target.ip 和 target.asset.ip 成功，則設為「true」
msg_ip target.asset.ip 直接複製值
msg_ip target.ip 直接複製值
通訊埠 target.port 直接複製值並轉換為整數
第 1 欄 principal.asset.hostname 如果 ent ==「SERVICE ALERT」，則為 column1 的值；如果 ent ==「SERVICE NOTIFICATION」，則為 column2 的值
第 1 欄 principal.hostname 如果 ent ==「SERVICE ALERT」，則為 column1 的值；如果 ent ==「SERVICE NOTIFICATION」，則為 column2 的值
第 1 欄 principal.user.user_display_name 如果 ent == "SERVICE NOTIFICATION"，則直接複製值
第 2 欄 security_result.summary 如果 ent ==「SERVICE ALERT」且 column2 不為空白，則為 column3 的值；如果 ent ==「SERVICE NOTIFICATION」，則為 column3 的值
第 3 欄 security_result.summary 如果 ent ==「SERVICE ALERT」且 column3 不為空白，則為 column3 的值；如果 ent ==「SERVICE NOTIFICATION」，則為 column3 的值
column4 security_result.severity 如果 column4 位於 ["LOW", "MEDIUM", "HIGH", "CRITICAL"] 中，且 ent 位於 ["SERVICE NOTIFICATION", "SERVICE ALERT"] 中，則直接複製值
column4 security_result.severity_details 如果 column4 不在 ["LOW", "MEDIUM", "HIGH", "CRITICAL"] 中，且 ent 在 ["SERVICE NOTIFICATION", "SERVICE ALERT"] 中，則直接複製值
has_principal metadata.event_type 如果 has_principal 和 has_target 為 true，則設為「NETWORK_CONNECTION」；如果 has_principal 為 true，則設為「STATUS_UPDATE」；如果 has_principal_user 為 true，則設為「USER_UNCATEGORIZED」；否則設為「GENERIC_EVENT」
has_target metadata.event_type
has_principal_user metadata.event_type
security_result event.idm.read_only_udm.security_result 從 security_result 合併
中繼資料 event.idm.read_only_udm.metadata 從中繼資料重新命名
目標 event.idm.read_only_udm.target 已從目標重新命名
主體 event.idm.read_only_udm.principal 已從主體重新命名
網路 event.idm.read_only_udm.network 從電視網重新命名
metadata.product_name metadata.product_name 設為「NAGIOS」
metadata.vendor_name metadata.vendor_name 設為「NAGIOS」

變更記錄

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

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