Gestionar monitores sintéticos

En este documento se describe cómo gestionar tus monitores sintéticos. Puede ver una lista de sus monitores sintéticos y, en cada uno de ellos, puede consultar y modificar la configuración, ver el historial de ejecuciones y consultar los detalles de cada ejecución. Puedes gestionar tus monitores sintéticos mediante la consola de Google Cloud o la API Cloud Monitoring.

Para obtener información sobre cómo consultar los resultados de la ejecución, las métricas y los registros de un monitor sintético, consulta el artículo Consultar los resultados de los monitores sintéticos.

Esta función solo se admite en proyectos de Google Cloud . En el caso de las configuraciones de App Hub, seleccione el proyecto host de App Hub o el proyecto de gestión de la carpeta habilitada para aplicaciones.

Antes de empezar

Completa los siguientes pasos en el Google Cloud proyecto que almacena tu monitor sintético:

  • Para obtener los permisos que necesitas para ver y modificar monitores sintéticos mediante la Google Cloud consola, pide a tu administrador que te conceda los siguientes roles de gestión de identidades y accesos en tu proyecto:

    Para obtener más información sobre cómo conceder roles, consulta el artículo Gestionar el acceso a proyectos, carpetas y organizaciones.

    También puedes conseguir los permisos necesarios a través de roles personalizados u otros roles predefinidos.

  • Las instrucciones de la API que se indican en esta página son para el Explorador de APIs. Sin embargo, también puedes ejecutar un comando curl. El Explorador de APIs proporciona la sintaxis de curl.

  • Select the tab for how you plan to use the samples on this page:

    Console

    When you use the Google Cloud console to access Google Cloud services and APIs, you don't need to set up authentication.

    gcloud

    In the Google Cloud console, activate Cloud Shell.

    Activate Cloud Shell

    At the bottom of the Google Cloud console, a Cloud Shell session starts and displays a command-line prompt. Cloud Shell is a shell environment with the Google Cloud CLI already installed and with values already set for your current project. It can take a few seconds for the session to initialize.

    REST

    Para usar las muestras de la API REST de esta página en un entorno de desarrollo local, debes usar las credenciales que proporciones a la CLI de gcloud.

      Instala Google Cloud CLI. Después de la instalación, inicializa la CLI de Google Cloud ejecutando el siguiente comando: 

      gcloud init

      Si utilizas un proveedor de identidades (IdP) externo, primero debes iniciar sesión en la CLI de gcloud con tu identidad federada.

    Para obtener más información, consulta el artículo Autenticarse para usar REST de la documentación sobre autenticación de Google Cloud .

Mostrar monitores sintéticos

Consola

Para ver una lista de los monitores sintéticos de tu Google Cloud proyecto, haz lo siguiente:

  1. En la Google Cloud consola, ve a la página  Monitorización sintética:

    Ve a Monitorización sintética.

    Si usas la barra de búsqueda para encontrar esta página, selecciona el resultado cuya sección sea Monitorización.

  2. En la barra de herramientas de la Google Cloud consola, selecciona tu Google Cloud proyecto. En el caso de las configuraciones de App Hub, seleccione el proyecto host de App Hub o el proyecto de gestión de la carpeta habilitada para aplicaciones.

  3. Opcional: Para restringir los monitores sintéticos que se muestran, añade filtros.

    Cada filtro se compone de un nombre y un valor. Puede definir el valor para que sea una coincidencia exacta con el nombre de un monitor sintético o una coincidencia parcial. Las coincidencias no distinguen entre mayúsculas y minúsculas. Por ejemplo, para mostrar todos los monitores sintéticos cuyo nombre contenga default, haga lo siguiente:

    • Haz clic en Filtrar tabla y selecciona Nombre visible.
    • Escribe default y, a continuación, pulsa la tecla Intro.

    Si tienes varios filtros, se unirán automáticamente mediante el operador lógico AND, a menos que insertes un filtro OR. En el ejemplo anterior se usa el filtro OR para que se muestre una comprobación de tiempo de actividad si su nombre coincide con default o Testing check.

En la página Monitores sintéticos se muestra lo siguiente de cada monitor sintético:

  • Estado de la ejecución más reciente.
  • Un enlace a información detallada sobre ese monitor sintético.
  • El porcentaje de éxito y el tiempo de ejecución medio.
  • Número de políticas de alertas.
  • Para editar, copiar o eliminar el monitor sintético, y para crear una política de alertas, usa el menú Más opciones.

gcloud

Para ver una lista de tus comprobaciones de disponibilidad y monitores sintéticos, ejecuta el comando gcloud monitoring uptime list-configs:

