ScyllaDB

En este documento, se describe cómo configurar tu implementación de Google Kubernetes Engine a fin de que puedas usar Google Cloud Managed Service para Prometheus para recopilar métricas de ScyllaDB. Este documento te muestra cómo hacer lo siguiente:

  • Configurar ScyllaDB para informar métricas
  • Acceder a un panel predefinido en Cloud Monitoring para ver las métricas
  • Configura reglas de alerta para supervisar las métricas

Estas instrucciones se aplican solo si usas la colección administrada con Managed Service para Prometheus. Si usas la colección implementada de forma automática, consulta la documentación de ScyllaDB para obtener información sobre la instalación.

Estas instrucciones se proporcionan como ejemplo y se espera que funcionen en la mayoría de los entornos de Kubernetes. Si tienes problemas para instalar una aplicación o un exportador debido a políticas restringidas de la organización o de seguridad, te recomendamos que consultes la documentación de código abierto a fin de obtener asistencia.

Para obtener información sobre ScyllaDB, consulta ScyllaDB.

Requisitos previos

Para recopilar métricas del exportador de ScyllaDB mediante Managed Service para Prometheus y la colección administrada, tu implementación debe cumplir con los siguientes requisitos:

  • Tu clúster debe ejecutar la versión 1.28.15-gke.2475000 o posterior de Google Kubernetes Engine.
  • Debes ejecutar Managed Service para Prometheus con la colección administrada habilitada. Para obtener más información, consulta Primeros pasos con la recopilación administrada.

  • Si deseas usar los paneles disponibles en Cloud Monitoring para la integración de ScyllaDB, debes usar la versión 5.0 o una posterior de scylladb_monitoring_stack.

    Para obtener más información sobre los paneles disponibles, consulta Visualiza los paneles.

Modifica la configuración de ScyllaDB

Modifica la configuración de ScyllaDB como se muestra en el siguiente ejemplo:

# 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

Debes agregar cualquier línea precedida por el símbolo + a la configuración.

Para aplicar los cambios de configuración desde un archivo local, ejecuta el siguiente comando: 

 kubectl apply -n NAMESPACE_NAME -f FILE_NAME

También puedes usar Terraform para administrar tus opciones de configuración.

Define un recurso PodMonitoring

Para el descubrimiento de destinos, el operador de Managed Service para Prometheus requiere un recurso PodMonitoring que corresponda al exportador de ScyllaDB en el mismo espacio de nombres.

Puedes usar la siguiente configuración de 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

Para aplicar cambios de configuración desde un archivo local, ejecuta el siguiente comando: 

 kubectl apply -n NAMESPACE_NAME -f FILE_NAME

También puedes usar Terraform para administrar tus opciones de configuración.

Define reglas y alertas

Puedes usar la siguiente configuración Rules para definir alertas en las métricas de 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

Para aplicar cambios de configuración desde un archivo local, ejecuta el siguiente comando: 

 kubectl apply -n NAMESPACE_NAME -f FILE_NAME

También puedes usar Terraform para administrar tus opciones de configuración.

Para obtener más información sobre cómo aplicar reglas a tu clúster, consulta Evaluación y alertas de reglas administradas.

Puedes ajustar los umbrales de las alertas para que se adapten a tu aplicación.

Verifica la configuración

Puedes usar el Explorador de métricas para verificar que configuraste correctamente el exportador de ScyllaDB. Cloud Monitoring puede tardar uno o dos minutos en transferir las métricas.

Para verificar que se hayan transferido las métricas, haz lo siguiente:

  1. En la consola de Google Cloud , accede a la página  Explorador de métricas:

    Acceder al Explorador de métricas

    Si usas la barra de búsqueda para encontrar esta página, selecciona el resultado cuyo subtítulo es Monitoring.

  2. En la barra de herramientas del panel del compilador de consultas, selecciona el botón cuyo nombre es  MQL o  PromQL.
  3. Verifica que PromQL esté seleccionado en el botón de activación Lenguaje. El botón de activación de lenguaje se encuentra en la misma barra de herramientas que permite dar formato a la consulta.
  4. Ingresa y ejecuta la siguiente consulta:
    up{job="scylladb", cluster="CLUSTER_NAME", namespace="NAMESPACE_NAME"}

Ver paneles

La integración de Cloud Monitoring incluye el panel ScyllaDB Prometheus Overview. Los paneles se instalan automáticamente cuando configuras la integración. También puedes ver vistas previas estáticas de los paneles sin instalar la integración.

Para ver un panel instalado, haz lo siguiente:

  1. En la consola de Google Cloud , accede a la página Paneles :

    Acceder a Paneles

    Si usas la barra de búsqueda para encontrar esta página, selecciona el resultado cuyo subtítulo es Monitoring.

  2. Selecciona la pestaña Lista de paneles.
  3. Elige la categoría Integraciones.
  4. Haga clic en el nombre del panel, por ejemplo, ScyllaDB Prometheus Overview.

Para obtener una vista previa estática del panel, haz lo siguiente:

  1. En la consola de Google Cloud , accede a la página Integraciones :

    Acceder a Integraciones

    Si usas la barra de búsqueda para encontrar esta página, selecciona el resultado cuyo subtítulo es Monitoring.

  2. Haz clic en el filtro de la plataforma de implementación Kubernetes Engine.
  3. Ubica la integración de ScyllaDB y haz clic en Ver detalles.
  4. Selecciona la pestaña Paneles.

Soluciona problemas

Para obtener información sobre la solución de problemas de transferencia de métricas, consulta Problemas de recopilación de exportadores en Solución de problemas de transferencia.