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

Si quieres usar Key Visualizer para Firestore, debes habilitar la Firestore Key Visualizer API.

Enable the API

Funciones obligatorias

Asegúrate de que a tu cuenta se le otorgue una de las siguientes funciones de IAM:

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

Estas funciones 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 una función personalizada con los permisos necesarios.

Visualiza un análisis de un período

Cada análisis de Key Visualizer cubre un período de dos horas. Hay un análisis de un período determinado disponible para las bases de datos con tráfico que supera las 3,000 operaciones de documentos en un minuto determinado 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 disponibles de Key Visualizer:

    1. Haz clic en el ícono de lápiz que se encuentra en la esquina superior derecha. Selecciona una Fecha y un Período.

      Los análisis están disponibles según la elegibilidad de análisis. No puedes seleccionar intervalos de tiempo que no cumplieron con los requisitos de elegibilidad del análisis o que aún se estén procesando. Los dos análisis más recientes del día tardarán un tiempo en procesarse antes de estar disponibles.

    2. Selecciona Todos los datos del documento o Todos los datos de índice como el origen.

    3. Haga clic en Update.

  5. Selecciona una métrica para analizar:

    Haz clic en el menú desplegable de métricas en la esquina superior izquierda y selecciona una para verla. Key Visualizer se abre en la métrica Ops/s para claves de documentos y en la métrica Index Write Ops/s para las claves de índice de forma predeterminada.

Para comparar métricas o buscar correlaciones de datos, puedes mostrar varias métricas de Key Visualizer juntas. Consulta Cómo buscar 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 de dos horas seleccionado, 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 teclas de documentos

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

Después de tener una idea de la actividad general de tu base de datos, puedes continuar con la investigación si observas otras métricas y te enfocas en los rangos de claves que podrían causar problemas. Más información

Análisis de claves de índice

La métrica Operaciones de escritura de índices en una celda determinada mide las escrituras de índices promedio por segundo dentro del intervalo de tiempo de 10 segundos y el rango de claves correspondientes.

¿Qué sigue?