gcloud monitoring uptime list-configs --project=PROJECT_ID

Antes de ejecutar el comando anterior, sustituya lo siguiente:

  • PROJECT_ID: identificador del proyecto. En el caso de las configuraciones de App Hub, seleccione el proyecto host de App Hub o el proyecto de gestión de la carpeta habilitada para aplicaciones.

Los datos devueltos incluyen lo siguiente:

  • Nombre y nombre visible.
  • Comprobar identificador.
  • Recurso monitorizado.
  • Periodo entre comprobaciones.

Puedes configurar el comando de Google Cloud CLI para filtrar y ordenar los resultados.

REST

Para enumerar los monitores sintéticos de tu proyecto de Google Cloud , incluidas las comprobaciones de tiempo de actividad, llama al método projects.uptimeCheckConfigs.list:

  1. Haz clic en projects.uptimeCheckConfigs.list.

  2. Usa el Explorador de APIs.

    Asigna al parent del método el nombre del proyecto y asegúrate de usar el siguiente formato:

    projects/PROJECT_ID

    En la expresión anterior, PROJECT_ID es el ID de tu proyecto Google Cloud . En el caso de las configuraciones de App Hub, seleccione el proyecto host de App Hub o el proyecto de gestión de la carpeta habilitada para aplicaciones.

En el caso de un monitor sintético, el resultado contiene un campo denominado syntheticMonitor.

Ver los detalles de un monitor sintético

Consola

Para ver los detalles de un monitor sintético de tu Google Cloud proyecto, sigue estos pasos:

  1. En la Google Cloud consola, ve a la página  Monitorización sintética:

    Ve a Monitorización sintética.

    Si usas la barra de búsqueda para encontrar esta página, selecciona el resultado cuya sección sea Monitorización.

  2. En la barra de herramientas de la Google Cloud consola, selecciona tu Google Cloud proyecto. En el caso de las configuraciones de App Hub, seleccione el proyecto host de App Hub o el proyecto de gestión de la carpeta habilitada para aplicaciones.

  3. Para abrir la página Detalles del monitor sintético, busca el monitor sintético que quieras ver y haz clic en su nombre.

    Si quieres ver tu función de Cloud Run en la página Detalles de la función que proporciona Cloud Run Functions, selecciona la pestaña Código y, a continuación, haz clic en el nombre de la función. Se abrirá la página Detalles de las funciones en una ventana nueva. Las pestañas de esta página te permiten ver métricas, registros e información de configuración.

gcloud

Para ver los detalles de una comprobación de tiempo de actividad o de un monitor sintético, ejecuta el comando gcloud monitoring uptime describe:

gcloud monitoring uptime describe CHECK_ID --project=PROJECT_ID

Antes de ejecutar el comando anterior, sustituya lo siguiente:

  • PROJECT_ID: identificador del proyecto. En el caso de las configuraciones de App Hub, seleccione el proyecto host de App Hub o el proyecto de gestión de la carpeta habilitada para aplicaciones.
  • CHECK_ID: identificador de la comprobación de tiempo de actividad o del monitor sintético. Para encontrar el identificador, ejecuta el comando gcloud monitoring uptime list-configs y consulta el campo name. Para obtener más información, consulta Buscar el identificador único de un monitor sintético.

Los datos devueltos de la comprobación del tiempo de actividad incluyen lo siguiente:

  • Nombre y nombre visible.
  • Comprobar identificador.
  • Recurso monitorizado.
  • Periodo entre comprobaciones.

REST

Para consultar los detalles de un monitor sintético específico de tu Google Cloud proyecto, llama al método projects.uptimeCheckConfigs.get:

  1. Haz clic en projects.uptimeCheckConfigs.get.

  2. Usa el Explorador de APIs.

    Asigna el parent del método al identificador del monitor sintético. Asegúrate de usar el siguiente formato:

    projects/PROJECT_ID/uptimeCheckConfigs/CHECK_ID

    En la expresión anterior:

    • PROJECT_ID es el ID de tu proyecto Google Cloud . En el caso de las configuraciones de App Hub, seleccione el proyecto host de App Hub o el proyecto de gestión de la carpeta habilitada para aplicaciones.
    • CHECK_ID es el ID del monitor sintético.

    Por ejemplo, el valor del campo principal podría ser:

    projects/my-project/uptimeCheckConfigs/10863117100295372627

    Para encontrar el valor de CHECK_ID, puedes usar el método projects.uptimeCheckConfigs.list. Para reducir el número de resultados devueltos, incluya un filtro. Por ejemplo, añade el filtro displayName="MySyntheticMonitor".

