連接 New Relic
連接 New Relic 帳戶,即可把它的基礎架構主機、APM 服務和綜合監視器,連同其黃金指標(golden metrics)和未解決的問題帶入 Excubius。本指南說明 New Relic 端的最低權限設定、如何新增數據源,以及如何透過 Webhook 傳送問題。
開始之前
- 你需要在該帳戶所屬的實體上擁有 Entity admin(實體管理員)角色,例如 桃花島物流。
- 在 New Relic 中,你可以在該帳戶上建立用戶或服務用戶、API 金鑰和工作流程。
- 功能
sources.newrelic已開啟。請參閱數據源。
Excubius 讀取的內容
New Relic 的讀取透過 NerdGraph 進行,只使用 GraphQL 查詢,絕不使用變更(mutation)。
| 階段 | 內容 | 預設間隔 |
|---|---|---|
| 清單 | 帳戶中的實體搜尋:基礎架構主機(按作業系統標記區分 Windows、Linux 或 macOS)、APM 應用程式和綜合監視器,也可以用實體搜尋條件縮小範圍 | 15 分鐘 |
| 指標 | 同一搜尋傳回的摘要,不使用 NRQL,因此佔用的配額很少。主機的 CPU、記憶體和磁碟供給 Windows 和 Linux 主機檢查;APM 和綜合監視供給 New Relic 檢查 | 5 分鐘 |
| 警報 | 過去 30 天內狀態為 CREATED 和 ACTIVATED 的 AI issues,每個問題和實體各產生一個警報 | 在 Polling 中為 5 分鐘;在 Hybrid 中每 15 分鐘對帳一次 |
準備 New Relic
- 建立一個用戶,或使用服務用戶,其在該帳戶上的角色為 read only,例如內建的 All product read only 角色。
- 以該用戶登入,開啟 API keys 並建立類型為 User 的金鑰。複製該金鑰;它以
NRAK-開頭。授權金鑰、瀏覽器金鑰和引入金鑰無法使用。 - 記下 account ID 和數據中心(US 或 EU)。
Excubius 輪詢所需要的只有這個用戶金鑰。Webhook only 模式的數據源既不需要金鑰,也不需要 account ID。
新增數據源
- 開啟 Settings › Sources,選取 Add a source,然後選擇 New Relic。
- 在 General 下,輸入 Name,例如 New Relic 桃花島物流,並選擇 Entity。
- 在 Connection 下,輸入 Account ID、Region 和 User API key。
- 在 What to read 下,保留 Hosts、APM services、Synthetic monitors 和 Golden metrics,或清除你不想要的項目。沒有 Golden metrics 時,實體會在沒有指標的情況下帶入。
- 你也可以輸入 Entity filter,這是 New Relic 的實體搜尋條件,例如
tags.environment = 'production'。當一個帳戶涵蓋多個客戶時使用。 - 在 Ingest mode 下,保留 Hybrid (recommended)。
- 你也可以在 Webhook 下輸入 Webhook secret,New Relic 會在每個 Webhook 中附上它。
- 選取 Create source 並複製 webhook URL。它只會顯示一次。
透過 Webhook 傳送問題
在 Hybrid 或 Webhook only 模式下,請設定 New Relic 主動推送它的問題:
-
在 New Relic 中,開啟 Alerts › Destinations,並新增一個 Webhook 目的地,使用 Excubius 顯示的 URL。如果你設定了 Webhook 密碼,請加入標頭
Authorization: Bearer <secret>或X-Webhook-Secret: <secret>。 -
建立一個 workflow,篩選你希望出現在 Excubius 的問題,並使用以下有效負載範本通知該目的地:
New Relic 的預設範本也可以使用。
-
在 activated 和 closed 時通知,這樣警報也會在 Excubius 中關閉。
測試及同步
- 在數據源頁面上,選取 Test。每次讀取都會連同其結果列出:憑證、帳戶、清單和警報。
- 選取 Sync now,無須等待即可帶入清單、指標和警報。
主機會顯示為資源,並與其他數據源中的相同伺服器配對。APM 服務顯示為 Application (APM) 資源,監視器顯示為 Synthetic monitor 資源,並附帶各自的檢查。未解決的問題會顯示在 Alert inbox 中,並附有指向 New Relic 的連結。
選擇模式
| 模式 | 你會得到 |
|---|---|
| Hybrid | 透過 Webhook 即時取得問題;透過輪詢取得清單和指標;並透過對帳,關閉在 Webhook 遺失期間於 New Relic 中已關閉的項目 |
| Polling | 全部透過輪詢。問題會在警報間隔內出現,預設為 5 分鐘 |
| Webhook only | 只有問題,沒有清單或指標,也不儲存金鑰 |