Cómo crear y administrar posposiciones

En este documento, se describe cómo crear y administrar tus pospones. Una alerta pospuesta impide que Cloud Monitoring haga lo siguiente: crear incidentes y emitir notificaciones durante una durante un período específico. Cada alerta pospuesta especifica los recursos a los que se aplica.

Para obtener una descripción general conceptual, consulta Posponer notificaciones e incidentes.

Para crear y administrar tus posposiciones, usa la consola de Google Cloud o la API de Cloud Monitoring.

Antes de comenzar

  1. Asegúrate de tener los permisos necesarios:

    Para obtener más información sobre los roles de Cloud Monitoring, consulta Controla el acceso con Identity and Access Management.

  2. Si deseas usar los ejemplos de la API de Cloud Monitoring incluidos en este documento, haz lo siguiente:

    1. Crea una variable de entorno, PROJECT_ID, para contener el ID de tu proyecto de Google Cloud:

      PROJECT_ID=PROJECT_ID

    2. Autentica en Google Cloud CLI:

      gcloud auth login

    3. Configura el proyecto predeterminado de Google Cloud:

      gcloud config set project ${PROJECT_ID}

    4. Crea un token de autorización:

      ACCESS_TOKEN=`gcloud auth print-access-token`

      Deberás actualizar el token de acceso de forma periódica. Si los comandos que funcionaban de repente informan que no estás autenticado, vuelve a emitir este comando.

Cómo crear una alerta para posponer

Para evitar que las políticas de alertas creen incidentes y envíen notificaciones, crear una alerta pospuesta.

Puedes crear una posposición con la consola de Google Cloud, la CLI de gcloud o la API de Cloud Monitoring.

Console

  1. En la consola de Google Cloud, ve a la página  Alertas.

    Ir a las Alertas

    Si usas la barra de búsqueda para encontrar esta página, selecciona el resultado cuyo subtítulo es Monitoring.

  2. Para crear una posposición desde un incidente abierto, haz lo siguiente:
    1. En el panel Incidentes de la página Alerting, busca tu incidente y haga clic en el Resumen de incidentes.
    2. En la página Detalles del incidente, haz clic en Posponer y, luego, selecciona la duración de la posposición. No puedes configurar ningún otro campo.

  3. De lo contrario, haz lo siguiente:

    1. En la página Alertas, haz clic en Crear posposición.
    2. Ingresa un nombre descriptivo para la posposición. Este nombre se muestra en la página Alertas.
    3. Selecciona una Hora de inicio. Puedes ingresar un horario específico o comenzar la posponer cuando se crea.
    4. Ingresa la duración. El valor de este campo determina por cuánto tiempo que dura la alerta "posponer".

    5. Completa la sección Criterios de posposición. Puedes usar la El menú Políticas de alertas para seleccionar las políticas de alertas a las que se aplica la alerta pospuesta.

      Puedes agregar hasta 16 políticas de alertas a una posposición.

      Después de completar la sección Criterios de posposición, aparecerá el menú Crear alerta pospuesta un panel enumera los incidentes pasados que coinciden con los criterios.

    6. Haz clic en Crear.

API de Cloud Monitoring

Para crear un aplazamiento, invoca el método snoozes.create enviando una solicitud POST al extremo Snooze. Debes proporcionar un objeto snooze:

curl -d @my-snooze.json -H "Authorization: Bearer $ACCESS_TOKEN" \
-H 'Content-Type: application/json' \
-X POST https://monitoring.googleapis.com/v3/projects/${PROJECT_ID}/snoozes

El método devuelve un objeto snooze. El campo "name" que incluye el ID de posponer que genera Monitoring, es la única diferencia entre el objeto devuelto y el contenido de my-snooze.json:

{
  "name": "projects/my-project/snoozes/2986666341878464512",
  "criteria": {
    "policies": [
      "projects/my-project/alertPolicies/787884840895011889"
    ]
  },
  "interval": {
    "startTime": "2022-11-12T19:00:20Z",
    "endTime": "2022-11-12T19:05:20Z"
  },
  "displayName": "Snooze2"
}

gcloud CLI

Para crear una alerta pospuesta, ejecuta la Comando gcloud monitoring snoozes create:

gcloud monitoring snoozes create --criteria-policies=LIST_OF_POLICIES --display-name=DISPLAY_NAME --start-time=START_TIME --end-time=END_TIME