Editar un monitor sintético o una función de Cloud Run

Consola

Para editar un monitor sintético o su función de Cloud Run mediante la página Detalles del monitor sintético, haz lo siguiente:

  1. En la Google Cloud consola, ve a la página  Monitorización sintética:

    Ve a Monitorización sintética.

    Si usas la barra de búsqueda para encontrar esta página, selecciona el resultado cuya sección sea Monitorización.

  2. En la barra de herramientas de la Google Cloud consola, selecciona tu Google Cloud proyecto. En el caso de las configuraciones de App Hub, seleccione el proyecto host de App Hub o el proyecto de gestión de la carpeta habilitada para aplicaciones.
  3. Busca el monitor sintético que quieras editar, haz clic en Más opciones y, a continuación, selecciona Editar.

  4. Opcional: Para editar la función de Cloud Run, haz clic en Editar función, haz los cambios que quieras y, a continuación, haz clic en Aplicar función.

    En el caso de los verificadores de enlaces rotos, para modificar el URI de origen o las opciones que definen qué enlaces se prueban, edite la función de Cloud Run y, a continuación, actualice el objeto options en el archivo index.js. Para obtener información sobre los campos y la sintaxis de este objeto, consulta broken-links-ok/index.js.

  5. Para conservar las modificaciones, haz clic en Guardar. De lo contrario, haz clic en Cancelar.

gcloud

Para modificar una comprobación de tiempo de actividad o un monitor sintético, ejecuta el comando gcloud monitoring uptime update:

gcloud monitoring uptime update CHECK_ID OPTIONAL_FLAGS --project=PROJECT_ID

Antes de ejecutar el comando anterior, sustituya lo siguiente:

  • PROJECT_ID: identificador del proyecto. En el caso de las configuraciones de App Hub, seleccione el proyecto host de App Hub o el proyecto de gestión de la carpeta habilitada para aplicaciones.

  • CHECK_ID: identificador de la comprobación de disponibilidad o del monitor sintético. Para encontrar el identificador, ejecuta el comando gcloud monitoring uptime list-configs y consulta el campo name. Para obtener más información, consulta Buscar el identificador único de una comprobación de disponibilidad del servicio.

  • Define los campos que quieras modificar. En el caso de los monitores sintéticos, solo puedes actualizar los siguientes campos:

    • Periodo
    • Nombre visible
    • Tiempo de espera
    • Etiquetas del usuario

Por ejemplo, para definir el periodo de un monitor sintético en 10 minutos, ejecuta el siguiente comando:

gcloud monitoring uptime update CHECK_ID --period=10 --project=PROJECT_ID

REST

Las políticas y funciones de alertas no están incluidas en un monitor sintético, por lo que no se pueden editar con el procedimiento descrito en esta sección:

Para editar un monitor sintético, llama al método projects.uptimeCheckConfigs.patch:

  1. Haz clic en projects.uptimeCheckConfigs.patch.

  2. Usa el Explorador de APIs.

    1. Asigna al campo parent del método el identificador del monitor sintético. El identificador tiene el siguiente formato:

      projects/PROJECT_ID/uptimeCheckConfigs/CHECK_ID

      En la expresión anterior:

      • PROJECT_ID es el ID del proyecto. En el caso de las configuraciones de App Hub, seleccione el proyecto host de App Hub o el proyecto de gestión de la carpeta habilitada para aplicaciones.
      • CHECK_ID es el ID del monitor sintético.

      Para encontrar el valor de CHECK_ID, puedes usar el método projects.uptimeCheckConfigs.list. Para reducir el número de resultados devueltos, incluya un filtro. Por ejemplo, añade el filtro displayName="MySyntheticMonitor".

    2. Define el parámetro de consulta updateMask del método para identificar los campos del objeto que se van a modificar. Por ejemplo, para actualizar el valor del parámetro de consulta displayName, se usa lo siguiente:

      updateMask=displayName

Copiar un monitor sintético

Consola

