Administra monitores sintéticos

En este documento, se describe cómo administrar tus monitores sintéticos. Puedes ver una lista de tus monitores sintéticos y, para cada uno de ellos, ver y modificar la configuración, ver el historial de ejecución y ver detalles sobre cada ejecución. Puedes administrar tus monitores sintéticos con la console de Google Cloud o con la API de Cloud Monitoring.

Para obtener información sobre cómo explorar los resultados de la ejecución y las métricas y los registros de un monitor sintético, consulta Explora los resultados del monitor sintético.

Esta función solo es compatible con los proyectos de Google Cloud.

Antes de comenzar

Completa lo siguiente en el proyecto de Google Cloud que almacena tu monitor sintético:

  • Para obtener los permisos que necesitas para ver y modificar monitores sintéticos con la consola de Google Cloud, pídele a tu administrador que te otorgue los siguientes roles de IAM en tu proyecto:

    Para obtener más información sobre cómo otorgar roles, consulta Administra el acceso a proyectos, carpetas y organizaciones.

    También puedes obtener los permisos necesarios mediante roles personalizados o cualquier otro rol predefinido.

  • Las instrucciones de la API que se indican en esta página son para el Explorador de APIs. Sin embargo, también puedes emitir 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 de REST en esta página en un entorno de desarrollo local, debes usar las credenciales que proporcionas a la CLI de gcloud.

      Install the Google Cloud CLI, then initialize it by running the following command: 

      gcloud init

    Para obtener más información, consulta Autentica para usar REST en la documentación de autenticación de Google Cloud .

Cómo ver una lista de los monitores sintéticos

Console

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

  1. En la consola de Google Cloud, ve a la página  Synthetic monitoring:

    Ve a Supervisión sintética.

    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 de la consola de Google Cloud, selecciona tu proyecto de Google Cloud.

  3. Opcional: Para restringir los monitores sintéticos que se enumeran, agrega filtros.

    Cada filtro se compone de un nombre y un valor. Puedes configurar que el valor sea una coincidencia exacta para un nombre de monitor sintético o una coincidencia parcial. Las coincidencias no distinguen mayúsculas de minúsculas. Por ejemplo, para ver una lista de todos los monitores sintéticos cuyo nombre contiene default, haz lo siguiente:

    • Haz clic en Filtrar tabla (Filter table) y selecciona Nombre visible (Display name).
    • Ingresa default y, luego, presiona la tecla Intro.

    Si tienes varios filtros, estos se unen de manera automática con un AND lógico, a menos que insertes un filtro OR. En el ejemplo anterior, se usa el filtro OR para que aparezca una verificación de tiempo de actividad si su nombre coincide con default o Testing check.

La página Supervisión sintética muestra la siguiente información para cada monitor sintético:

  • Es el estado de la ejecución más reciente.
  • Es un vínculo a información detallada sobre ese monitor sintético.
  • La tasa de éxito y el tiempo de ejecución promedio.
  • La cantidad de políticas de alertas.
  • Para editar, copiar o borrar el monitor sintético, y crear una política de alertas, usa el menú Más opciones.

gcloud

Para enumerar tus verificaciones de tiempo de actividad 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, reemplaza lo siguiente:

  • PROJECT_ID: Es el identificador del proyecto.

Los datos que se muestran incluyen lo siguiente:

  • Nombre y nombre visible
  • Verifica el identificador.
  • Recurso supervisado
  • Es el período entre verificaciones.

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

REST

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

  1. Haz clic en projects.uptimeCheckConfigs.list.

  2. Usa el Explorador de APIs.

    Establece el parent del método en 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 de Google Cloud.

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

Cómo ver los detalles de un monitor sintético

Console

Para ver los detalles de un monitor sintético en tu proyecto de Google Cloud, haz lo siguiente:

  1. En la consola de Google Cloud, ve a la página  Synthetic monitoring:

    Ve a Supervisión sintética.

    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 de la consola de Google Cloud, selecciona tu proyecto de Google Cloud.

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

    Si deseas ver tu función de Cloud Run en la página Detalles de las funciones que proporcionan las funciones de Cloud Run, selecciona la pestaña Código y, luego, 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 las métricas y los registros, así como la información de configuración.

gcloud

Para enumerar los detalles de una verificación de tiempo de actividad o 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, reemplaza lo siguiente:

  • PROJECT_ID: Es el identificador del proyecto.
  • CHECK_ID: Es el identificador de la verificación de tiempo de actividad o del monitor sintético. Para encontrar el identificador, ejecuta el comando gcloud monitoring uptime list-configs y examina el campo name. Para obtener más información, consulta Cómo encontrar el identificador único de un monitor sintético.

Los datos que se muestran para la verificación del tiempo de actividad incluyen lo siguiente:

  • Nombre y nombre visible
  • Verifica el identificador.
  • Recurso supervisado
  • Es el período entre verificaciones.

REST

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

  1. Haz clic en projects.uptimeCheckConfigs.get.

  2. Usa el Explorador de APIs.

    Establece el parent del método en el identificador del monitor sintético y asegúrate de usar el siguiente formato:

    projects/PROJECT_ID/uptimeCheckConfigs/CHECK_ID

    En la expresión anterior:

    • PROJECT_ID es tu ID del proyecto de Cloud.
    • CHECK_ID es el ID del monitor sintético.

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

    projects/my-project/uptimeCheckConfigs/10863117100295372627

    Para encontrar el valor de CHECK_ID, puedes emitir el método projects.uptimeCheckConfigs.list. Para reducir la cantidad de resultados que se muestran, incluye un filtro. Por ejemplo, agrega el filtro displayName="MySyntheticMonitor".

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

