Crear verificaciones de tiempo de actividad públicas

En este documento, se describe cómo crear una verificación de tiempo de actividad pública. Una verificación de tiempo de actividad pública puede emitir solicitudes desde múltiples ubicaciones en toda del mundo a URLs disponibles públicamente o a recursos de Google Cloud para ver si responde el recurso. Para obtener información sobre cómo crear de tiempo de actividad para redes privadas, consulta Crea verificaciones de tiempo de actividad privadas.

Las verificaciones de tiempo de actividad públicas pueden determinar la disponibilidad recursos supervisados:

Para obtener vínculos a información sobre cómo administrar y supervisar tus verificaciones de tiempo de actividad, consulta la sección Próximos pasos de este documento.

Acerca de las verificaciones de tiempo de actividad

Para HTTP y HTTPS, se siguen todos los redireccionamientos de URL y la respuesta final recibidos por la verificación de tiempo de actividad se usan para evaluar cualquier criterio de éxito. Para HTTPS, el hora de vencimiento del certificado SSL se calcula según la certificado de servidor recibido en la respuesta final.

Para que una verificación de tiempo de actividad se realice de forma correcta, se deben cumplir las siguientes condiciones:

  • El estado HTTP debe coincidir con los criterios que especifiques.
  • Los datos de respuesta no tienen contenido obligatorio o el contenido obligatorio está presente.

Estas verificaciones no cargan recursos de la página ni ejecutan JavaScript, y el de una verificación de tiempo de actividad no incluye la autenticación.

Antes de comenzar

  1. A fin de obtener los permisos que necesitas para crear verificaciones de tiempo de actividad, solicita a tu administrador que te otorgue el los siguientes roles de IAM en tu proyecto:

    • Editor de Monitoring (roles/monitoring.editor): Usuarios de la consola de Google Cloud
    • Editor de configuraciones de verificaciones de tiempo de actividad de Monitoring (roles/monitoring.uptimeCheckConfigEditor): Usuarios de la API
    • Editor de políticas de alertas de Monitoring (roles/monitoring.alertPolicyEditor): Usuarios de la API
    • Editor de canal de notificaciones de Monitoring (roles/monitoring.notificationChannelEditor): Usuarios de la API

    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.

  2. Verifica que el recurso que quieres comprobar un extremo público o detrás de un firewall configurable.

    Para todas las demás configuraciones, debes crear una verificación de tiempo de actividad privada. Para obtener más información, consulta Crea verificaciones de tiempo de actividad privadas.

  3. Cuando tu recurso se encuentre detrás de un firewall, configúralo para que permita el tráfico entrante desde las direcciones IP de los servidores de verificación de tiempo de actividad. Para más información, consulta Enumera las direcciones IP de los servidores de verificación de tiempo de actividad.

  4. Configura los canales de notificaciones que deseas usar para recibir notificaciones. Te recomendamos crear varios tipos de notificaciones canales. Para obtener más información, consulta Crea y administra canales de notificaciones.

  5. Identifica al menos tres verificadores para tu verificación de tiempo de actividad. La región de verificación de tiempo de actividad USA incluye USA_OREGON, USA_IOWA y USA_VIRGINIA. Cada una de las USA_* regiones tiene un verificador y USA incluye los tres. Las otras regiones de verificaciones de tiempo de actividad EUROPE, SOUTH_AMERICA y ASIA_PACIFIC tienen uno cada uno de verificación.

    Si seleccionas Global cuando usas la consola de Google Cloud, o bien REGION_UNSPECIFIED cuando se usa la API, las verificaciones de tiempo de actividad se emiten en todas las regiones con verificaciones de tiempo de actividad.

Cree una verificación de tiempo de actividad

En esta sección, se explica cómo crear y configurar verificaciones de tiempo de actividad.

Para crear una verificación de tiempo de actividad de un balanceador de cargas externo que tenga al menos uno de los puertos TCP o HTTP/s configurados, sigue estas instrucciones. Una alternativa es ir a la página Detalles del servicio del servicio. y, luego, en Crear una verificación de tiempo de actividad. Al comenzar con el Detalles del servicio, se prepropagarán los campos específicos del servicio.

Console

