ScyllaDB

Questo documento descrive come configurare il deployment di Google Kubernetes Engine in modo da poter utilizzare il servizio gestito Google Cloud per Prometheus per raccogliere le metriche dall'esportatore ScyllaDB. Questo documento illustra come:

  • Configura l'esportatore ScyllaDB per generare report sulle metriche.
  • Configura una risorsa PodMonitoring per Managed Service per Prometheus per raccogliere le metriche esportate.
  • Accedi a una dashboard in Cloud Monitoring per visualizzare le metriche.
  • Configura le regole di avviso per monitorare le metriche.

Queste istruzioni sono valide solo se utilizzi raccolta gestita con Managed Service per Prometheus. Se utilizzi una raccolta di cui è stato eseguito il deployment autonomo, controlla Documentazione di SyllaDB per informazioni sull'installazione.

Queste istruzioni sono fornite a titolo di esempio e dovrebbero funzionare in la maggior parte degli ambienti Kubernetes. Se hai difficoltà a installare un'applicazione o un esportatore a causa di criteri di sicurezza o organizzativi restrittivi, ti consigliamo di consultare la documentazione open source per ricevere assistenza.

Per informazioni su ScyllaDB, consulta ScyllaDB.

Prerequisiti

Per raccogliere metriche da l'utilità di esportazione ScyllaDB utilizzando Managed Service per Prometheus e la raccolta gestita, il deployment deve devono soddisfare i seguenti requisiti:

  • Nel cluster deve essere in esecuzione la versione di Google Kubernetes Engine 1.21.4-gke.300 o versioni successive.
  • Devi eseguire Managed Service per Prometheus con la raccolta gestita abilitata. Per ulteriori informazioni, vedi Inizia a utilizzare la raccolta gestita.

  • Per utilizzare le dashboard disponibili in Cloud Monitoring per integrazione di ScyllaDB, devi utilizzare scylladb_monitoring_stack versione 5.0 o successive.

    Per ulteriori informazioni sulle dashboard disponibili, consulta Visualizza dashboard.

Modifica la configurazione di ScyllaDB

Modifica la configurazione di ScyllaDB come mostrato nell'esempio seguente:

# Copyright 2023 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

apiVersion: apps/v1
kind: Deployment
metadata:
  name: scylladb
spec:
  selector:
    matchLabels:
      app.kubernetes.io/name: scylladb
  template:
    metadata:
      labels:
        app.kubernetes.io/name: scylladb
    spec:
      containers:
      - name: scylladb
        image: scylladb/scylla:5.0.5
+       ports:
+       - containerPort: 9180
+         name: prometheus

Devi aggiungere eventuali righe precedute dal simbolo + alla configurazione.

Per applicare le modifiche alla configurazione da un file locale, esegui questo comando: 

kubectl apply -n NAMESPACE_NAME -f FILE_NAME

Puoi anche utilizzare Terraform per gestire le configurazioni.

Definisci una risorsa PodMonitoring

Per il rilevamento del target, l'operatore Managed Service per Prometheus richiede una risorsa PodMonitoring che corrisponda Esportatore ScyllaDB nello stesso spazio dei nomi.

Puoi utilizzare la seguente configurazione di PodMonitoring:

# Copyright 2023 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

apiVersion: monitoring.googleapis.com/v1
kind: PodMonitoring
metadata:
  name: scylladb
  labels:
    app.kubernetes.io/name: scylladb
    app.kubernetes.io/part-of: google-cloud-managed-prometheus
spec:
  endpoints:
  - port: prometheus
    interval: 30s
    path: /metrics
  selector:
    matchLabels:
      app.kubernetes.io/name: scylladb

Per applicare le modifiche alla configurazione da un file locale, esegui il seguente comando: 

kubectl apply -n NAMESPACE_NAME -f FILE_NAME

Puoi anche utilizza Terraform per gestire le configurazioni.

Definisci regole e avvisi

Puoi utilizzare la seguente configurazione di Rules per definire avvisi sulle metriche ScyllaDB:

# Copyright 2023 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

