Die Apache Cassandra-Integration erfasst Anfrage-, Aufgaben- und Speichermesswerte, die die Auslastung einer Instanz hervorheben. Optional kann die Integration auch allgemeine JVM-Messwerte in Bezug auf Speicher und automatischer Speicherbereinigung erfassen. Durch die Integration werden auch System-, Debug- und automatische Speicherlogs erfasst. Diese Logs werden in eine JSON-Nutzlast geparst, die Felder für die Nachricht, die Java-Klasse und die Zeilennummer enthält.
Weitere Informationen zu Cassandra finden Sie in der Apache Cassandra-Dokumentation.
Vorbereitung
Zum Erfassen von Cassandra-Telemetriedaten müssen Sie den Ops-Agent installieren:
- Installieren Sie für Messwerte die Version 2.6.0 oder höher.
- Installieren Sie für Logs die Version 2.5.0 oder höher.
Diese Integration unterstützt die Cassandra-Versionen 3.11 und 4.0.
Cassandra-Instanz konfigurieren
Wenn Sie einen JMX-Endpunkt verfügbar machen möchten, müssen Sie beim Starten der JVM das Systemattribut com.sun.management.jmxremote.port festlegen. Außerdem empfehlen wir, das Systemattribut com.sun.management.jmxremote.rmi.port auf denselben Port festzulegen. Wenn Sie einen JMX-Endpunkt remote verfügbar machen möchten, müssen Sie auch das Systemattribut java.rmi.server.hostname festlegen.
Standardmäßig werden diese Attribute in der Datei cassandra-env.sh einer Cassandra-Bereitstellung festgelegt.
Wenn Sie Systemattribute mithilfe von Befehlszeilenargumenten festlegen möchten, stellen Sie beim Starten der JVM dem Attributnamen -D voran. Wenn Sie beispielsweise com.sun.management.jmxremote.port auf den Port 7199 festlegen möchten, geben Sie beim Starten der JVM Folgendes an:
-Dcom.sun.management.jmxremote.port=7199
Ops Agent für Cassandra konfigurieren
Fügen Sie die erforderlichen Elemente zum Erfassen von Telemetriedaten aus den Cassandra-Instanzen gemäß der Anleitung unter Ops-Agent konfigurieren hinzu und starten Sie den Agent neu.
Konfigurationsbeispiel
Mit den folgenden Befehlen wird die Konfiguration zum Erfassen und Aufnehmen von Telemetriedaten für Cassandra erstellt und der Ops-Agent neu gestartet.
# Configures Ops Agent to collect telemetry from the app and restart Ops Agent.
set -e
# 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:
cassandra:
type: cassandra
endpoint: service:jmx:rmi:///jndi/rmi://127.0.0.1:7199/jmxrmi
service:
pipelines:
cassandra:
receivers:
- cassandra
logging:
receivers:
cassandra_system:
type: cassandra_system
cassandra_debug:
type: cassandra_debug
cassandra_gc:
type: cassandra_gc
service:
pipelines:
cassandra:
receivers:
- cassandra_system
- cassandra_debug
- cassandra_gc
EOF
sudo service google-cloud-ops-agent restart
sleep 60
In diesem Beispiel wurden die Systemattribute com.sun.management.jmxremote.port und com.sun.management.jmxremote.rmi.port auf 7199 und das Systemattribut java.rmi.server.hostname auf 127.0.0.1 festgelegt. Weitere Informationen finden Sie unter Messwerterfassung konfigurieren.
Logerfassung konfigurieren
Um Logs von Cassandra aufzunehmen, müssen Sie Empfänger für die von Cassandra erzeugten Logs erstellen und dann eine Pipeline für die neuen Empfänger erstellen.
Geben Sie die folgenden Felder an, um einen Empfänger für Ihre cassandra_system-Logs zu konfigurieren:
| Feld | Standard | Beschreibung |
|---|---|---|
exclude_paths |
Eine Liste von Dateisystempfadmustern, die aus dem mit include_paths übereinstimmenden Satz ausgeschlossen werden sollen. |
|
include_paths |
[/var/log/cassandra/system*.log] |
Eine Liste mit Dateisystempfaden, die durch Tailing jeder Datei gelesen werden sollen. In den Pfaden kann ein Platzhalter (*) verwendet werden. Beispiel: /var/log/cassandra/system*.log. |
record_log_file_path |
false |
Wenn true festgelegt ist, wird der Pfad zu der spezifischen Datei, aus der der Logdatensatz abgerufen wurde, im Ausgabelogeintrag als Wert des Labels agent.googleapis.com/log_file_path angezeigt. Bei Verwendung eines Platzhalters wird nur der Pfad der Datei aufgezeichnet, aus der der Eintrag abgerufen wurde. |
type |
Der Wert muss cassandra_system betragen. |
|
wildcard_refresh_interval |
60s |
Das Intervall, in dem Platzhalterdateipfade in include_paths aktualisiert werden. Wird als Zeitdauer angegeben, die mit time.ParseDuration analysiert werden kann, z. B. 30s oder 2m. Dieses Attribut kann bei hohen Logging-Durchsätzen nützlich sein, wenn Logdateien schneller als das Standardintervall rotiert werden. |
Geben Sie die folgenden Felder an, um einen Empfänger für Ihre cassandra_debug-Logs zu konfigurieren:
| Feld | Standard | Beschreibung |
|---|---|---|
exclude_paths |
[] |
Eine Liste von Dateisystempfadmustern, die aus dem mit include_paths übereinstimmenden Satz ausgeschlossen werden sollen. |
include_paths |
[/var/log/cassandra/debug*.log] |
Eine Liste mit Dateisystempfaden, die durch Tailing jeder Datei gelesen werden sollen. In den Pfaden kann ein Platzhalter (*) verwendet werden. Beispiel: /var/log/cassandra/system*.log. |
record_log_file_path |
false |
Wenn true festgelegt ist, wird der Pfad zu der spezifischen Datei, aus der der Logdatensatz abgerufen wurde, im Ausgabelogeintrag als Wert des Labels agent.googleapis.com/log_file_path angezeigt. Bei Verwendung eines Platzhalters wird nur der Pfad der Datei aufgezeichnet, aus der der Eintrag abgerufen wurde. |
type |
Der Wert muss cassandra_debug betragen. |
|
wildcard_refresh_interval |
60s |
Das Intervall, in dem Platzhalterdateipfade in include_paths aktualisiert werden. Wird als Zeitdauer angegeben, die mit time.ParseDuration analysiert werden kann, z. B. 30s oder 2m. Dieses Attribut kann bei hohen Logging-Durchsätzen nützlich sein, wenn Logdateien schneller als das Standardintervall rotiert werden. |
Geben Sie die folgenden Felder an, um einen Empfänger für Ihre cassandra_gc-Logs zu konfigurieren:
| Feld | Standard | Beschreibung |
|---|---|---|
exclude_paths |
[] |
Eine Liste von Dateisystempfadmustern, die aus dem mit include_paths übereinstimmenden Satz ausgeschlossen werden sollen. |
include_paths |
[/var/log/cassandra/gc.log.*.current] |
Eine Liste mit Dateisystempfaden, die durch Tailing jeder Datei gelesen werden sollen. In den Pfaden kann ein Platzhalter (*) verwendet werden. Beispiel: /var/log/cassandra/system*.log. |
record_log_file_path |
false |
Wenn true festgelegt ist, wird der Pfad zu der spezifischen Datei, aus der der Logdatensatz abgerufen wurde, im Ausgabelogeintrag als Wert des Labels agent.googleapis.com/log_file_path angezeigt. Bei Verwendung eines Platzhalters wird nur der Pfad der Datei aufgezeichnet, aus der der Eintrag abgerufen wurde. |
type |
Der Wert muss cassandra_gc betragen. |
|
wildcard_refresh_interval |
60s |
Das Intervall, in dem Platzhalterdateipfade in include_paths aktualisiert werden. Wird als Zeitdauer angegeben, die mit time.ParseDuration analysiert werden kann, z. B. 30s oder 2m. Dieses Attribut kann bei hohen Logging-Durchsätzen nützlich sein, wenn Logdateien schneller als das Standardintervall rotiert werden. |
Was wird protokolliert?
Der logName wird von den Empfänger-IDs abgeleitet, die in der Konfiguration angegeben sind. Detaillierte Felder in LogEntry sind:
Logeinträge enthalten keine leeren oder fehlenden Felder.
cassandra_system-Logs enthalten die folgenden Felder in LogEntry:
| Feld | Typ | Beschreibung |
|---|---|---|
jsonPayload.javaClass |
String | Java-Klasse, von der das Log stammt |
jsonPayload.level |
String | Logeintragsebene |
jsonPayload.lineNumber |
String | Zeilennummer der Quelldatei, von der das Log stammt |
jsonPayload.message |
String | Lognachricht, einschließlich eines detaillierten Stacktrace, sofern angegeben |
jsonPayload.module |
String | Modul von Cassandra, von dem das Log stammt |
severity |
String (LogSeverity) |
Ebene des Logeintrags (übersetzt) |
cassandra_debug-Logs enthalten die folgenden Felder in LogEntry:
| Feld | Typ | Beschreibung |
|---|---|---|
jsonPayload.javaClass |
String | Java-Klasse, von der das Log stammt |
jsonPayload.level |
String | Logeintragsebene |
jsonPayload.lineNumber |
String | Zeilennummer der Quelldatei, von der das Log stammt |
jsonPayload.message |
String | Log-Nachricht |
jsonPayload.module |
String | Modul von Cassandra, von dem das Log stammt |
severity |
String (LogSeverity) |
Ebene des Logeintrags (übersetzt) |
cassandra_gc-Logs enthalten die folgenden Felder in LogEntry:
| Feld | Typ | Beschreibung |
|---|---|---|
jsonPayload.message |
String | Log-Nachricht |
jsonPayload.timeStopped |
String | Anzahl der Sekunden, für die die JVM für die automatische Speicherbereinigung angehalten wurde |
jsonPayload.timeStopping |
String | Anzahl der Sekunden, die die JVM brauchte, um Threads vor der automatischen Speicherbereinigung anzuhalten |
jsonPayload.uptime |
String | Anzahl der Sekunden, für die die JVM aktiv war |
severity |
String (LogSeverity) |
Ebene des Logeintrags (übersetzt) |
Messwerterfassung konfigurieren
Um Messwerte von Cassandra aufzunehmen, müssen Sie einen Empfänger für die von Cassandra erzeugten Messwerte erstellen und dann eine Pipeline für den neuen Empfänger erstellen.
Dieser Empfänger unterstützt die Verwendung mehrerer Instanzen in der Konfiguration, z. B. zum Überwachen mehrerer Endpunkte, nicht. Alle diese Instanzen schreiben in dieselbe Zeitachse und Cloud Monitoring kann sie nicht unterscheiden.
Um einen Empfänger für Ihre cassandra-Messwerte zu konfigurieren, geben Sie die folgenden Felder an:
| Feld | Standard | Beschreibung |
|---|---|---|
collect_jvm_metrics |
true |
Konfiguriert den Empfänger so, dass auch die unterstützten JVM-Messwerte erfasst werden. |
collection_interval |
60s |
Ein Wert für die Zeitdauer, z. B. 30s oder 5m. |
endpoint |
localhost:7199 |
Die JMX-Dienst-URL oder der Host und Port, die zum Erstellen der Dienst-URL verwendet werden. Dieser Wert muss das Format service:jmx:<protocol>:<sap> oder host:port haben. Werte im Format host:port werden für das Erstellen der Dienst-URL service:jmx:rmi:///jndi/rmi://<host>:<port>/jmxrmi verwendet. |
password |
Das konfigurierte Passwort, wenn JMX für eine erforderliche Authentifizierung konfiguriert ist. | |
type |
Der Wert muss cassandra betragen. |
|
username |
Der konfigurierte Nutzername, wenn JMX für eine erforderliche Authentifizierung konfiguriert ist. |
Was wird überwacht?
Die folgende Tabelle enthält die Liste der Messwerte, die der Ops-Agent aus der Cassandra-Instanz erfasst.
| Messwerttyp | |
|---|---|
| Art, Typ Überwachte Ressourcen |
Label |
workload.googleapis.com/cassandra.client.request.count
|
|
CUMULATIVE, INT64gce_instance |
operation
|
workload.googleapis.com/cassandra.client.request.error.count
|
|
CUMULATIVE, INT64gce_instance |
operation
status
|
workload.googleapis.com/cassandra.client.request.range_slice.latency.50p
|
|
GAUGE, DOUBLEgce_instance |
|
workload.googleapis.com/cassandra.client.request.range_slice.latency.99p
|
|
GAUGE, DOUBLEgce_instance |
|
workload.googleapis.com/cassandra.client.request.range_slice.latency.max
|
|
GAUGE, DOUBLEgce_instance |
|
workload.googleapis.com/cassandra.client.request.read.latency.50p
|
|
GAUGE, DOUBLEgce_instance |
|
workload.googleapis.com/cassandra.client.request.read.latency.99p
|
|
GAUGE, DOUBLEgce_instance |
|
workload.googleapis.com/cassandra.client.request.read.latency.max
|
|
GAUGE, DOUBLEgce_instance |
|
workload.googleapis.com/cassandra.client.request.write.latency.50p
|
|
GAUGE, DOUBLEgce_instance |
|
workload.googleapis.com/cassandra.client.request.write.latency.99p
|
|
GAUGE, DOUBLEgce_instance |
|
workload.googleapis.com/cassandra.client.request.write.latency.max
|
|
GAUGE, DOUBLEgce_instance |
|
workload.googleapis.com/cassandra.compaction.tasks.completed
|
|
CUMULATIVE, INT64gce_instance |
|
workload.googleapis.com/cassandra.compaction.tasks.pending
|
|
GAUGE, INT64gce_instance |
|
workload.googleapis.com/cassandra.storage.load.count
|
|
GAUGE, INT64gce_instance |
|
workload.googleapis.com/cassandra.storage.total_hints.count
|
|
CUMULATIVE, INT64gce_instance |
|
workload.googleapis.com/cassandra.storage.total_hints.in_progress.count
|
|
GAUGE, INT64gce_instance |
|
Konfiguration prüfen
In diesem Abschnitt wird beschrieben, wie Sie prüfen können, ob Sie den Cassandra-Empfänger richtig konfiguriert haben. Es kann ein oder zwei Minuten dauern, bis der Ops-Agent Telemetriedaten erfasst.
So prüfen Sie, ob Cassandra-Logs an Cloud Logging gesendet werden:
-
Wählen Sie im Navigationsbereich der Google Cloud Console Logging und anschließend Log-Explorer aus:
- Geben Sie im Editor die folgende Abfrage ein und klicken Sie dann auf Abfrage ausführen:
resource.type="gce_instance" (log_id("cassandra_system") OR log_id("cassandra_debug") OR log_id("cassandra_gc"))
So prüfen Sie, ob Cassandra-Messwerte an Cloud Monitoring gesendet werden:
-
Wählen Sie im Navigationsbereich der Google Cloud Console Monitoring und anschließend leaderboard Metrics Explorer aus:
- Klicken Sie in der Symbolleiste des Bereichs "Query Builder" auf die Schaltfläche code MQL oder code PromQL.
- Prüfen Sie, ob MQL im Schalter Sprache ausgewählt ist. Die Sprachschaltfläche befindet sich in derselben Symbolleiste, mit der Sie Ihre Abfrage formatieren können.
- Geben Sie im Editor die folgende Abfrage ein und klicken Sie dann auf Abfrage ausführen:
fetch gce_instance | metric 'workload.googleapis.com/cassandra.client.request.count' | every 1m
Dashboard aufrufen
Damit Sie Ihre Cassandra-Messwerte aufrufen können, müssen Sie ein Diagramm oder ein Dashboard konfiguriert haben. Die Cassandra-Integration umfasst ein oder mehrere Dashboards. Alle Dashboards werden automatisch installiert, nachdem Sie die Integration konfiguriert haben und der Ops-Agent mit dem Erfassen von Messwertdaten begonnen hat.
Sie können auch eine statische Vorschau von Dashboards aufrufen, ohne die Integration zu installieren.
So rufen Sie ein installiertes Dashboard auf:
-
Wählen Sie im Navigationsbereich der Google Cloud Console Monitoring und anschließend
Dashboards aus:
- Wählen Sie den Tab Dashboard-Liste und dann die Kategorie Integrationen aus.
- Wählen Sie den Namen des Dashboards aus, das Sie aufrufen möchten.
Wenn Sie eine Integration konfiguriert haben, das Dashboard jedoch nicht installiert ist, prüfen Sie, ob der Ops-Agent ausgeführt wird. Wenn im Dashboard keine Messwertdaten für ein Diagramm vorhanden sind, schlägt die Installation des Dashboards fehl. Nachdem der Ops-Agent mit dem Erfassen von Messwerten begonnen hat, wird das Dashboard für Sie installiert.
So rufen Sie eine statische Vorschau des Dashboards auf:
-
Wählen Sie im Navigationsbereich der Google Cloud Console Monitoring und anschließend
Integrationen aus:
- Klicken Sie auf den Filter für die Deployment-Plattform Compute Engine.
- Suchen Sie den Eintrag für Cassandra und klicken Sie auf Details ansehen.
- Wählen Sie den Tab Dashboards aus, um eine statische Vorschau aufzurufen. Wenn das Dashboard installiert ist, können Sie es aufrufen. Klicken Sie dazu auf Dashboard aufrufen.
Weitere Informationen zu Dashboards in Cloud Monitoring finden Sie unter Dashboards und Diagramme.
Weitere Informationen zur Verwendung der Seite Integrationen finden Sie unter Integrationen verwalten.
Benachrichtigungsrichtlinien installieren
Durch Benachrichtigungsrichtlinien wird Cloud Monitoring angewiesen, Sie zu benachrichtigen, wenn bestimmte Bedingungen auftreten. Die Cassandra-Integration umfasst eine oder mehrere Benachrichtigungsrichtlinien, die Sie verwenden können. Sie können diese Benachrichtigungsrichtlinien auf der Seite Integrationen in Monitoring aufrufen und installieren.
So zeigen Sie die Beschreibungen der verfügbaren Benachrichtigungsrichtlinien an und installieren sie:
-
Wählen Sie im Navigationsbereich der Google Cloud Console Monitoring und anschließend
Integrationen aus:
- Suchen Sie den Eintrag für Cassandra und klicken Sie auf Details ansehen.
- Wählen Sie den Tab Benachrichtigungen aus. Dieser Tab enthält Beschreibungen der verfügbaren Benachrichtigungsrichtlinien und eine Oberfläche für deren Installation.
- Installieren Sie Benachrichtigungsrichtlinien. Benachrichtigungsrichtlinien müssen wissen, wohin Benachrichtigungen gesendet werden sollen, dass die Benachrichtigung ausgelöst wurde. Daher benötigen sie Informationen von Ihnen für die Installation.
So installieren Sie Benachrichtigungsrichtlinien:
- Wählen Sie aus der Liste der verfügbaren Benachrichtigungsrichtlinien die Richtlinien aus, die Sie installieren möchten.
Wählen Sie im Abschnitt Benachrichtigungen konfigurieren einen oder mehrere Benachrichtigungskanäle aus. Sie haben die Möglichkeit, die Verwendung von Benachrichtigungskanälen zu deaktivieren. In diesem Fall werden Ihre Benachrichtigungsrichtlinien jedoch automatisch ausgelöst. Sie können ihren Status in Monitoring prüfen, aber Sie erhalten keine Benachrichtigungen.
Weitere Informationen zu Benachrichtigungskanälen finden Sie unter Benachrichtigungskanäle verwalten.
- Klicken Sie auf Richtlinien erstellen.
Weitere Informationen zu Benachrichtigungsrichtlinien in Cloud Monitoring finden Sie unter Einführung in Benachrichtigungen.
Weitere Informationen zur Verwendung der Seite Integrationen finden Sie unter Integrationen verwalten.
Nächste Schritte
Eine Anleitung zur Installation von Ops-Agent mit Ansible zum Konfigurieren einer Drittanbieteranwendung und zum Installieren eines Beispieldashboards finden Sie im Video Ops-Agent installieren, um Fehler in Drittanbieteranwendungen zu beheben.