Para crear una verificación de tiempo de actividad con la consola de Google Cloud, haz lo siguiente:

  1. En la consola de Google Cloud, ve a la página  Verificaciones de tiempo de actividad:

    Ve a Verificaciones de tiempo de actividad

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

  2. Haga clic en Crear una verificación de tiempo de actividad.

    Crea un diálogo de verificación de tiempo de actividad.

  3. Especifica el destino de la verificación de tiempo de actividad:

    1. Selecciona el protocolo. Puedes seleccionar HTTP, HTTPS o TCP.

    2. Elige uno de los siguientes tipos de recursos:

      • URL: cualquier dirección IPv4 o nombre de host. La ruta de acceso y el puerto se ingresan por separado.
      • Servicio LoadBalancer de Kubernetes: Servicio de Kubernetes de LoadBalancer el tipo de letra.
      • Instancia: instancias de Compute Engine o AWS EC2.
      • App Engine: Aplicaciones de App Engine (módulos).
      • Elastic Load Balancer: Balanceador de cargas AWS.
    3. Ingresa los campos específicos del protocolo:

      • Ingresa el puerto para las verificaciones de TCP.

      • Para las verificaciones de HTTP y HTTPS, puedes ingresar una ruta de acceso dentro de tu host o recurso. Todas las verificaciones de tiempo de actividad que usan estos protocolos envían una solicitud a http://target/path. En esta expresión, para un recurso de URL, target es un nombre de host o una dirección IP. Para un recurso de App Engine, target es un nombre de host derivado del nombre de servicio. Para recursos de instancias y balanceadores de cargas, target es una dirección IP derivada del nombre que proporcionaste para el recurso o el grupo de recursos.

        Si dejas el campo path en blanco o si estableces el valor en /, la solicitud se emitirá en http://target/.

        Por ejemplo, para emitir una verificación de tiempo de actividad al recurso URL. example.com/tester, establece el campo Nombre de host en example.com y el campo Ruta de acceso a /tester.

        Supongamos que implementaste un servidor en App Engine con un despachador que admite / y /hello. Para emitir la verificación de tiempo de actividad al '/' deja el campo Path vacío. Para emitir el de la verificación de tiempo de actividad en el controlador /hello, configura el valor Ruta a /hello.

    4. Ingresa los campos específicos de los recursos:

      • Para los recursos URL, ingresa el nombre de host en Nombre de host. . Por ejemplo, ingresa example.com.

      • En el caso de los recursos de App Engine, ingresa el nombre del servicio en el campo Servicio.

      • Para los recursos Instancia y Elastic Load Balancer, completa el campo Se aplica a de la siguiente manera:

        • Para emitir una verificación de tiempo de actividad a una única instancia o balanceador de cargas, selecciona Single y, luego, usa para seleccionar la instancia o el balanceador de cargas específico.
        • Para emitir una verificación de tiempo de actividad a un grupo de Monitoring, Selecciona Grupo y, luego, usa el para seleccionar el nombre del grupo.
    5. Opcional: Para configurar la frecuencia con la que se ejecuta la verificación de tiempo de actividad, usa el Campo Comprueba la frecuencia.

    6. Opcional: Para seleccionar regiones del verificador o configurar SSL certificados, autenticación, encabezados y puertos para HTTP y HTTPS haz clic en More target options:

      • Regiones: selecciona las regiones en las que las verificaciones de tiempo de actividad son para recibir solicitudes. Una verificación de tiempo de actividad debe tener al menos tres verificadores. Hay un verificador en todas las regiones, excepto en Estados Unidos que tiene tres verificadores. La configuración predeterminada, Global, incluye en todas las regiones.
      • Pings de ICMP: configura la verificación de tiempo de actividad para enviar hasta tres pings. Para obtener más información, consulta Usa pings de ICMP.
      • Método de solicitud: Para las verificaciones de HTTP, selecciona el método de solicitud.
      • Cuerpo: Para las verificaciones POST de HTTP, ingresa el cuerpo codificado de URL. tú debes codificar por tu cuenta. Para todas las demás verificaciones, deja este valor campo vacío.
      • Encabezado del host: Completa este campo para verificar los hosts virtuales. Este campo no está disponible para verificaciones TCP.
      • Puerto: especifica un número de puerto.
      • Encabezados personalizados: proporciona encabezados personalizados y encríptalos si lo deseas. La encriptación oculta los valores del encabezado del formulario. Usa la encriptación para los encabezados relacionados con la autenticación que no quieres que otros vean.
      • Autenticación: Estos valores se envían como una autorización encabezado. Este campo no está disponible para verificaciones TCP.

        Selecciona alguna de las siguientes opciones:

        • Autenticación básica: proporciona un nombre de usuario y contraseña. Las contraseñas siempre están ocultas en el formulario.
        • Autenticación de agente de servicio: Cuando se habilita un token de identidad para la supervisión agente de servicio. Esta opción solo está disponible para verificaciones HTTPS.
      • Validación del certificado SSL: si seleccionaste HTTPS para una URL. recurso, entonces, de forma predeterminada, el servicio intentará conectarse mediante HTTPS y valida el certificado SSL. Las verificaciones de tiempo de actividad fallan cuando una URL tiene un certificado no válido. Algunos de los motivos para tener un certificado no válido son los siguientes:

        • Un certificado vencido
        • Un certificado autofirmado
        • Un certificado con una discrepancia de nombre de dominio
        • Un certificado que use el acceso a la información de la autoridad (AIA) .

        Para forzar una verificación de tiempo de actividad de HTTPS a fin de validar el certificado SSL, Selecciona Validar certificados SSL.

        Para inhabilitar la validación del certificado SSL, borra Valida certificados SSL.

        Si tienes certificados SSL con Extensiones AIA, debes inhabilitar la validación del certificado SSL. Estos tipos de certificados no son compatibles y fallan en la secuencia de validación. En general, el mensaje de error es “Respuesta con error de protocolo de enlace SSL en 10,000 ms”.

        Puedes usar la métrica monitoring.googleapis.com/uptime_check/time_until_ssl_cert_expires para crear una política de alertas que te notifique que el certificado venza. Para obtener más información, consulta Políticas de muestra: política de verificación de tiempo de actividad.

        Selecciona la casilla de verificación Validar certificados SSL.

  4. Haz clic en Continuar y configura los requisitos de respuesta. Todos los parámetros de configuración de esta sección tienen valores predeterminados:

    • Para cambiar el tiempo de espera de la verificación de tiempo de actividad, usa el Campo Tiempo de espera de respuesta. Una verificación de tiempo de actividad falla cuando no hay se recibe una respuesta de más de una ubicación en este período.

    • Para configurar la verificación de tiempo de actividad a fin de realizar la coincidencia de contenido, Asegúrate de que la etiqueta del botón de activación sea La coincidencia de contenido está habilitada:

      • Selecciona el Tipo de coincidencia del contenido de la respuesta en el menú de opciones. Este campo determina cómo se compara el contenido de la respuesta con los datos que se muestran. Por ejemplo, supongamos que el contenido de la respuesta está abcd y el tipo de concordancia de contenido es Contiene. La verificación de tiempo de actividad solo tiene éxito cuando los datos de respuesta contienen abcd. Para obtener más información, consulta Valida los datos de las respuestas.
      • Ingresa el Contenido de la respuesta. El contenido de la respuesta debe ser una cadena no debe superar los 1,024 bytes. En la API, este campo es el Objeto ContentMatcher.
    • Para evitar que se creen entradas de registro debido a verificaciones de tiempo de actividad, Borra Errores de verificación de registros.

    • Para las verificaciones de tiempo de actividad HTTP, configura los códigos de respuesta aceptables. De forma predeterminada, las verificaciones de tiempo de actividad de HTTP marcan 2xx como respuesta correcta.

  5. Haz clic en Continuar y configura las notificaciones.

    Para recibir una notificación cuando falle una verificación de tiempo de actividad, crea un política de alertas y configurar canales de notificaciones para esa política:

    1. Opcional: Actualiza el nombre de la política de alertas.
    2. Opcional: En el campo Duración, selecciona por cuánto tiempo deben ejecutarse las verificaciones de tiempo de actividad. debe fallar antes de que se envíen las notificaciones. De forma predeterminada, las notificaciones se se envían cuando al menos dos regiones informan errores en las verificaciones de tiempo de actividad de un de al menos un minuto.
    3. En el cuadro Canales de notificaciones, Haz clic en Menú, selecciona los canales que quieres agregar y, luego, haz clic en OK.

      En el menú, los canales de notificaciones se agrupan alfabéticamente para cada tipo de canal.

    Si no quieres crear una política de alertas, asegúrate que el texto del botón de activación sea Do not create an alert.

  6. Haz clic en Continuar y completa tu verificación de tiempo de actividad:

    1. Ingresa un título descriptivo para la verificación de tiempo de actividad.

    2. Opcional: Para agregar etiquetas definidas por el usuario a tu verificación de tiempo de actividad, haz lo siguiente:

      1. Haz clic en Mostrar etiquetas de usuario.
      2. En el campo Clave, ingresa un nombre para la etiqueta. Los nombres de las etiquetas deben comenzar con una letra minúscula y pueden contener letras minúsculas, números, guiones bajos y guiones. Por ejemplo, ingresa severity.
      3. En el campo Valor, ingresa un valor para tu etiqueta. Valores de etiquetas puede contener letras minúsculas, números, guiones bajos y guiones. Por ejemplo, ingresa critical.
      4. Por cada etiqueta adicional, haz clic en Agregar etiqueta de usuario y, luego, ingresa la clave y el valor de la etiqueta de recurso.
    3. Para verificar la configuración de verificación de tiempo de actividad, haz clic en Probar (Test). Si el resultado no es el que esperabas, consulta Verifica fallas. corregir tu configuración y, luego, repetir el paso de verificación.

    4. Haz clic en Crear. Si seleccionas Crear y no tienes un campo obligatorio, se propaga, se muestra un mensaje de error.