Console

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

  1. En la consola de Google Cloud, ve a la página  Synthetic monitoring:

    Ve a Supervisión sintética.

    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 de la consola de Google Cloud, selecciona tu proyecto de Google Cloud.
  3. Busca el monitor sintético que deseas editar, haz clic en Más opciones y, luego, selecciona Editar.

  4. Opcional: Para editar la función de Cloud Run, haz clic en Editar función, realiza los cambios necesarios y, luego, haz clic en Aplicar función.

    En el caso de los verificadores de vínculos rotos, para modificar el URI de origen o las opciones que definen qué vínculos se prueban, edita la función de Cloud Run y, luego, actualiza 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 tus modificaciones, haz clic en Guardar. De lo contrario, haz clic en Cancelar.

gcloud

Para modificar una verificació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, reemplaza lo siguiente:

  • PROJECT_ID: Es el identificador del proyecto.

  • CHECK_ID: Es el identificador de la verificación de tiempo de actividad o del monitor sintético. Para encontrar el identificador, ejecuta el comando gcloud monitoring uptime list-configs y examina el campo name. Para obtener más información, consulta Cómo encontrar el identificador único de una verificación de tiempo de actividad.

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

    • Período
    • Nombre visible
    • Tiempo de espera
    • Etiquetas de usuario

Por ejemplo, para establecer el período de un monitor sintético en 10 minutos, ejecuta el siguiente comando:

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

REST

Un monitor sintético no contiene las políticas ni las funciones de alerta y, por lo tanto, no se pueden editar con el procedimiento que se describe 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. Establece el superior del método en 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.
      • CHECK_ID es el ID del monitor sintético.

      Para encontrar el valor de CHECK_ID, puedes emitir el método projects.uptimeCheckConfigs.list. Para reducir la cantidad de resultados que se muestran, incluye un filtro. Por ejemplo, agrega el filtro displayName="MySyntheticMonitor".

    2. Configura el parámetro de consulta del método, updateMask, para identificar qué campos del objeto se están modificando. Por ejemplo, para actualizar el valor de displayName, el parámetro de consulta es el siguiente:

      updateMask=displayName

Cómo copiar un monitor sintético

Console

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

  1. En la consola de Google Cloud, ve a la página  Synthetic monitoring:

    Ve a Supervisión sintética.

    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 de la consola de Google Cloud, selecciona tu proyecto de Google Cloud.

  3. Busca el monitor sintético que deseas editar, haz clic en Más opciones y, luego, selecciona Copiar.

    Se abrirá el diálogo Copy Synthetic Check con campos prepropagados, incluida una copia de la función de Cloud Run.

  4. Haz clic en Crear función, actualízala según sea necesario y, luego, haz clic en Aplicar función.

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

    Cuando haces clic en Crear, se crea y se implementa tu función de Cloud Run, y, luego, se crea el monitor sintético.

gcloud

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

REST

No hay un 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 Cómo ver los detalles de un monitor sintético.
  2. Edita la respuesta.
  3. Llama al método projects.uptimeCheckConfigs.create y pasa al método la respuesta editada.

Borra un monitor sintético

Console

Para borrar un monitor sintético y las políticas de alertas asociadas, haz lo siguiente:

  1. En la consola de Google Cloud, ve a la página  Synthetic monitoring:

    Ve a Supervisión sintética.

    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 de la consola de Google Cloud, selecciona tu proyecto de Google Cloud.

  3. Busca el monitor sintético que deseas borrar y, luego, haz clic en su nombre.

  4. Opcional: Si quieres borrar la función de Cloud Run, selecciona la pestaña Code y, luego, 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 Borrar y, luego, completa el diálogo.

    Ya borraste el monitor sintético.

  6. Para borrar la función de Cloud Run, ve a la página Detalles de las funciones, haz clic en Borrar y, luego, completa el diálogo.

gcloud

Para borrar una verificación de tiempo de actividad 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, reemplaza lo siguiente:

  • PROJECT_ID: Es el identificador del proyecto.
  • CHECK_ID: Es el identificador de la verificación de tiempo de actividad o del monitor sintético. Para encontrar el identificador, ejecuta el comando gcloud monitoring uptime list-configs y examina el campo name. Para obtener más información, consulta Cómo encontrar el identificador único de un monitor sintético.

REST

Para borrar 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.

    Establece el parent del método en el identificador del monitor sintético y 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.
    • CHECK_ID es el ID del monitor sintético.

    Para encontrar el valor de CHECK_ID, puedes emitir el método projects.uptimeCheckConfigs.list. Para reducir la cantidad de resultados que se muestran, incluye un filtro. Por ejemplo, agrega el filtro displayName="MySyntheticMonitor".

Cómo encontrar el identificador único de un monitor sintético

Cuando se crea tu monitor sintético, Monitoring le asigna un identificador. Este identificador está incorporado en el nombre del 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 de Google Cloud CLI y Cloud Monitoring que crean o enumeran monitores sintéticos.

¿Qué sigue?