Para copiar un monitor sintético en tu Google Cloud proyecto, haz lo siguiente:

  1. En la Google Cloud consola, ve a la página  Monitorización sintética:

    Ve a Monitorización sintética.

    Si usas la barra de búsqueda para encontrar esta página, selecciona el resultado cuya sección sea Monitorización.

  2. En la barra de herramientas de la Google Cloud consola, selecciona tu Google Cloud proyecto. En el caso de las configuraciones de App Hub, seleccione el proyecto host de App Hub o el proyecto de gestión de la carpeta habilitada para aplicaciones.

  3. Busca el monitor sintético que quieras editar, haz clic en Más opciones y, a continuación, selecciona Copiar.

    Se abre el cuadro de diálogo Copiar comprobación sintética con los campos rellenados automáticamente, incluida una copia de la función de Cloud Run.

  4. Haga clic en Crear función, actualice la función según sea necesario y, a continuación, haga clic en Aplicar función.

  5. Para conservar las modificaciones, haz clic en Crear. De lo contrario, haz clic en Cancelar.

    Cuando hagas clic en Crear, se creará y se desplegará tu función de Cloud Run y, a continuación, se creará el monitor sintético.

gcloud

No hay ningún método de Google Cloud CLI que te permita copiar un monitor sintético.

REST

No hay ningún método de API que te permita copiar un monitor sintético. Sin embargo, puedes hacer una copia siguiendo estos pasos:

  1. Llama al método projects.uptimeCheckConfigs.get y guarda la respuesta. Para obtener más información, consulta Ver los detalles de un monitor sintético.
  2. Edita la respuesta.
  3. Llama al método projects.uptimeCheckConfigs.create y pásale la respuesta editada.

Eliminar un monitor sintético

Consola

Para eliminar un monitor sintético y las políticas de alertas asociadas, sigue estos pasos:

  1. En la Google Cloud consola, ve a la página  Monitorización sintética:

    Ve a Monitorización sintética.

    Si usas la barra de búsqueda para encontrar esta página, selecciona el resultado cuya sección sea Monitorización.

  2. En la barra de herramientas de la Google Cloud consola, selecciona tu Google Cloud proyecto. En el caso de las configuraciones de App Hub, seleccione el proyecto host de App Hub o el proyecto de gestión de la carpeta habilitada para aplicaciones.

  3. Busca el monitor sintético que quieras eliminar y haz clic en su nombre.

  4. Opcional: Si quieres eliminar la función de Cloud Run, selecciona la pestaña Código y, a continuación, haz clic en el nombre de la función. Se abrirá la página Detalles de las funciones en una ventana nueva.

  5. En la página Detalles del monitor sintético, haz clic en Eliminar y, a continuación, completa el cuadro de diálogo.

    Ahora has eliminado el monitor sintético.

  6. Para eliminar la función de Cloud Run, ve a la página Detalles de la función, haz clic en Eliminar y, a continuación, completa el cuadro de diálogo.

gcloud

Para eliminar una comprobación de disponibilidad o un monitor sintético, ejecuta el comando gcloud monitoring uptime delete:

gcloud monitoring uptime delete CHECK_ID  --project=PROJECT_ID

Antes de ejecutar el comando anterior, sustituya lo siguiente:

  • PROJECT_ID: identificador del proyecto. En el caso de las configuraciones de App Hub, seleccione el proyecto host de App Hub o el proyecto de gestión de la carpeta habilitada para aplicaciones.
  • CHECK_ID: identificador de la comprobación de tiempo de actividad o del monitor sintético. Para encontrar el identificador, ejecuta el comando gcloud monitoring uptime list-configs y consulta el campo name. Para obtener más información, consulta Buscar el identificador único de un monitor sintético.

REST

Para eliminar un monitor sintético y las políticas de alertas asociadas, llama al método projects.uptimeCheckConfigs.delete:

  1. Haz clic en projects.uptimeCheckConfigs.delete.

  2. Usa el Explorador de APIs.

    Asigna el parent del método al identificador del monitor sintético. Asegúrate de usar el siguiente formato:

    projects/PROJECT_ID/uptimeCheckConfigs/CHECK_ID

    En la expresión anterior:

    • PROJECT_ID es el ID del proyecto. En el caso de las configuraciones de App Hub, seleccione el proyecto host de App Hub o el proyecto de gestión de la carpeta habilitada para aplicaciones.
    • CHECK_ID es el ID del monitor sintético.

    Para encontrar el valor de CHECK_ID, puedes usar el método projects.uptimeCheckConfigs.list. Para reducir el número de resultados devueltos, incluya un filtro. Por ejemplo, añade el filtro displayName="MySyntheticMonitor".

Buscar el identificador único de un monitor sintético

Cuando se crea un monitor sintético, Monitoring le asigna un identificador. Este identificador está insertado en el nombre de recurso del monitor sintético y tiene el siguiente formato:

projects/PROJECT_ID/uptimeCheckConfigs/CHECK_ID

El CHECK_ID se incluye en la respuesta de los métodos de la API Cloud Monitoring y de la CLI de Google Cloud que crean o muestran monitores sintéticos.

Siguientes pasos