gcloud

Para crear la verificación de tiempo de actividad, ejecuta Comando gcloud monitoring uptime create:

gcloud monitoring uptime create DISPLAY_NAME REQUIRED_FLAGS OPTIONAL_FLAGS

Antes de ejecutar el comando anterior, haz lo siguiente:

  • Reemplaza DISPLAY_NAME por el nombre de tu verificación de tiempo de actividad.

  • Configura REQUIRED_FLAGS para especificar el recurso que sondea el la verificación de tiempo de actividad. Por ejemplo, el siguiente comando crea un una verificación de tiempo de actividad que prueba la URL EXAMPLE.com para una proyecto específico:

    gcloud monitoring uptime create DISPLAY_NAME \
    --resource-labels=host=EXAMPLE.com,project_id=PROJECT_ID \
    --resource-type=uptime-url
    

    El comando anterior especifica los valores para cada etiqueta que requiere la tipo de recurso uptime-url.

  • Configura las marcas OPTIONAL_FLAGS para anular el valor predeterminado de salida. Por ejemplo, debes establecer la marca --protocol cuando la no es http.

API

Para crear una verificación de tiempo de actividad, llama al projects.uptimeCheckConfigs.create . Configura los parámetros del método de la siguiente manera:

  • parent: Obligatorio. Este debe ser el nombre del proyecto en el que se creará la verificación de tiempo de actividad. Reemplaza PROJECT_ID por tu ID del proyecto de Google Cloud. El formato es:

    projects/PROJECT_ID
    
  • El cuerpo de la solicitud debe contener un objeto de UptimeCheckConfig para la verificación de tiempo de actividad nueva. En esta página, se proporciona información sobre algunos campos. Para obtener la documentación completa sobre este objeto y sus campos, consulta UptimeCheckConfig:

    • Deja en blanco el campo name del objeto de configuración. El sistema establece este campo cuando se construye el objeto de configuración de respuesta.

    • Si configuras una verificación HTTP o HTTPS, debes propagar el campo HttpCheck del objeto UptimeCheckConfig. En este objeto, configura el campo requestMethod como GET o POST. Si este campo se omite o se establece en METHOD_UNSPECIFIED, se emite una solicitud GET.

      Si quieres configurar una solicitud POST, completa el contentType, opcional customContentType y body.

