Apache Cassandra 整合功能會收集要求、工作和儲存空間指標,以便突顯執行個體的負載。整合服務也可以選擇收集與記憶體和垃圾收集相關的一般 JVM 指標。整合作業也會收集系統、偵錯和垃圾收集記錄。這些記錄會剖析為 JSON 酬載,其中包含訊息、Java 類別和行號的欄位。
如要進一步瞭解 Cassandra,請參閱 Apache Cassandra 說明文件。
事前準備
如要收集 Cassandra 遙測資料,您必須安裝 Ops Agent:
- 如要使用指標,請安裝 2.6.0 以上版本。
- 如要記錄,請安裝 2.5.0 以上版本。
這項整合支援 Cassandra 3.11 和 4.0 版。
設定 Cassandra 執行個體
如要公開 JMX 端點,您必須在啟動 JVM 時設定 com.sun.management.jmxremote.port
系統屬性。我們也建議您將 com.sun.management.jmxremote.rmi.port
系統屬性設為相同的連接埠。如要遠端公開 JMX 端點,您也必須設定 java.rmi.server.hostname
系統屬性。
根據預設,這些屬性會在 Cassandra 部署的 cassandra-env.sh
檔案中設定。
如要使用指令列引數設定系統屬性,請在啟動 JVM 時在屬性名稱前方加上 -D
。舉例來說,如要將 com.sun.management.jmxremote.port
設為 7199
通訊埠,請在啟動 JVM 時指定下列項目:
-Dcom.sun.management.jmxremote.port=7199
設定 Cassandra 的作業套件代理程式
按照設定 Ops Agent 的指南新增必要元素,以便從 Cassandra 執行個體收集遙測資料,然後重新啟動代理程式。
範例設定
下列指令會建立設定,收集及擷取 Cassandra 的遙測資料:
請重新啟動 Ops Agent,讓這些變更生效:
Linux
- 如要重新啟動代理程式,請在執行個體上執行下列指令:
sudo systemctl restart google-cloud-ops-agent
- 如要確定代理程式已重新啟動,請執行下列指令,並驗證「指標代理程式」和「Logging 代理程式」元件是否已啟動:
sudo systemctl status "google-cloud-ops-agent*"
Windows
- 使用遠端桌面協定或類似工具連線至執行個體,然後登入 Windows。
- 在 PowerShell 圖示上按一下滑鼠右鍵,然後選取「Run as Administrator」,即可開啟具有系統管理員權限的 PowerShell 終端機。
- 如要重新啟動代理程式,請執行下列 PowerShell 指令:
Restart-Service google-cloud-ops-agent -Force
- 如要確認代理程式已重新啟動,請執行下列指令,並驗證「Metrics Agent」和「Logging Agent」元件是否已啟動:
Get-Service google-cloud-ops-agent*
設定記錄收集
如要擷取 Cassandra 中的記錄,您必須為 Cassandra 產生的記錄建立接收器,然後為新接收器建立管道。
如要為 cassandra_system
記錄設定接收器,請指定下列欄位:
欄位 | 預設 | 說明 |
---|---|---|
exclude_paths |
從 include_paths 比對的集合中排除的檔案系統路徑模式清單。 |
|
include_paths |
[/var/log/cassandra/system*.log] |
檔案尾隨讀取的檔案系統路徑清單。路徑中可使用萬用字元 (* ),例如 /var/log/cassandra/system*.log 。 |
record_log_file_path |
false |
如果設為 true ,則記錄記錄取得的特定檔案路徑會顯示在輸出記錄項目中,做為 agent.googleapis.com/log_file_path 標籤的值。使用萬用字元時,系統只會記錄取得記錄的檔案路徑。 |
type |
這個值必須是 cassandra_system 。 |
|
wildcard_refresh_interval |
60s |
include_paths 中萬用字元檔案路徑的更新間隔。以時間長度表示,例如 30s 或 2m 。在記錄傳送量高的情況下,這個屬性可能會派上用場,因為記錄檔案的輪替時間會比預設間隔更快。 |
如要為 cassandra_debug
記錄設定接收器,請指定下列欄位:
欄位 | 預設 | 說明 |
---|---|---|
exclude_paths |
從 include_paths 比對的集合中排除的檔案系統路徑模式清單。 |
|
include_paths |
[/var/log/cassandra/debug*.log] |
檔案尾隨讀取的檔案系統路徑清單。路徑中可使用萬用字元 (* ),例如 /var/log/cassandra/system*.log 。 |
record_log_file_path |
false |
如果設為 true ,則記錄記錄取得的特定檔案路徑會顯示在輸出記錄項目中,做為 agent.googleapis.com/log_file_path 標籤的值。使用萬用字元時,系統只會記錄取得記錄的檔案路徑。 |
type |
這個值必須是 cassandra_debug 。 |
|
wildcard_refresh_interval |
60s |
include_paths 中萬用字元檔案路徑的更新間隔。以時間長度表示,例如 30s 或 2m 。在記錄傳送量高的情況下,這個屬性可能會派上用場,因為記錄檔案的輪替時間會比預設間隔更快。 |
如要為 cassandra_gc
記錄設定接收器,請指定下列欄位:
欄位 | 預設 | 說明 |
---|---|---|
exclude_paths |
從 include_paths 比對的集合中排除的檔案系統路徑模式清單。 |
|
include_paths |
[/var/log/cassandra/gc.log.*.current] |
檔案尾隨讀取的檔案系統路徑清單。路徑中可使用萬用字元 (* ),例如 /var/log/cassandra/system*.log 。 |
record_log_file_path |
false |
如果設為 true ,則記錄記錄取得的特定檔案路徑會顯示在輸出記錄項目中,做為 agent.googleapis.com/log_file_path 標籤的值。使用萬用字元時,系統只會記錄取得記錄的檔案路徑。 |
type |
這個值必須是 cassandra_gc 。 |
|
wildcard_refresh_interval |
60s |
include_paths 中萬用字元檔案路徑的更新間隔。以時間長度表示,例如 30s 或 2m 。在記錄傳送量高的情況下,這個屬性可能會派上用場,因為記錄檔案的輪替時間會比預設間隔更快。 |
記錄內容
logName
是根據設定中指定的接收器 ID 衍生而來。LogEntry
內部的詳細欄位如下所示。
cassandra_system
記錄包含 LogEntry
中的下列欄位:
欄位 | 類型 | 說明 |
---|---|---|
jsonPayload.javaClass |
字串 | 記錄來源的 Java 類別 |
jsonPayload.level |
字串 | 記錄項目層級 |
jsonPayload.lineNumber |
字串 | 記錄來源的來源檔案行號 |
jsonPayload.message |
字串 | 記錄訊息,包括提供的詳細堆疊追蹤 |
jsonPayload.module |
字串 | 記錄來源的 Cassandra 模組 |
severity |
字串 (LogSeverity ) |
記錄項目層級 (已翻譯)。 |
cassandra_debug
記錄包含 LogEntry
中的下列欄位:
欄位 | 類型 | 說明 |
---|---|---|
jsonPayload.javaClass |
字串 | 記錄來源的 Java 類別 |
jsonPayload.level |
字串 | 記錄項目層級 |
jsonPayload.lineNumber |
字串 | 記錄來源的來源檔案行號 |
jsonPayload.message |
字串 | 記錄訊息 |
jsonPayload.module |
字串 | 記錄來源的 Cassandra 模組 |
severity |
字串 (LogSeverity ) |
記錄項目層級 (已翻譯)。 |
cassandra_gc
記錄包含 LogEntry
中的下列欄位:
欄位 | 類型 | 說明 |
---|---|---|
jsonPayload.level |
字串 | 記錄項目的層級 |
jsonPayload.message |
字串 | 記錄訊息 |
jsonPayload.pid |
字串 | 記錄訊息的 Java 程序程序 ID |
jsonPayload.tid |
字串 | 記錄訊息的 Java 程序的執行緒 ID |
jsonPayload.timeStopped |
字串 | JVM 為進行垃圾收集而停止的秒數 |
jsonPayload.timeStopping |
字串 | JVM 在垃圾收集前停止執行緒所需的秒數 |
jsonPayload.uptime |
字串 | JVM 已啟用秒數 |
severity |
字串 (LogSeverity ) |
記錄項目層級 (已翻譯)。 |
設定指標收集
如要從 Cassandra 擷取指標,您必須為 Cassandra 產生的指標建立接收器,然後為新接收器建立管道。
這個接收器不支援在設定中使用多個執行個體,例如用於監控多個端點。所有這類例項都會寫入相同的時間序列,而 Cloud Monitoring 無法區分這些例項。
如要為 cassandra
指標設定接收器,請指定下列欄位:
欄位 | 預設 | 說明 |
---|---|---|
collect_jvm_metrics |
true |
設定接收器,讓它也收集支援的 JVM 指標。 |
collection_interval |
60s |
時間長度值,例如 30s 或 5m 。 |
endpoint |
localhost:7199 |
用於建構服務網址的 JMX 服務網址或主機和通訊埠。這個值必須採用 service:jmx:<protocol>:<sap> 或 host:port 格式。host:port 格式中的值可用來建立 service:jmx:rmi:///jndi/rmi://<host>:<port>/jmxrmi 的服務網址。 |
password |
如果 JMX 已設定為需要驗證,則為已設定的密碼。 | |
type |
這個值必須是 cassandra 。 |
|
username |
如果 JMX 已設定為需要驗證,則為已設定的使用者名稱。 |
監控的內容
下表列出作業套件代理程式從 Cassandra 執行個體收集的指標。
指標類型 | |
---|---|
類型、類型 受控資源 |
標籤 |
workload.googleapis.com/cassandra.client.request.count
|
|
CUMULATIVE , INT64 gce_instance |
operation
|
workload.googleapis.com/cassandra.client.request.error.count
|
|
CUMULATIVE , INT64 gce_instance |
operation status
|
workload.googleapis.com/cassandra.client.request.range_slice.latency.50p
|
|
GAUGE , DOUBLE gce_instance |
|
workload.googleapis.com/cassandra.client.request.range_slice.latency.99p
|
|
GAUGE , DOUBLE gce_instance |
|
workload.googleapis.com/cassandra.client.request.range_slice.latency.max
|
|
GAUGE , DOUBLE gce_instance |
|
workload.googleapis.com/cassandra.client.request.read.latency.50p
|
|
GAUGE , DOUBLE gce_instance |
|
workload.googleapis.com/cassandra.client.request.read.latency.99p
|
|
GAUGE , DOUBLE gce_instance |
|
workload.googleapis.com/cassandra.client.request.read.latency.max
|
|
GAUGE , DOUBLE gce_instance |
|
workload.googleapis.com/cassandra.client.request.write.latency.50p
|
|
GAUGE , DOUBLE gce_instance |
|
workload.googleapis.com/cassandra.client.request.write.latency.99p
|
|
GAUGE , DOUBLE gce_instance |
|
workload.googleapis.com/cassandra.client.request.write.latency.max
|
|
GAUGE , DOUBLE gce_instance |
|
workload.googleapis.com/cassandra.compaction.tasks.completed
|
|
CUMULATIVE , INT64 gce_instance |
|
workload.googleapis.com/cassandra.compaction.tasks.pending
|
|
GAUGE , INT64 gce_instance |
|
workload.googleapis.com/cassandra.storage.load.count
|
|
GAUGE , INT64 gce_instance |
|
workload.googleapis.com/cassandra.storage.total_hints.count
|
|
CUMULATIVE , INT64 gce_instance |
|
workload.googleapis.com/cassandra.storage.total_hints.in_progress.count
|
|
GAUGE , INT64 gce_instance |
驗證設定
本節說明如何驗證您是否正確設定 Cassandra 接收器。作業套件代理程式可能需要一兩分鐘的時間,才能開始收集遙測資料。
如要確認 Cassandra 記錄是否已傳送至 Cloud Logging,請執行下列步驟:
-
前往 Google Cloud 控制台的「Logs Explorer」頁面:
如果您是使用搜尋列尋找這個頁面,請選取子標題為「Logging」的結果。
- 在編輯器中輸入以下查詢,然後按一下「執行查詢」:
resource.type="gce_instance" (log_id("cassandra_system") OR log_id("cassandra_debug") OR log_id("cassandra_gc"))
如要確認 Cassandra 指標是否已傳送至 Cloud Monitoring,請執行下列操作:
-
前往 Google Cloud 控制台的 leaderboard「Metrics Explorer」頁面:
如果您是使用搜尋列尋找這個頁面,請選取子標題為「Monitoring」的結果。
- 在查詢建構工具窗格的工具列中,選取名稱為 code MQL 或 code PromQL 的按鈕。
- 確認「Language」切換按鈕中已選取「MQL」。語言切換鈕位於可讓您設定查詢格式的工具列中。
- 在編輯器中輸入以下查詢,然後按一下「執行查詢」:
fetch gce_instance | metric 'workload.googleapis.com/cassandra.client.request.count' | every 1m
查看資訊主頁
如要查看 Cassandra 指標,您必須先設定圖表或資訊主頁。Cassandra 整合會提供一或多個資訊主頁。設定整合後,Ops Agent 就會開始收集指標資料,並自動安裝所有資訊主頁。
您也可以不安裝整合功能,查看資訊主頁的靜態預覽畫面。
如要查看已安裝的資訊主頁,請按照下列步驟操作:
-
在 Google Cloud 控制台中,前往「Dashboards」(資訊主頁)
頁面:
如果您是使用搜尋列尋找這個頁面,請選取子標題為「Monitoring」的結果。
- 選取「Dashboard List」分頁標籤,然後選擇「Integrations」類別。
- 按一下要查看的資訊主頁名稱。
如果您已設定整合功能,但未安裝資訊主頁,請檢查作業套件代理程式是否正在執行。如果資訊主頁中沒有圖表的指標資料,則無法安裝資訊主頁。作業套件代理程式開始收集指標後,系統會自動安裝資訊主頁。
如要查看資訊主頁的靜態預覽畫面,請按照下列步驟操作:
-
在 Google Cloud 控制台中,前往「Integrations」(整合) 頁面:
如果您是使用搜尋列尋找這個頁面,請選取子標題為「Monitoring」的結果。
- 按一下「Compute Engine」部署平台篩選器。
- 找出 Cassandra 的項目,然後按一下「查看詳細資料」。
- 選取「資訊主頁」分頁標籤,即可查看靜態預覽畫面。如果已安裝資訊主頁,請按一下「View dashboard」前往該頁面。
如要進一步瞭解 Cloud Monitoring 中的資訊主頁,請參閱「資訊主頁和圖表」。
如要進一步瞭解如何使用「Integrations」頁面,請參閱管理整合。
安裝快訊政策
快訊政策會指示 Cloud Monitoring 在發生特定情況時通知您。Cassandra 整合功能包含一或多項快訊政策供您使用。您可以在 Monitoring 的「Integrations」頁面中查看及安裝這些警示政策。
如要查看可用快訊政策的說明並安裝,請按照下列步驟操作:
-
在 Google Cloud 控制台中,前往「Integrations」(整合) 頁面:
如果您是使用搜尋列尋找這個頁面,請選取子標題為「Monitoring」的結果。
- 找出 Cassandra 的項目,然後按一下「查看詳細資料」。
- 選取「警示」分頁標籤。這個分頁會說明可用的快訊政策,並提供安裝快訊政策的介面。
- 安裝快訊政策。快訊政策需要知道要將已觸發快訊的通知傳送到哪裡,因此需要您提供安裝資訊。如要安裝快訊政策,請按照下列步驟操作:
- 從可用警示政策清單中選取要安裝的政策。
在「設定通知」部分,選取一或多個通知管道。您可以選擇停用通知管道的使用,但這樣一來,警示政策就會靜默觸發。您可以在「監控」中查看狀態,但不會收到通知。
如要進一步瞭解通知管道,請參閱「管理通知管道」。
- 按一下「建立政策」。
如要進一步瞭解 Cloud Monitoring 中的快訊政策,請參閱快訊簡介。
如要進一步瞭解如何使用「Integrations」頁面,請參閱管理整合。
後續步驟
如需有關如何使用 Ansible 安裝作業套件代理程式、設定第三方應用程式,以及安裝範例資訊主頁的教學影片,請參閱「 安裝作業套件代理程式以排解第三方應用程式的問題」影片。