En el comando anterior, el end-time debe ser al menos un minuto posterior. que start-time. Debe seguir las reglas de formato ISO 8601. Sin embargo, puedes especificar horas absolutas o relativas. En el siguiente ejemplo, se especifica tiempos absolutos. Para iniciar una posposición 30 minutos después de la hora actual, usa --start-time="+PTM30M".

Si especificas varios proyectos, sepáralos con una coma.

Por ejemplo, el siguiente comando crea un aplazamiento con el nombre visible “Semana de mantenimiento”. La alerta pospuesta se aplica a dos políticas de alertas y abarca desde el primero de marzo hasta el siete de marzo:

gcloud monitoring snoozes create --display-name="Maintenance Week" \
    --criteria-policies="projects/my-project/alertPolicies/12345,projects/my-project/alertPolicies/23451" \
    --start-time="2023-03-01T03:00:00.0-0500" \
    --end-time="2023-03-07T23:59:59.5-0500"

En el ejemplo anterior, se crea la siguiente alerta pospuesta en my-project:

{
 "name": "projects/my-project/snoozes/98765",
 "displayName": "Maintenance Week",
 "interval": {
   "startTime": "2023-03-01T08:00:00Z",
   "endTime": "2023-03-08T04:59:59Z"
 },
 "criteria": {
   "policies": [
     "projects/my-project/alertPolicies/12345",
     "projects/my-project/alertPolicies/23451",
   ]
 }
}

Si se ejecuta de forma correcta, la respuesta a este comando es similar a la siguiente:

Created snooze [projects/my-project/snoozes/98765]

El nombre de una política de alertas no se muestra en la consola de Google Cloud. Para determinar el nombre de una política de alertas, haz una de las siguientes acciones:

  • Ejecuta el comando gcloud alpha monitoring policies list. Los datos de respuesta incluye el nombre de tus políticas de alertas.
  • Consulta la representación JSON de una política de alertas. Puedes descargar la representación de JSON a tu sistema local usando una opción en la página Detalles de la política.

Cómo crear alertas pospuestas recurrentes

Para crear pospones que se produzcan en intervalos recurrentes, puedes escribir una secuencia de comandos que cree una posposición para una política de alertas. Luego, usa un programador de trabajos, como cron o Cloud Scheduler para ejecutar la secuencia de comandos en los recursos requeridos de un proyecto.

Cómo ver la lista de alertas pospuestas

Cuando creas una alerta pospuesta, esta se agrega al registro histórico de alertas pospuestas. para tu proyecto. En este registro, se muestran los datos vencidos, activos y próximos. alertas pospuestas. No puedes quitar entradas de este registro, es decir, no puedes borrar un aplazamiento. Sin embargo, desde esta vista, puedes mostrar los detalles de una posposición y realizar acciones como editarla o copiarla.

Console

Para ver una lista de las alertas pospuestas, sigue estos pasos:

  1. En la consola de Google Cloud, ve a la página  Alertas.

    Ir a las Alertas

    Si usas la barra de búsqueda para encontrar esta página, selecciona el resultado cuyo subtítulo es Monitoring.

  2. Haz clic en Ver todas las alertas pospuestas en el panel Posponer.

    En la página Posponer, se muestra una lista de las posposiciones y un cronograma que muestra gráficamente las posposiciones anteriores, próximas y activas.

    • Para editar, copiar, cancelar o finalizar una alerta pospuesta, usa Menú Más opciones del elemento posponer. El estado de posponer determina las opciones que estarán disponibles.
    • Para enumerar todas las alertas pospuestas, habilita Mostrar alertas pospuestas anteriores. De forma predeterminada, solo aparecerán las alertas pospuestas activas y futuras.
    • Para cambiar el período de visualización de la tabla Cronología, usa el menú Intervalo de tiempo. De forma predeterminada, la tabla muestra los datos de la hora siguiente. Sin embargo, puedes modificar este campo para especificar períodos anteriores o futuros. Las alertas pospuestas vencidas se conservan durante 13 meses.
    • Para ver los detalles de una alerta pospuesta específica, haz clic en Ver detalles.
    • Para ver un resumen de las alertas pospuestas activas, coloca el cursor en área sombreada de la fila Activo en la tabla Cronograma. La información sobre la herramienta muestra la información de resumen.
    • Para ver una representación gráfica de las posposiciones activas, expande la fila Activas de la tabla Cronograma.

API de Cloud Monitoring

Para enumerar todas las alertas pospuestas que pertenecen a un proyecto de Google Cloud, invoca el Método snoozes.list:

curl -H "Authorization: Bearer $ACCESS_TOKEN" \
https://monitoring.googleapis.com/v3/projects/${PROJECT_ID}/snoozes