El método create muestra el objeto UptimeCheckConfig para la nueva configuración.

Si la configuración de tiempo de actividad creada no funciona como se esperaba, consulta la En la sección Verifica fallas de esta página.

C#

Para autenticarte en Monitoring, configura las credenciales predeterminadas de la aplicación. Si deseas obtener más información, consulta Configura la autenticación para un entorno de desarrollo local.

public static object CreateUptimeCheck(string projectId, string hostName,
    string displayName)
{
    // Define a new config.
    var config = new UptimeCheckConfig()
    {
        DisplayName = displayName,
        MonitoredResource = new MonitoredResource()
        {
            Type = "uptime_url",
            Labels = { { "host", hostName } }
        },
        HttpCheck = new UptimeCheckConfig.Types.HttpCheck()
        {
            Path = "/",
            Port = 80,
        },
        Timeout = TimeSpan.FromSeconds(10).ToDuration(),
        Period = TimeSpan.FromMinutes(5).ToDuration()
    };
    // Create a client.
    var client = UptimeCheckServiceClient.Create();
    ProjectName projectName = new ProjectName(projectId);
    // Create the config.
    var newConfig = client.CreateUptimeCheckConfig(
        projectName,
        config,
        CallSettings.FromExpiration(
            Expiration.FromTimeout(
                TimeSpan.FromMinutes(2))));
    Console.WriteLine(newConfig.Name);
    return 0;
}

Java

Para autenticarte en Monitoring, configura las credenciales predeterminadas de la aplicación. Si deseas obtener más información, consulta Configura la autenticación para un entorno de desarrollo local.