apiVersion: monitoring.googleapis.com/v1
kind: Rules
metadata:
  name: scylladb-rules
  labels:
    app.kubernetes.io/component: rules
    app.kubernetes.io/name: scylladb-rules
    app.kubernetes.io/part-of: google-cloud-managed-prometheus
spec:
  groups:
  - name: scylladb
    interval: 30s
    rules:
    - alert: ScyllaDBHighCompactionLoad
      annotations:
        description: |-
          ScyllaDB high compaction load
            VALUE = {{ $value }}
            LABELS: {{ $labels }}
        summary: ScyllaDB high compaction load (instance {{ $labels.instance }})
      expr: scylla_scheduler_shares{group="compaction"} >= 1000
      for: 5m
      labels:
        severity: critical
    - alert: ScyllaDBHighPreparedStatementEvictionRate
      annotations:
        description: |-
          ScyllaDB high prepared statement eviction rate
            VALUE = {{ $value }}
            LABELS: {{ $labels }}
        summary: ScyllaDB high prepared statement eviction rate (instance {{ $labels.instance }})
      expr: (scylla_cql_prepared_cache_evictions + scylla_cql_authorized_prepared_statements_cache_evictions) > 100
      for: 5m
      labels:
        severity: warning

Per applicare le modifiche alla configurazione da un file locale, esegui il seguente comando: 

kubectl apply -n NAMESPACE_NAME -f FILE_NAME

Puoi anche utilizzare Terraform per gestire le configurazioni.

Per ulteriori informazioni sull'applicazione delle regole al cluster, consulta Valutazione e generazione di avvisi delle regole gestite.

Puoi regolare le soglie di avviso in base alla tua applicazione.

Verificare la configurazione

Puoi utilizzare Esplora metriche per verificare di aver configurato correttamente l'esportatore ScyllaDB. Potrebbero essere necessari uno o due minuti Cloud Monitoring per importare le tue metriche.

Per verificare che le metriche siano importate, procedi nel seguente modo:

  1. Nella console Google Cloud, vai alla pagina  Esplora metriche:

    Vai a Esplora metriche

    Se utilizzi la barra di ricerca per trovare questa pagina, seleziona il risultato con il sottotitolo Monitoring.

  2. Nella barra degli strumenti della riquadro Query Builder, seleziona il pulsante con  MQL o  PromQL.
  3. Verifica che PromQL sia selezionato nel pulsante di attivazione/disattivazione Lingua. Il pulsante di attivazione/disattivazione della lingua si trova nella stessa barra degli strumenti. consente di formattare la query.
  4. Inserisci ed esegui la seguente query:
    up{job="scylladb", cluster="CLUSTER_NAME", namespace="NAMESPACE_NAME"}

Visualizza dashboard

L'integrazione di Cloud Monitoring include la dashboard Panoramica di ScyllaDB Prometheus. Le dashboard vengono installate automaticamente quando configuri l'integrazione. Puoi anche visualizzare anteprime statiche delle dashboard senza installare l'integrazione.

Per visualizzare una dashboard installata:

  1. Nella console Google Cloud, vai alla pagina  Dashboard:

    Vai a Dashboard

    Se utilizzi la barra di ricerca per trovare questa pagina, seleziona il risultato con il sottotitolo Monitoring.

  2. Seleziona la scheda Elenco dashboard.
  3. Scegli la categoria Integrazioni.
  4. Fai clic sul nome della dashboard, ad esempio Panoramica di SyllaDB Prometheus.

Per visualizzare un'anteprima statica della dashboard:

  1. Nella console Google Cloud, vai alla  Integrazioni pagina:

    Vai a Integrazioni

    Se utilizzi la barra di ricerca per trovare questa pagina, seleziona il risultato con il sottotitolo Monitoring.

  2. Fai clic sul filtro della piattaforma di deployment Kubernetes Engine.
  3. Individua l'integrazione di ScyllaDB e fai clic su Visualizza dettagli.
  4. Seleziona la scheda Dashboard.

Risoluzione dei problemi

Per informazioni sulla risoluzione dei problemi di importazione delle metriche, consulta Problemi con la raccolta dagli esportatori in Risoluzione dei problemi lato importazione.