Comenzar a usar Key Visualizer

En esta página, se describe cómo usar Key Visualizer para verificar los problemas de rendimiento relacionados con los patrones de uso de Firestore.

Antes de comenzar

Para usar Key Visualizer para Firestore, debes habilitar la Firestore Key Visualizer API.

Enable the API

Roles obligatorios

Asegúrate de que tu cuenta tenga uno de los siguientes roles de IAM:

  • Propietario de Cloud Datastore
  • Visualizador de Key Visualizer de Cloud Datastore
  • Editor
  • Propietario

Estos roles incluyen los siguientes permisos de IAM que son necesarios para acceder a Key Visualizer:

  • datastore.keyVisualizerScans.get
  • datastore.keyVisualizerScans.list
  • datastore.databases.getMetadata
  • resourcemanager.projects.get

También puedes definir un rol personalizado con los permisos necesarios.

Visualiza un análisis de un período

Cada análisis de Key Visualizer abarca un período de dos horas. Un análisis de un período determinado está disponible para las bases de datos con un tráfico que supera las 3,000 operaciones de documentos en cualquier minuto de ese período.

Para iniciar Key Visualizer, haz lo siguiente:

  1. En la consola de Google Cloud, ve a la página Bases de datos.

    Ir a Bases de datos

  2. Selecciona la base de datos requerida de la lista.

  3. En el menú de navegación, haz clic en Key Visualizer.

  4. Selecciona un período y una métrica de los análisis de Key Visualizer disponibles:

    1. Haz clic en el ícono de lápiz en la esquina superior derecha. Selecciona una Fecha y un Intervalo de tiempo.

      Los análisis están disponibles según la elegibilidad para el análisis. No puedes seleccionar períodos que no cumplan con los requisitos de elegibilidad para la búsqueda o que aún se estén tratando. Los dos análisis más recientes del día tardarán un poco en procesarse antes de estar disponibles.

    2. Selecciona Todos los datos de documentos o Todos los datos de índices como fuente.

    3. Haz clic en Actualizar.

  5. Selecciona una métrica para analizar:

    Haz clic en el menú desplegable de métricas en la parte superior izquierda y selecciona una métrica para verla. Key Visualizer se abre en la métrica Operaciones por segundo para las claves de documentos y la métrica Operaciones de escritura en el índice por segundo para las claves de índice de forma predeterminada.

Para comparar métricas o buscar correlaciones entre los datos, puedes mostrar varias métricas de Key Visualizer juntas. Consulta Cómo encontrar conexiones entre diferentes métricas.

Cómo ver la descripción general de una actividad

Para obtener una descripción general de la actividad durante el período seleccionado de dos horas, revisa el mapa de calor de la métrica predeterminada.

En el siguiente ejemplo, se muestra un mapa de calor que contiene las diferencias principales del patrón de uso de los distintos rangos de claves:

  • Los rangos que se muestran en colores oscuros tienen muy poca actividad o nada.
  • Los rangos que se muestran en colores brillantes tienen más actividad.
  • El rango de color blanco brillante del medio tiene un nivel de actividad muy alto.

Ejemplo de un análisis de Key Visualizer

Escaneo de claves de documentos

La métrica Operaciones por segundo mide la cantidad de solicitudes por segundo para cada rango de claves. Esta métrica es la suma de las solicitudes de escritura, búsqueda y consulta. En Key Visualizer, esta métrica se muestra de forma predeterminada cuando abres un mapa de calor.

Después de tener una idea de la actividad general en tu base de datos, puedes continuar con la investigación analizando otras métricas y enfocándote en los rangos clave que podrían estar causando problemas. Más información

Análisis de claves de índice

La métrica Index Write Ops/s en una celda determinada mide las operaciones de escritura de índice promedio por segundo dentro del intervalo de tiempo y el rango de claves de 10 segundos correspondientes.

¿Qué sigue?