private static void createUptimeCheck(
    String projectId, String displayName, String hostName, String pathName) throws IOException {
  CreateUptimeCheckConfigRequest request =
      CreateUptimeCheckConfigRequest.newBuilder()
          .setParent(ProjectName.format(projectId))
          .setUptimeCheckConfig(
              UptimeCheckConfig.newBuilder()
                  .setDisplayName(displayName)
                  .setMonitoredResource(
                      MonitoredResource.newBuilder()
                          .setType("uptime_url")
                          .putLabels("host", hostName))
                  .setHttpCheck(HttpCheck.newBuilder().setPath(pathName).setPort(80))
                  .setTimeout(Duration.newBuilder().setSeconds(10))
                  .setPeriod(Duration.newBuilder().setSeconds(300)))
          .build();
  try (UptimeCheckServiceClient client = UptimeCheckServiceClient.create()) {
    UptimeCheckConfig config = client.createUptimeCheckConfig(request);
    System.out.println("Uptime check created: " + config.getName());
  } catch (Exception e) {
    usage("Exception creating uptime check: " + e.toString());
    throw e;
  }
}

Go

Para autenticarte en Monitoring, configura las credenciales predeterminadas de la aplicación. Si deseas obtener más información, consulta Configura la autenticación para un entorno de desarrollo local.


// createGet creates an example uptime check on a GET request.
func createGet(w io.Writer, projectID string) (*monitoringpb.UptimeCheckConfig, error) {
	ctx := context.Background()
	client, err := monitoring.NewUptimeCheckClient(ctx)
	if err != nil {
		return nil, fmt.Errorf("NewUptimeCheckClient: %w", err)
	}
	defer client.Close()
	req := &monitoringpb.CreateUptimeCheckConfigRequest{
		Parent: "projects/" + projectID,
		UptimeCheckConfig: &monitoringpb.UptimeCheckConfig{
			DisplayName: "new GET uptime check",
			Resource: &monitoringpb.UptimeCheckConfig_MonitoredResource{
				MonitoredResource: &monitoredres.MonitoredResource{
					Type: "uptime_url",
					Labels: map[string]string{
						"host": "example.com",
					},
				},
			},
			CheckRequestType: &monitoringpb.UptimeCheckConfig_HttpCheck_{
				HttpCheck: &monitoringpb.UptimeCheckConfig_HttpCheck{
					RequestMethod: monitoringpb.UptimeCheckConfig_HttpCheck_GET,
					Path:          "/",
					Port:          80,
				},
			},
			Timeout: &duration.Duration{Seconds: 10},
			Period:  &duration.Duration{Seconds: 300},
		},
	}
	config, err := client.CreateUptimeCheckConfig(ctx, req)
	if err != nil {
		return nil, fmt.Errorf("CreateUptimeCheckConfig GET: %w", err)
	}
	fmt.Fprintf(w, "Successfully created GET uptime check %q\n", config.GetDisplayName())
	return config, nil
}

// createPost creates an example uptime check on a POST request.
func createPost(w io.Writer, projectID string) (*monitoringpb.UptimeCheckConfig, error) {
	ctx := context.Background()
	client, err := monitoring.NewUptimeCheckClient(ctx)
	if err != nil {
		return nil, fmt.Errorf("NewUptimeCheckClient: %w", err)
	}
	defer client.Close()
	req := &monitoringpb.CreateUptimeCheckConfigRequest{
		Parent: "projects/" + projectID,
		UptimeCheckConfig: &monitoringpb.UptimeCheckConfig{
			DisplayName: "new POST uptime check",
			Resource: &monitoringpb.UptimeCheckConfig_MonitoredResource{
				MonitoredResource: &monitoredres.MonitoredResource{
					Type: "uptime_url",
					Labels: map[string]string{
						"host": "example.com",
					},
				},
			},
			CheckRequestType: &monitoringpb.UptimeCheckConfig_HttpCheck_{
				HttpCheck: &monitoringpb.UptimeCheckConfig_HttpCheck{
					RequestMethod: monitoringpb.UptimeCheckConfig_HttpCheck_POST,
					ContentType:   monitoringpb.UptimeCheckConfig_HttpCheck_URL_ENCODED,
					Path:          "/",
					Port:          80,
					Body:          []byte(base64.URLEncoding.EncodeToString([]byte("key: value"))),
				},
			},
			Timeout: &duration.Duration{Seconds: 10},
			Period:  &duration.Duration{Seconds: 300},
		},
	}
	config, err := client.CreateUptimeCheckConfig(ctx, req)
	if err != nil {
		return nil, fmt.Errorf("CreateUptimeCheckConfig POST: %w", err)
	}
	fmt.Fprintf(w, "Successfully created POST uptime check %q\n", config.GetDisplayName())
	return config, nil
}