El método muestra una lista de objetos snooze. Por ejemplo: Cuando un proyecto tiene una alerta pospuesta, la respuesta al comando snoozes.list es similar a lo siguiente:

{
  "snoozes": [
    {
      "name": "projects/my-project/snoozes/2986663705844383744",
      "criteria": {
        "policies": [
          "projects/my-project/alertPolicies/787884840895011889"
        ]
      },
      "interval": {
        "startTime": "2022-11-08T19:00:20Z",
        "endTime": "2022-11-08T19:05:20Z"
      },
      "displayName": "Snooze1"
    }
  ]
}

Para obtener información sobre una posposición específica, invoca el método snoozes.get y especifica el ID del proyecto y el ID de la posposición. En la respuesta anterior, el ID de posponer es 2986663705844383744:

curl -H "Authorization: Bearer $ACCESS_TOKEN" \
https://monitoring.googleapis.com/v3/projects/${PROJECT_ID}/snoozes/${SNOOZE_ID}

El método muestra un solo objeto snooze:

{
  "name": "projects/my-project/snoozes/2986663705844383744",
  "criteria": {
    "policies": [
      "projects/my-project/alertPolicies/787884840895011889"
    ]
  },
  "interval": {
    "startTime": "2022-11-08T19:00:20Z",
    "endTime": "2022-11-08T19:05:20Z"
  },
  "displayName": "Snooze1"
}

gcloud CLI

Para enumerar las posposiciones de tu proyecto actual, ejecuta el comando gcloud monitoring snoozes list:

gcloud monitoring snoozes list OPTIONAL_FLAGS

Para obtener más información sobre las marcas opcionales, consulta la Página de referencia de gcloud monitoring snoozes list

La respuesta a este comando es una lista de nombres de pospones en el proyecto, con el formato YAML. Por ejemplo, la respuesta a este comando para la El proyecto de Google Cloud con el ID my-project es una entrada única:

criteria:
  policies:
  - projects/my-project/alertPolicies/12345
  - projects/my-project/alertPolicies/23451
displayName: Maintenance Week
interval:
  endTime: '2023-03-08T04:59:59Z'
  startTime: '2023-03-01T08:00:00Z'
name: projects/my-project/snoozes/98765

Para enumerar los detalles de una posposición específica, ejecuta el comando gcloud monitoring snoozes describe:

gcloud monitoring snoozes describe NAME

Por ejemplo, para mostrar los detalles de la función de posponer con el nombre projects/my-project/snoozes/98765, ejecuta el siguiente comando:

gcloud monitoring snoozes describe projects/my-project/snoozes/98765

Si proporcionas un NAME no válido a un comando describe, la respuesta contendrá un código de error de 500 y el siguiente mensaje:

Internal error encountered. Please retry after a few seconds. If internal errors persist, contact support at https://cloud.google.com/support/docs.

Cómo editar una alerta pospuesta

Puedes editar el nombre y el período de una próxima alerta pospuesta, así como la el nombre y la hora de finalización de una alerta pospuesta activa. Por ejemplo, cuando se reprograma un período de mantenimiento, es posible que debas editar una posposición.

No puedes editar una alerta pospuesta anterior ni los criterios de ninguna alerta pospuesta. Sin embargo, si quieres programar una posposición anterior para un período futuro, cópiala y aplica los cambios a la copia antes de seleccionar Crear.

Console

Para editar una alerta pospuesta, sigue estos pasos:

  1. En la consola de Google Cloud, ve a la página  Alertas.

    Ir a las Alertas

    Si usas la barra de búsqueda para encontrar esta página, selecciona el resultado cuyo subtítulo es Monitoring.

  2. Haz clic en Ver todas las posposiciones en el panel Posponer.
  3. En la lista de posponer, busca la que quieres editar y, luego, selecciona Editar posposición en el menú Más opciones .
  4. Haz clic en Guardar después de completar los cambios.

API de Cloud Monitoring

Para modificar una alerta pospuesta existente, invoca la función snoozes.patch. a través de la emisión de una solicitud PATCH al extremo Snooze. Debes proporcionar el objeto snooze revisado y, luego, incluir parámetros de consulta que identifiquen qué campos se modifican. Cuando usas curl, los parámetros de consulta deben estar codificados en formato URL.

Para las próximas alertas pospuestas, puedes modificar el nombre y el punto. En el caso de las posposiciones activas, puedes modificar el nombre y la hora de finalización. No puedes modificar las posposiciones anteriores.

