Cómo usar el editor de código para PromQL

En esta página, se describe cómo usar el editor de código para PromQL. El editor está disponible en la consola de Google Cloud y proporciona sugerencias y otras herramientas para crear consultas válidas de PromQL.

En esta página, no se abarca el lenguaje PromQL; para obtener información sobre PromQL, te recomendamos que consultes la documentación de código abierto. Los siguientes recursos pueden ayudarte a comenzar:

Cómo acceder al editor de código

Puedes acceder a PromQL desde las siguientes páginas en la consola de Google Cloud:

  • Explorador de métricas
  • Agregar widget cuando crees paneles

Para abrir el editor de código cuando uses el Explorador de métricas, haz lo siguiente:

  1. En el panel de navegación de la consola de Google Cloud, elige Monitoring y, luego,  Explorador de métricas:

    Ir al Explorador de métricas

  2. En la barra de herramientas del panel del compilador de consultas, selecciona el botón cuyo nombre sea  MQL o  PromQL.
  3. Verifica que PromQL esté seleccionado en el botón de activación Language. El botón de activación del idioma está en la misma barra de herramientas que te permite dar formato a tu consulta.

Cómo usar el editor de código

Para usar el editor de código, escribe tu consulta en el campo de texto y haz clic en Run Query.

Autocompletado

A medida que escribes tu consulta, el editor muestra una lista de finalizaciones válidas de forma sintáctica. Puedes abrir el menú de autocompletado de forma manual si presionas Control+Space y puedes descartarlo si presionas Escape.

Para navegar por la lista de opciones, usa las teclas de flecha. Si presionas Enter, se inserta la opción seleccionada.

Para insertar el prefijo que se aplica a todas las opciones disponibles, presiona Tab.

Buscar y reemplazar

El editor admite la función de buscar y reemplazar. Para buscar términos en tu consulta y, de manera opcional, reemplazarlos, presiona Control+F (o Command+F en Mac). En la siguiente captura de pantalla, se muestra la función:

el editor de código admite una función de buscar y reemplazar.

Controles del editor

El editor tiene dos controles que determinan cómo interactúa con tu consulta.

De forma predeterminada, tu consulta se ejecuta solo cuando haces clic en Ejecutar consulta. Puedes configurar el editor para que ejecute automáticamente tu consulta mientras escribes, pero esta opción está inhabilitada de forma predeterminada.

Para habilitar la opción de ejecución automática, usa el botón de activación Auto-run. Cuando esta opción está habilitada, el editor funciona de la siguiente manera:

  • No se muestra el botón Ejecutar consulta.
  • Los mensajes de error aparecen de forma continua a medida que escribes.
  • Si tu cursor se encuentra al final de una consulta que está incompleta, pero no tiene errores, el editor mostrará un triángulo amarillo en la barra de control. Si hay espacio, también aparece el texto Consulta incompleta.

    El editor no intenta evaluar las consultas incompletas.

También hay una barra de herramientas entre el editor de código y la región del gráfico. Usa esta barra para cambiar los tamaños relativos de las dos regiones.

Guarda gráficos

La forma de guardar un gráfico depende del contexto en el que lo creaste:

  • En el Explorador de métricas.
  • Como parte de la creación o edición de un panel personalizado

Guarda gráficos del Explorador de métricas

En el editor de código del Explorador de métricas, tienes la opción de guardar el gráfico en un panel personalizado. Para guardar el gráfico, haz lo siguiente:

  1. En el panel de navegación de la consola de Google Cloud, elige Monitoring y, luego,  Explorador de métricas:

    Ir al Explorador de métricas

  2. En la barra de herramientas del panel del compilador de consultas, selecciona el botón cuyo nombre sea  MQL o  PromQL.
  3. Verifica que PromQL esté seleccionado en el botón de activación Language. El botón de activación del idioma está en la misma barra de herramientas que te permite dar formato a tu consulta.
  4. Ingresar tu consulta en el editor
  5. Si no tienes habilitada la opción de ejecución automática para el editor de código, haz clic en Ejecutar consulta antes de guardar el gráfico para ejecutar tu consulta. De forma predeterminada, los paneles personalizados guardan los cambios de forma periódica. Cuando no ejecutas tu consulta primero, el editor de código guarda la última consulta que ejecutaste.

  6. Haz clic en Save Chart.

  7. Para seguir guardando el gráfico, sigue estos pasos:

    1. Ponle un título descriptivo al gráfico.
    2. Selecciona el panel deseado para el gráfico nuevo.
    3. Haz clic en Guardar en el cuadro de diálogo.

Guarda gráficos en un panel personalizado

Para guardar un gráfico nuevo en tu panel, haz lo siguiente:

  1. Ponle un título descriptivo al gráfico.

  2. Si no tienes habilitada la opción de ejecución automática para el editor de código, haz clic en Ejecutar consulta antes de guardar el gráfico para ejecutar tu consulta. De forma predeterminada, los paneles personalizados guardan los cambios de forma periódica. Cuando no ejecutas tu consulta primero, el editor de código guarda la última consulta que ejecutaste.

  3. Si no tienes habilitado el guardado automático para tu panel, haz clic en Guardar.

La consola de Google Cloud admite filtros a nivel de página para paneles personalizados. Estos filtros son compatibles con los gráficos de PromQL en tus paneles personalizados.

Salir del editor de código

Para salir del editor de código sin guardar tu consulta, haz clic en una de las otras pestañas del selector. Cualquier texto de consulta en el editor se descarta, pero tienes la opción de guardarlo en el portapapeles.