Node.js

Para autenticarte en Monitoring, configura las credenciales predeterminadas de la aplicación. Si deseas obtener más información, consulta Configura la autenticación para un entorno de desarrollo local.

// Imports the Google Cloud client library
const monitoring = require('@google-cloud/monitoring');

// Creates a client
const client = new monitoring.UptimeCheckServiceClient();

/**
 * TODO(developer): Uncomment and edit the following lines of code.
 */
// const projectId = 'YOUR_PROJECT_ID';
// const hostname = 'mydomain.com';

const request = {
  // i.e. parent: 'projects/my-project-id'
  parent: client.projectPath(projectId),
  uptimeCheckConfig: {
    displayName: 'My Uptime Check',
    monitoredResource: {
      // See the Uptime Check docs for supported MonitoredResource types
      type: 'uptime_url',
      labels: {
        host: hostname,
      },
    },
    httpCheck: {
      path: '/',
      port: 80,
    },
    timeout: {
      seconds: 10,
    },
    period: {
      seconds: 300,
    },
  },
};

// Creates an uptime check config for a GCE instance
const [uptimeCheckConfig] = await client.createUptimeCheckConfig(request);
console.log('Uptime check created:');
console.log(`ID: ${uptimeCheckConfig.name}`);
console.log(`Display Name: ${uptimeCheckConfig.displayName}`);
console.log('Resource: %j', uptimeCheckConfig.monitoredResource);
console.log('Period: %j', uptimeCheckConfig.period);
console.log('Timeout: %j', uptimeCheckConfig.timeout);
console.log(`Check type: ${uptimeCheckConfig.check_request_type}`);
console.log(
  'Check: %j',
  uptimeCheckConfig.httpCheck || uptimeCheckConfig.tcpCheck
);
console.log(
  `Content matchers: ${uptimeCheckConfig.contentMatchers
    .map(matcher => matcher.content)
    .join(', ')}`
);
console.log(`Regions: ${uptimeCheckConfig.selectedRegions.join(', ')}`);

PHP

Para autenticarte en Monitoring, configura las credenciales predeterminadas de la aplicación. Si deseas obtener más información, consulta Configura la autenticación para un entorno de desarrollo local.

use Google\Api\MonitoredResource;
use Google\Cloud\Monitoring\V3\Client\UptimeCheckServiceClient;
use Google\Cloud\Monitoring\V3\CreateUptimeCheckConfigRequest;
use Google\Cloud\Monitoring\V3\UptimeCheckConfig;

/**
 * Example:
 * ```
 * create_uptime_check($projectId, 'myproject.appspot.com', 'Test Uptime Check!');
 * ```
 *
 * @param string $projectId Your project ID
 * @param string $hostName
 * @param string $displayName
 */
function create_uptime_check($projectId, $hostName = 'example.com', $displayName = 'New uptime check')
{
    $projectName = 'projects/' . $projectId;
    $uptimeCheckClient = new UptimeCheckServiceClient([
        'projectId' => $projectId,
    ]);

    $monitoredResource = new MonitoredResource();
    $monitoredResource->setType('uptime_url');
    $monitoredResource->setLabels(['host' => $hostName]);

    $uptimeCheckConfig = new UptimeCheckConfig();
    $uptimeCheckConfig->setDisplayName($displayName);
    $uptimeCheckConfig->setMonitoredResource($monitoredResource);
    $createUptimeCheckConfigRequest = (new CreateUptimeCheckConfigRequest())
        ->setParent($projectName)
        ->setUptimeCheckConfig($uptimeCheckConfig);

    $uptimeCheckConfig = $uptimeCheckClient->createUptimeCheckConfig($createUptimeCheckConfigRequest);

    printf('Created an uptime check: %s' . PHP_EOL, $uptimeCheckConfig->getName());
}

Python

Para autenticarte en Monitoring, configura las credenciales predeterminadas de la aplicación. Si deseas obtener más información, consulta Configura la autenticación para un entorno de desarrollo local.