Para actualizar el displayName de una posposición, crea un archivo JSON, my-updated-snooze.json, que describa el objeto de posposición y actualice el nombre visible. Luego, ejecuta el comando siguiente:

curl -d @my-updated-snooze.json -H "Authorization: Bearer $ACCESS_TOKEN" \
-H 'Content-Type: application/json' \
-X PATCH https://monitoring.googleapis.com/v3/projects/${PROJECT_ID}/snoozes/${SNOOZE_ID}?updateMask=displayName

El método devuelve un objeto snooze idéntico al contenido del archivo my-updated-snooze.json:

{
  "name": "projects/my-project/snoozes/2986665388391530496",
  "criteria": {
    "policies": [
      "projects/my-project/alertPolicies/7164333552684403347"
    ]
  },
  "interval": {
    "startTime": "2022-11-08T22:26:05Z",
    "endTime": "2022-11-08T22:31:05Z"
  },
  "displayName": "Updated snooze name"
}

gcloud CLI

Para editar una posposición, ejecuta el comando gcloud monitoring snoozes update. Puedes actualizar el nombre visible, la hora de inicio y la hora de finalización:

gcloud monitoring snoozes update NAME OPTIONAL_FLAGS

Si deseas obtener una lista de opciones para el comando update, consulta el Página de referencia de gcloud monitoring snoozes update.

Por ejemplo, para cambiar el nombre visible del posponer con el nombre projects/my-project/snoozes/98765, ejecuta el siguiente comando:

gcloud monitoring snoozes update projects/my-project/snoozes/98765  --display-name="March Maintenance"

Cómo finalizar o cancelar una función para posponer

Si quieres recibir notificaciones de recursos que coinciden con los criterios especificada en una alerta pospuesta activa, y luego finalizar la función. Por ejemplo, cuando el mantenimiento programado se completa más rápido de lo previsto, es posible que desees finalizar una posposición.

Si tienes una próxima posposición que ya no quieres, cancela la posposición. La operación de cancelación establece la duración en cero y da como resultado la función de posponer transición al estado Past.

Console

Para finalizar una posposición activa o cancelar una próxima, haz lo siguiente:

  1. En la consola de Google Cloud, ve a la página  Alertas.

    Ir a las Alertas

    Si usas la barra de búsqueda para encontrar esta página, selecciona el resultado cuyo subtítulo es Monitoring.

  2. Haz clic en Ver todas las alertas pospuestas en el panel Posponer.

  3. En la lista de alertas pospuestas, busca la que deseas finalizar o cancelar. y, luego, realiza una de las siguientes acciones:

    • Para finalizar una alerta pospuesta activa, selecciona Finalizar ahora en la Menú Más opciones
    • Para cancelar una alerta pospuesta próxima, selecciona Cancelar alarma en la Menú Más opciones

API de Cloud Monitoring

Para finalizar una alerta pospuesta activa, edítala y establece la hora de finalización en hora actual. Para obtener más información, consulta Cómo editar una posposición.

Para cancelar una próxima posposición, edítala y establece la hora de finalización en la hora de inicio de la posposición. La hora de inicio debe ser en el futuro. Para obtener más información, consulta Cómo editar una alerta pospuesta.

gcloud CLI

Para finalizar una alerta pospuesta activa o cancelar una alerta pospuesta siguiente, ejecuta la Comando gcloud monitoring snoozes cancel:

gcloud monitoring snoozes cancel NAME

Por ejemplo, para cancelar el posponer con el nombre projects/my-project/snoozes/98765, ejecuta el siguiente comando:

gcloud monitoring snoozes cancel projects/my-project/snoozes/98765

Cómo copiar una alerta pospuesta

Cuando quieras usar una posposición existente como una plantilla para otra, crea una copia. Cuando copias una alerta pospuesta, El editor de posponer se abre con todos los campos excepto la hora de inicio. configurado en los valores de la alerta pospuesta original. Puedes modificar todos los campos antes de hacer clic en Crear.

Para copiar una posposición con la consola, haz lo siguiente:

  1. En la consola de Google Cloud, ve a la página  Alertas.

    Ir a las Alertas

    Si usas la barra de búsqueda para encontrar esta página, selecciona el resultado cuyo subtítulo es Monitoring.

  2. Haz clic en Ver todas las alertas pospuestas en el panel Posponer.
  3. En la lista de posponer, busca la que deseas editar y, luego, selecciona Copiar posponer en el menú Más opciones .
  4. Aplica tus modificaciones a la copia y, luego, haz clic en Crear.

¿Qué sigue?