Cómo administrar monitores sintéticos

En este documento, se describe cómo administrar tus monitores sintéticos. Puedes visualizar una lista de tus monitores sintéticos y, por cada uno, puede ver y modificar la configuración y el historial de ejecución, así como los detalles de cada ejecución. Puedes administrar tus monitores sintéticos con con la consola de Google Cloud o con la API de Cloud Monitoring.

Si deseas obtener información para explorar los resultados de la ejecución y las y registros de un monitor sintético, consulta Explora los resultados del monitor sintético.

Antes de comenzar

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

    Si quieres obtener más información para otorgar roles, consulta Administra el acceso.

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

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

Mostrar lista de supervisores sintéticos

Console

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

  1. En la consola de Google Cloud, ve a  Supervisión sintética:

    Ir 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. Opcional: Para restringir los monitores sintéticos que se enumeran, agrega filtros.

    Cada filtro se compone de un nombre y un valor. Puedes establecer que el valor coincida exactamente con el nombre de un monitor sintético o una coincidencia parcial. Las coincidencias no distinguen mayúsculas de minúsculas. Por ejemplo, para enumerar todos 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 se revise se muestra si su nombre coincide con default o Testing check.

La página Monitores sintéticos muestra lo siguiente para cada monitor sintético:

  • 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 promedio de ejecución.
  • El número de políticas de alertas.
  • Para editar, copiar o borrar el monitor sintético, y crear un 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 gcloud monitoring uptime list-configs :

gcloud monitoring uptime list-configs

Entre los datos que se muestran, se incluyen los siguientes:

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

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

API

Para enumerar los supervisores sintéticos de tu proyecto de Google Cloud, puedes hacer lo siguiente: 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 elemento parent del método con el nombre del proyecto. Asegúrate de utiliza el siguiente formato:

    projects/PROJECT_ID

    En la expresión anterior, PROJECT_ID es el ID del proyecto de Google Cloud.

Para un monitor sintético, el resultado contiene un campo etiquetado syntheticMonitor.

Ver 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  Supervisión sintética:

    Ir 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. Para abrir la página Detalles del monitor sintético, busca el monitor sintético que quieres ver y, luego, haz clic en su nombre.

    Si deseas ver tu Cloud Function desde la Página de detalles de las funciones proporcionados por Cloud Functions, 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 nueva ventana. Las pestañas de esta página te permiten ver métricas y registros, y configuración.

gcloud

Para enumerar los detalles de una verificación de tiempo de actividad ejecuta gcloud monitoring uptime describe. :

gcloud monitoring uptime describe CHECK_ID

Antes de ejecutar el comando anterior, reemplaza CHECK_ID por el identificador de la verificación de tiempo de actividad o el monitor sintético. Puedes encontrar el identificador mediante la ejecución del comando gcloud monitoring uptime list-configs y examinar el campo name. Para obtener más información, consulta Encuentra el identificador único de un monitor sintético.

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

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

API

Para ver los detalles de un monitor sintético específico en tu proyecto de Google Cloud, sigue estos pasos: Llamar a Método projects.uptimeCheckConfigs.get:

  1. Haz clic en projects.uptimeCheckConfigs.get.

  2. Usa el Explorador de APIs.

    Establece el elemento superior del método en el 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 de Google Cloud. y 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 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 Cloud Function

Console

Para editar un monitor sintético o su Cloud Function, sigue estos pasos: En la página Detalles del monitor sintético, haz lo siguiente:

  1. En la consola de Google Cloud, ve a  Supervisión sintética:

    Ir 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. Busca el monitor sintético que quieres editar. Haz clic en Más opciones y, luego, selecciona Editar.

  3. Opcional: Para editar la Cloud Function, haz clic en Editar función. realiza los cambios y, luego, haz clic en Aplicar función.

    Para los verificadores de vínculos rotos, para modificar el URI de origen o las opciones que definir qué vínculos se prueban, editar la Cloud Function 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.

  4. Para conservar las 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 gcloud monitoring uptime update. :

gcloud monitoring uptime update CHECK_ID OPTIONAL_FLAGS

Antes de ejecutar el comando anterior, haz lo siguiente:

  • Reemplaza CHECK_ID por el identificador de la verificación de tiempo de actividad. monitor sintético. Para encontrar el identificador, ejecuta el comando Comando gcloud monitoring uptime list-configs y examinar el campo name. Para obtener más información, consulta Busca el identificador único de una verificación de tiempo de actividad.

  • Define qué campos quieres modificar. En el caso de los supervisores sintéticos, puedes solo actualiza 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

API

Las políticas y funciones de alertas no están incluidas en un monitor sintético. por lo tanto, no pueden editarse 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. Establece el elemento superior del método en el 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 de Google Cloud. y CHECK_ID es el ID del monitor sintético.

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

    2. Establece el parámetro de consulta del método, updateMask, para identificar cuál. se modifican los campos del objeto. Por ejemplo, para actualizar el de displayName, el parámetro de consulta sería el siguiente:

      updateMask=displayName

Copia 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  Supervisión sintética:

    Ir 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. Busca el monitor sintético que quieres editar. Haz clic en Más opciones y, luego, selecciona Copiar.

    Se abrirá el diálogo Copy Synthetic Check con campos completados previamente. incluida una copia de la Cloud Function.

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

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

    Cuando haces clic en Crear, se crea tu Cloud Function y, luego, se crea el monitor sintético.

gcloud

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

API

No hay un método de API que te permita copiar un monitor sintético. Sin embargo, puedes sigue estos pasos para crear una copia:

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

Borrar un monitor sintético

Console

Para borrar un monitor sintético y cualquier política de alertas asociada, haz lo siguiente: haz lo siguiente:

  1. En la consola de Google Cloud, ve a  Supervisión sintética:

    Ir 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. Ubica el monitor sintético que quieres borrar y haz clic en el de la fuente de datos.

  3. Opcional: Si deseas borrar la Cloud Function, 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 nueva ventana.

  4. En la página Detalles del monitor sintético, haz lo siguiente: Haz clic en Borrar y, luego, completa el diálogo.

    Ya borraste el monitor sintético.

  5. Para borrar la Cloud Function, 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 gcloud monitoring uptime delete. :

gcloud monitoring uptime delete CHECK_ID

Antes de ejecutar el comando anterior, reemplaza CHECK_ID por el identificador de la verificación de tiempo de actividad o el monitor sintético. Puedes encontrar el identificador mediante la ejecución del comando gcloud monitoring uptime list-configs y examinar el campo name. Para obtener más información, consulta Encuentra el identificador único de un monitor sintético.

API

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 elemento superior del método en el 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 de Google Cloud. y CHECK_ID es el ID del monitor sintético.

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

Encuentra el identificador único de un monitor sintético

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

projects/PROJECT_ID/uptimeCheckConfigs/CHECK_ID

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

¿Qué sigue?