def create_uptime_check_config_get(
    project_id: str, host_name: str = None, display_name: str = None
) -> uptime.UptimeCheckConfig:
    """Creates a new uptime check configuration

    Args:
        project_id: Google Cloud project id where the uptime check is created
        host_name: An example label's value for the "host" label
        display_name: A human friendly name of the configuration

    Returns:
        A structure that describes a new created uptime check
    """
    config = monitoring_v3.UptimeCheckConfig()
    config.display_name = display_name or "New GET uptime check"
    config.monitored_resource = {
        "type": "uptime_url",
        "labels": {"host": host_name or "example.com"},
    }
    config.http_check = {
        "request_method": monitoring_v3.UptimeCheckConfig.HttpCheck.RequestMethod.GET,
        "path": "/",
        "port": 80,
    }
    config.timeout = {"seconds": 10}
    config.period = {"seconds": 300}

    client = monitoring_v3.UptimeCheckServiceClient()
    new_config = client.create_uptime_check_config(
        request={"parent": project_id, "uptime_check_config": config}
    )
    pprint.pprint(new_config)
    return new_config


def create_uptime_check_config_post(
    project_id: str, host_name: str = None, display_name: str = None
) -> uptime.UptimeCheckConfig:
    """Creates a new uptime check configuration

    Args:
        project_id: Google Cloud project id where the uptime check is created
        host_name: An example label's value for the "host" label
        display_name: A human friendly name of the configuration

    Returns:
        A structure that describes a new created uptime check
    """
    config = monitoring_v3.UptimeCheckConfig()
    config.display_name = display_name or "New POST uptime check"
    config.monitored_resource = {
        "type": "uptime_url",
        "labels": {"host": host_name or "example.com"},
    }
    config.http_check = {
        "request_method": monitoring_v3.UptimeCheckConfig.HttpCheck.RequestMethod.POST,
        "content_type": monitoring_v3.UptimeCheckConfig.HttpCheck.ContentType.URL_ENCODED,
        "body": "foo=bar".encode("utf-8"),
        "path": "/",
        "port": 80,
    }
    config.timeout = {"seconds": 10}
    config.period = {"seconds": 300}

    client = monitoring_v3.UptimeCheckServiceClient()
    new_config = client.create_uptime_check_config(
        request={"parent": project_id, "uptime_check_config": config}
    )
    pprint.pprint(new_config)
    return new_config

Ruby

Para autenticarte en Monitoring, configura las credenciales predeterminadas de la aplicación. Si deseas obtener más información, consulta Configura la autenticación para un entorno de desarrollo local.

def create_uptime_check_config project_id: nil, host_name: nil, display_name: nil
  require "google/cloud/monitoring"

  client = Google::Cloud::Monitoring.uptime_check_service
  project_name = client.project_path project: project_id
  config = {
    display_name:       display_name.nil? ? "New uptime check" : display_name,
    monitored_resource: {
      type:   "uptime_url",
      labels: { "host" => host_name.nil? ? "example.com" : host_name }
    },
    http_check:         { path: "/", port: 80 },
    timeout:            { seconds: 10 },
    period:             { seconds: 300 }
  }
  new_config = client.create_uptime_check_config \
    parent:              project_name,
    uptime_check_config: config
  puts new_config.name
  new_config
end

Terraform

Si deseas obtener más información para aplicar o quitar una configuración de Terraform, consulta los comandos básicos de Terraform. Para obtener más información, consulta la documentación de referencia del proveedor de Terraform.

Para crear una verificación de tiempo de actividad y una política de alertas para supervisar esa verificación, haz lo siguiente:

  1. Edita tu archivo de configuración de Terraform y agrega una google_monitoring_uptime_check_config y, luego, aplicar el archivo de configuración.

    En el siguiente ejemplo, se muestra una configuración que verifica un URL pública:

    resource "google_monitoring_uptime_check_config" "example" {
        display_name = "example"
        timeout      = "60s"
    
        http_check {
            port = "80"
            request_method = "GET"
        }
    
        monitored_resource {
            type = "uptime_url"
            labels = {
                project_id = "PROJECT_ID"
                host="EXAMPLE.com"
            }
        }
    
        checker_type = "STATIC_IP_CHECKERS"
    }
    
  2. Opcional: Crea un canal de notificaciones y una política de alertas:

    En los siguientes pasos, se usa la consola de Google Cloud para crear la notificación y la política de alertas. Este enfoque garantiza que la política de alertas solo supervisa los datos que genera tu verificación de tiempo de actividad.

    1. Para crear un canal de notificaciones, 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. Selecciona Administrar canales de notificaciones.
      3. Ve al tipo de canal que quieres agregar, haz clic en Agregar y y, luego, completarás el cuadro de diálogo.
    2. Para crear una política de alertas, sigue estos pasos:

      1. En la consola de Google Cloud, ve a la página  Verificaciones de tiempo de actividad:

        Ve a Verificaciones de tiempo de actividad

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

      2. Busca tu verificación de tiempo de actividad y selecciona Más. y, luego, selecciona Agregar política de alertas.
      3. En el cuadro de diálogo, ve a la sección Notificaciones y nombre. Expande Canales de notificaciones y realiza tus selecciones.
      4. Asigna un nombre a la política de alertas y, luego, haz clic en Crear política.

    Para crear una política de alertas, agrega un google_monitoring_alert_policy recurso a tu archivo de configuración y aplicar la configuración nueva.

Puede haber un retraso de hasta 5 minutos antes de que comience el flujo de los resultados de la verificación de tiempo de actividad en Monitoring. Durante ese tiempo, el panel de verificación de tiempo de actividad informa el estado como "sin datos disponibles".

Usa pings de ICMP

Para solucionar problemas en las verificaciones de tiempo de actividad públicas con errores, tus verificaciones de tiempo de actividad para enviar hasta 3 Pings de ICMP durante la verificación Los pings pueden ayudarte a distinguir entre fallas causadas, por ejemplo, por problemas de conectividad de red y por tiempos de espera en tu aplicación.

De forma predeterminada, las verificaciones de tiempo de actividad no envían pings. Cada ping agrega algunos la latencia de la verificación de tiempo de actividad. Las verificaciones de tiempo de actividad privadas no pueden enviar pings.

Cuando falla una verificación de tiempo de actividad pública, los resultados de los pings se escriben en registros de Cloud Logging. Si el ping falla, se agregan los siguientes campos al campo httpRequest en la entrada de registro:

  • rtt_usec: Es el tiempo de ida y vuelta de cada solicitud de ping fallida.
  • unreachable_count: La cantidad de solicitudes de ping que mostraron el valor código de estado ICMP_DEST_UNREACH.
  • no_answer_count: La cantidad de solicitudes de ping que se agotó el tiempo de espera y no mostró ninguna respuesta.

Los resultados de los pings de las verificaciones de tiempo de actividad correctas no se registran.

Configura pings

Cada configuración de verificación de tiempo de actividad incluye lo siguiente: un objeto HttpCheck o un objeto TcpCheck. Ambos objetos incluyen un campo pingConfig. Usa este campo para especificar la cantidad de pings de ICMP que se incluirán en cada verificación. hasta 3. De forma predeterminada, no se envían pings.

Para configurar los pings, realiza una de las siguientes acciones:

Verifica tu tiempo de actividad

Cuando creas una verificación de tiempo de actividad en la consola de Google Cloud, puedes probar la configuración antes de guardarla.

Verificaciones correctas

Una verificación de tiempo de actividad es exitosa cuando se cumplen las siguientes condiciones:

  • El estado HTTP coincide con los criterios que seleccionaste.
  • La respuesta no tiene contenido obligatorio o, una búsqueda de la respuesta para el contenido obligatorio es correcto.

Verificaciones con errores

Las siguientes son algunas de las posibles causas de una falla en la verificación del tiempo de actividad:

  • Error de conexión: rechazado: si utilizas el tipo de conexión HTTP predeterminado, verifica que tengas instalado un servidor web que responda a las solicitudes HTTP. Puede ocurrir un error de conexión en una instancia nueva si no has instalado un servidor web; consulta la Guía de inicio rápido para Compute Engine. Si usas un tipo de conexión HTTPS, es posible que debas realizar pasos de configuración adicionales. Para problemas de firewall, consulta Enumera las direcciones IP de los servidores de verificación de tiempo de actividad.
  • Nombre o servicio no encontrado: el nombre de host puede ser incorrecto.
  • 403 Prohibido: El servicio muestra un código de error al verificador de tiempo de actividad. Por ejemplo, la configuración predeterminada de Apache Web Server muestra este código en Amazon Linux, pero aparece el código 200 (Success) en algunas otras versiones de Linux. Consulta la Instructivo de LAMP para Amazon Linux o la documentación de tu servidor web.
  • 404 No encontrado: la ruta de acceso podría ser incorrecta.
  • 408 Tiempo de espera de solicitud o no hay respuesta: el número de puerto puede ser incorrecto, el servicio puede no estar ejecutándose, no se puede acceder al servicio o el tiempo de espera puede ser demasiado bajo. Comprueba que el firewall permite el tráfico de los servidores de tiempo de actividad; ver Enumera las direcciones IP de los servidores de verificación de tiempo de actividad. El límite de tiempo de espera se especifica como parte de la Validación de respuestas opciones de estado.

Si tu verificación de tiempo de actividad está configurada para enviar pings, los resultados de los pings de y las verificaciones de tiempo de actividad fallidas se escriben en Cloud Logging. Para obtener más información, consulta Usa pings de ICMP.

¿Qué sigue?