Esta página se ha traducido con Cloud Translation API.

Gestionar comprobaciones de disponibilidad del servicio

En este documento se describe cómo gestionar las comprobaciones de tiempo de actividad mediante laGoogle Cloud consola, la CLI de Google Cloud, la API de Cloud Monitoring y las bibliotecas de cliente.

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 tus comprobaciones de tiempo de actividad:

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.
C#

Para usar las .NET muestras de esta página en un entorno de desarrollo local, instala e inicializa la CLI de gcloud y, a continuación, configura las credenciales predeterminadas de la aplicación con tus credenciales de usuario.
Para obtener más información, consulta Configurar ADC en un entorno de desarrollo local en la documentación de autenticación Google Cloud .
Go

Para usar las Go muestras de esta página en un entorno de desarrollo local, instala e inicializa la CLI de gcloud y, a continuación, configura las credenciales predeterminadas de la aplicación con tus credenciales de usuario.
Para obtener más información, consulta Configurar ADC en un entorno de desarrollo local en la documentación de autenticación Google Cloud .
Java

Para usar las Java muestras de esta página en un entorno de desarrollo local, instala e inicializa la CLI de gcloud y, a continuación, configura las credenciales predeterminadas de la aplicación con tus credenciales de usuario.
Para obtener más información, consulta Configurar ADC en un entorno de desarrollo local en la documentación de autenticación Google Cloud .
Node.js

Para usar las Node.js muestras de esta página en un entorno de desarrollo local, instala e inicializa la CLI de gcloud y, a continuación, configura las credenciales predeterminadas de la aplicación con tus credenciales de usuario.
Para obtener más información, consulta Configurar ADC en un entorno de desarrollo local en la documentación de autenticación Google Cloud .
PHP

Para usar las PHP muestras de esta página en un entorno de desarrollo local, instala e inicializa la CLI de gcloud y, a continuación, configura las credenciales predeterminadas de la aplicación con tus credenciales de usuario.
Para obtener más información, consulta Configurar ADC en un entorno de desarrollo local en la documentación de autenticación Google Cloud .
Python

Para usar las Python muestras de esta página en un entorno de desarrollo local, instala e inicializa la CLI de gcloud y, a continuación, configura las credenciales predeterminadas de la aplicación con tus credenciales de usuario.
Para obtener más información, consulta Configurar ADC en un entorno de desarrollo local en la documentación de autenticación Google Cloud .
Ruby

Para usar las Ruby muestras de esta página en un entorno de desarrollo local, instala e inicializa la CLI de gcloud y, a continuación, configura las credenciales predeterminadas de la aplicación con tus credenciales de usuario.
Para obtener más información, consulta Configurar ADC en un entorno de desarrollo local en la documentación de autenticación Google Cloud .
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.
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 todas las comprobaciones de disponibilidad del servicio

Consola

En la Google Cloud consola, ve a la página Comprobaciones de tiempo de actividad:
Ve a Comprobaciones de disponibilidad del servicio.

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

En el siguiente ejemplo se muestra una página de Comprobaciones de disponibilidad de ejemplo:

Nota: En los paneles de control se indica que no hay datos disponibles en las comprobaciones de tiempo de actividad recién creadas. Este mensaje se elimina cuando llegan los datos. El tiempo de espera máximo para esta fase es de 5 minutos.
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.
(Opcional) Para restringir las comprobaciones de tiempo de actividad que se muestran, añada filtros.

Cada filtro se compone de un nombre y un valor. Puede definir el valor para que sea una concordancia exacta con el nombre de una comprobación de tiempo de actividad o una concordancia parcial. Las coincidencias no distinguen entre mayúsculas y minúsculas. Por ejemplo, para enumerar todas las comprobaciones de disponibilidad cuyo nombre contenga default, haz 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.

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 tus comprobaciones de tiempo de actividad y tus monitores sintéticos, llama al método projects.uptimeCheckConfigs.list. Especifica los siguientes parámetros:

parent: obligatorio. El proyecto cuyas comprobaciones de disponibilidad se van a mostrar. 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. Este campo tiene el siguiente formato:
```
projects/PROJECT_ID
```

C#

Para autenticarte en Monitoring, configura las credenciales predeterminadas de la aplicación. Para obtener más información, consulta el artículo Configurar la autenticación en un entorno de desarrollo local.

public static object ListUptimeCheckConfigs(string projectId)
{
    var client = UptimeCheckServiceClient.Create();
    var configs = client.ListUptimeCheckConfigs(new ProjectName(projectId));
    foreach (UptimeCheckConfig config in configs)
    {
        Console.WriteLine(config.Name);
    }
    return 0;
}

Java

private static void listUptimeChecks(String projectId) throws IOException {
  ListUptimeCheckConfigsRequest request =
      ListUptimeCheckConfigsRequest.newBuilder().setParent(ProjectName.format(projectId)).build();
  try (UptimeCheckServiceClient client = UptimeCheckServiceClient.create()) {
    ListUptimeCheckConfigsPagedResponse response = client.listUptimeCheckConfigs(request);
    for (UptimeCheckConfig config : response.iterateAll()) {
      System.out.println(config.getDisplayName());
    }
  } catch (Exception e) {
    usage("Exception listing uptime checks: " + e.toString());
    throw e;
  }
}

Go


// list is an example of listing the uptime checks in projectID.
func list(w io.Writer, projectID string) error {
	ctx := context.Background()
	client, err := monitoring.NewUptimeCheckClient(ctx)
	if err != nil {
		return fmt.Errorf("NewUptimeCheckClient: %w", err)
	}
	defer client.Close()
	req := &monitoringpb.ListUptimeCheckConfigsRequest{
		Parent: "projects/" + projectID,
	}
	it := client.ListUptimeCheckConfigs(ctx, req)
	for {
		config, err := it.Next()
		if err == iterator.Done {
			break
		}
		if err != nil {
			return fmt.Errorf("ListUptimeCheckConfigs: %w", err)
		}
		fmt.Fprintln(w, config)
	}
	fmt.Fprintln(w, "Done listing uptime checks")
	return nil
}

Node.js

// 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 request = {
  parent: client.projectPath(projectId),
};

// Retrieves an uptime check config
const [uptimeCheckConfigs] = await client.listUptimeCheckConfigs(request);

uptimeCheckConfigs.forEach(uptimeCheckConfig => {
  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

use Google\Cloud\Monitoring\V3\Client\UptimeCheckServiceClient;
use Google\Cloud\Monitoring\V3\ListUptimeCheckConfigsRequest;

/**
 * Example:
 * ```
 * list_uptime_checks($projectId);
 * ```
 */
function list_uptime_checks(string $projectId): void
{
    $projectName = 'projects/' . $projectId;
    $uptimeCheckClient = new UptimeCheckServiceClient([
        'projectId' => $projectId,
    ]);
    $listUptimeCheckConfigsRequest = (new ListUptimeCheckConfigsRequest())
        ->setParent($projectName);

    $pages = $uptimeCheckClient->listUptimeCheckConfigs($listUptimeCheckConfigsRequest);

    foreach ($pages->iteratePages() as $page) {
        foreach ($page as $uptimeCheck) {
            print($uptimeCheck->getName() . PHP_EOL);
        }
    }
}

Python

def list_uptime_check_configs(project_id: str) -> pagers.ListUptimeCheckConfigsPager:
    """Gets all uptime checks defined in the Google Cloud project

    Args:
        project_id: Google Cloud project id

    Returns:
        A list of configurations.
        Iterating over this object will yield results and resolve additional pages automatically.
    """
    client = monitoring_v3.UptimeCheckServiceClient()
    configs = client.list_uptime_check_configs(request={"parent": project_id})

    for config in configs:
        pprint.pprint(config)
    return configs

Ruby

gem "google-cloud-monitoring"
require "google/cloud/monitoring"

def list_uptime_check_configs project_id
  client = Google::Cloud::Monitoring.uptime_check_service
  project_name = client.project_path project: project_id
  configs = client.list_uptime_check_configs parent: project_name

  configs.each { |config| puts config.name }
end

Ver los detalles de una comprobación de disponibilidad del servicio

Consola

En la Google Cloud consola, ve a la página Comprobaciones de tiempo de actividad:
Ve a Comprobaciones de disponibilidad del servicio.

Si usas la barra de búsqueda para encontrar esta página, selecciona el resultado cuya sección sea Monitorización.
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.
Busca la comprobación de tiempo de actividad que quieras ver y haz clic en su nombre.

En la siguiente captura de pantalla se muestran los detalles de la disponibilidad de una comprobación de disponibilidad con el nombre "Testing check":

La página Detalles del tiempo de actividad contiene la siguiente información:
- El intervalo de tiempo seleccionado. De forma predeterminada, el intervalo es de 1 hora.
- Nombre de la comprobación de disponibilidad. En el ejemplo, el nombre es Prueba de comprobación.
- Las etiquetas que has añadido a la comprobación de disponibilidad.
- El porcentaje de tiempo de actividad y la latencia media. El valor Porcentaje de tiempo de actividad es un porcentaje que se calcula como (S/T)*100, donde S es el número de respuestas de comprobación correctas y T es el número total de respuestas de comprobación de todas las ubicaciones. En las comprobaciones de grupos, los valores de S y T se suman en todos los miembros del grupo actual.
  
  Por ejemplo, durante un periodo de 25 minutos, una comprobación de tiempo de actividad con un periodo de un minuto que se ejecute desde todas las regiones recibirá 25 solicitudes de cada una de las 6 ubicaciones, lo que supone un total de 150 solicitudes. Si el panel de control indica un tiempo de actividad del 83,3 %, significa que se han completado 125 de las 150 solicitudes.
- Los paneles Comprobaciones superadas y Latencia de comprobación de disponibilidad del servicio muestran gráficamente el número de comprobaciones superadas y la latencia de cada comprobación en función del tiempo.
- En el panel Estado actual se muestra el estado de las comprobaciones más recientes. Un círculo verde con una marca de verificación junto a una región indica que la última ejecución de la comprobación en esa región se ha completado correctamente. Un círculo rojo con una X indica que ha fallado. Si has habilitado el registro de los fallos de las comprobaciones de disponibilidad, el panel contiene un enlace Ver registros.
- En el panel Configuración se muestra la configuración de la comprobación de disponibilidad. Estos datos se asignan cuando se crea la comprobación de disponibilidad. El valor Check Id corresponde al valor CHECK_ID en las llamadas a la API.
- En el panel Políticas de alertas se muestra información sobre las políticas de alertas asociadas. En el panel de ejemplo, se ha configurado una política de alertas.

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: el identificador de la comprobación del tiempo de actividad o de la monitorización sintética. 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.

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 enumerar los detalles de una comprobación de tiempo de actividad o de un monitor sintético, llama al método projects.uptimeCheckConfigs.get. Especifica el siguiente parámetro:

name: el nombre completo de la configuración de la comprobación de disponibilidad del servicio.
```
projects/PROJECT_ID/uptimeCheckConfigs/CHECK_ID
```
En la expresión anterior:
- PROJECT_ID es el proyecto que almacena la comprobación de disponibilidad. 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 identificador de la comprobación de disponibilidad o del monitor sintético. Para obtener más información, consulta Buscar el identificador único de una comprobación de disponibilidad del servicio.

C#

public static object GetUptimeCheckConfig(string configName)
{
    var client = UptimeCheckServiceClient.Create();
    UptimeCheckConfig config = client.GetUptimeCheckConfig(configName);
    if (config == null)
    {
        Console.Error.WriteLine(
            "No configuration found with the name {0}", configName);
        return -1;
    }
    Console.WriteLine("Name: {0}", config.Name);
    Console.WriteLine("Display Name: {0}", config.DisplayName);
    Console.WriteLine("Http Path: {0}", config.HttpCheck.Path);
    return 0;
}

Java

private static void getUptimeCheckConfig(String checkName) throws IOException {
  // Create UptimeCheckServiceSettings instance for add retry mechanism
  UptimeCheckServiceSettings.Builder uptimeCheckServiceSettingsBuilder =
      UptimeCheckServiceSettings.newBuilder();
  uptimeCheckServiceSettingsBuilder
      .getUptimeCheckConfigSettings()
      .setRetrySettings(
          uptimeCheckServiceSettingsBuilder
              .getUptimeCheckConfigSettings()
              .getRetrySettings()
              .toBuilder()
              .setInitialRetryDelay(org.threeten.bp.Duration.ofMillis(100L))
              .setRetryDelayMultiplier(1.3)
              .setMaxRetryDelay(MAX_RECONNECT_BACKOFF_TIME)
              .setInitialRpcTimeout(MAX_RECONNECT_BACKOFF_TIME)
              .setRpcTimeoutMultiplier(1.0)
              .setMaxRpcTimeout(MAX_RECONNECT_BACKOFF_TIME)
              .setTotalTimeout(MAX_RECONNECT_BACKOFF_TIME)
              .setMaxAttempts(6)
              .build());
  UptimeCheckServiceSettings uptimeCheckServiceSettings =
      uptimeCheckServiceSettingsBuilder.build();

  // create UptimeCheckServiceClient with retry setting
  try (UptimeCheckServiceClient client =
      UptimeCheckServiceClient.create(uptimeCheckServiceSettings)) {
    UptimeCheckConfig config = client.getUptimeCheckConfig(checkName);
    if (config != null) {
      System.out.println(config.toString());
    } else {
      System.out.println("No uptime check config found with ID " + checkName);
    }
  } catch (Exception e) {
    usage("Exception getting uptime check: " + e.toString());
    throw e;
  }
}

Go


// get is an example of getting an uptime check. resourceName should be
// of the form `projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID]`.
func get(w io.Writer, resourceName 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.GetUptimeCheckConfigRequest{
		Name: resourceName,
	}
	config, err := client.GetUptimeCheckConfig(ctx, req)
	if err != nil {
		return nil, fmt.Errorf("GetUptimeCheckConfig: %w", err)
	}
	fmt.Fprintf(w, "Config: %v", config)
	return config, nil
}

Node.js

// 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 uptimeCheckConfigId = 'YOUR_UPTIME_CHECK_CONFIG_ID';

const request = {
  // i.e. name: 'projects/my-project-id/uptimeCheckConfigs/My-Uptime-Check
  name: client.projectUptimeCheckConfigPath(projectId, uptimeCheckConfigId),
};

console.log(`Retrieving ${request.name}`);

// Retrieves an uptime check config
const [uptimeCheckConfig] = await client.getUptimeCheckConfig(request);
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

use Google\Cloud\Monitoring\V3\Client\UptimeCheckServiceClient;
use Google\Cloud\Monitoring\V3\GetUptimeCheckConfigRequest;

/**
 * Example:
 * ```
 * get_uptime_check($projectId, $configName);
 * ```
 *
 * @param string $projectId Your project ID
 * @param string $configName
 */
function get_uptime_check($projectId, $configName)
{
    $uptimeCheckClient = new UptimeCheckServiceClient([
        'projectId' => $projectId,
    ]);
    $getUptimeCheckConfigRequest = (new GetUptimeCheckConfigRequest())
        ->setName($configName);

    $uptimeCheck = $uptimeCheckClient->getUptimeCheckConfig($getUptimeCheckConfigRequest);

    print('Retrieved an uptime check:' . PHP_EOL);
    print($uptimeCheck->serializeToJsonString() . PHP_EOL);
}

Python

def get_uptime_check_config(config_name: str) -> uptime.UptimeCheckConfig:
    """Reads the uptime check configuration

    Args:
        config_name: Uptime check configuration identity

    Returns:
        A structure that describes the updated uptime check
    """
    client = monitoring_v3.UptimeCheckServiceClient()
    config = client.get_uptime_check_config(request={"name": config_name})
    pprint.pprint(config)
    return config

Ruby

gem "google-cloud-monitoring"
require "google/cloud/monitoring"

def get_uptime_check_config config_name
  client = Google::Cloud::Monitoring.uptime_check_service
  config = client.get_uptime_check_config name: config_name
  pp config.to_h
  config
end

Editar una comprobación de disponibilidad del servicio

Puedes modificar algunos campos de una comprobación de tiempo de actividad. Por ejemplo, puede que quieras que la comprobación se realice con más frecuencia o que quieras aumentar el tiempo de espera asociado a la validación de la respuesta. Sin embargo, si la comprobación de disponibilidad no está configurada con el protocolo, el tipo de recurso o el recurso correctos, elimine la comprobación de disponibilidad actual y cree una nueva.

Para obtener información sobre cómo editar una política de alertas que monitoriza una comprobación de disponibilidad, consulta los siguientes documentos:

Para editar una comprobación de tiempo de actividad pública, puedes seguir el proceso que se indica en cualquiera de las siguientes pestañas. Para editar una comprobación de tiempo de actividad privada, usa la pestaña Consola o API:

Consola

En la Google Cloud consola, ve a la página Comprobaciones de tiempo de actividad:
Ve a Comprobaciones de disponibilidad del servicio.

Si usas la barra de búsqueda para encontrar esta página, selecciona el resultado cuya sección sea Monitorización.
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.
Busca la comprobación de tiempo de actividad que quieras editar y, a continuación, haz una de las siguientes acciones:
- Haz clic en Más y selecciona Editar.
- Consulta los detalles de la comprobación de tiempo de actividad y, a continuación, haz clic en Editar.
Cambia los valores de los campos según sea necesario. No puedes modificar todos los campos. Si los valores de las cabeceras personalizadas de una comprobación están ocultos, no podrás hacer que se muestren.
Para comprobar si la verificación funciona, haz clic en Probar. Si la prueba falla, consulta la sección Comprobaciones fallidas para ver las posibles causas.
Haz clic en Guardar.

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: el identificador de la comprobación del tiempo de actividad o de la monitorización sintética. 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.

También debe definir los campos que quiere modificar.

Por ejemplo, para definir el periodo de una comprobación de tiempo de actividad en 10 minutos, ejecuta el siguiente comando:

gcloud monitoring uptime update CHECK_ID --period=10

REST

Llama al método projects.uptimeCheckConfigs.patch. Define los parámetros del método de la siguiente manera:

uptimeCheckConfig.name obligatorio. Forma parte de la URL de REST. Es el nombre de recurso de la comprobación de disponibilidad del servicio que se va a editar:
```
projects/PROJECT_ID/uptimeCheckConfigs/CHECK_ID
```
En la expresión anterior:
- PROJECT_ID es el proyecto que almacena la comprobación de disponibilidad. 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 identificador de la comprobación de disponibilidad o del monitor sintético. Para obtener más información, consulta Buscar el identificador único de una comprobación de disponibilidad del servicio.
updateMask: opcional. Este es un parámetro de consulta: ?updateMask=[FIELD_LIST]. [FIELD_LIST] es una lista separada por comas de campos del objeto UptimeCheckConfig que se deben cambiar. Por ejemplo:
```
"resource.type,httpCheck.path"
```
El cuerpo de la solicitud debe contener un UptimeCheckConfig con los nuevos valores de los campos.

Si se define updateMask, solo los campos que se incluyan en updateMask sustituirán a los campos correspondientes de la configuración actual. Si un campo tiene subcampos y se incluye en la máscara de campo, pero no se incluye ninguno de sus subcampos, todos los subcampos de ese campo sustituirán a los campos correspondientes.

Si no se define updateMask, la configuración del cuerpo de la solicitud sustituye a toda la configuración actual.

El método patch devuelve el objeto UptimeCheckConfig de la configuración modificada.

C#

public static object UpdateUptimeCheck(string configName,
    string newHttpPath, string newDisplayName)
{
    var client = UptimeCheckServiceClient.Create();
    var config = client.GetUptimeCheckConfig(configName);
    var fieldMask = new FieldMask();
    if (newDisplayName != null)
    {
        config.DisplayName = newDisplayName;
        fieldMask.Paths.Add("display_name");
    }
    if (newHttpPath != null)
    {
        config.HttpCheck.Path = newHttpPath;
        fieldMask.Paths.Add("http_check.path");
    }
    client.UpdateUptimeCheckConfig(config);
    return 0;
}

Java

private static void updateUptimeCheck(String checkName, String hostName, String pathName)
    throws IOException {

  UpdateUptimeCheckConfigRequest request =
      UpdateUptimeCheckConfigRequest.newBuilder()
          .setUpdateMask(FieldMask.newBuilder().addPaths("http_check.path"))
          .setUptimeCheckConfig(
              UptimeCheckConfig.newBuilder()
                  .setName(checkName)
                  .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.updateUptimeCheckConfig(request);
    System.out.println("Uptime check updated: \n" + config.toString());
  } catch (Exception e) {
    usage("Exception updating uptime check: " + e.toString());
    throw e;
  }
}

Go


// update is an example of updating an uptime check. resourceName should be
// of the form `projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID]`.
func update(w io.Writer, resourceName, displayName, httpCheckPath 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()
	getReq := &monitoringpb.GetUptimeCheckConfigRequest{
		Name: resourceName,
	}
	config, err := client.GetUptimeCheckConfig(ctx, getReq)
	if err != nil {
		return nil, fmt.Errorf("GetUptimeCheckConfig: %w", err)
	}
	config.DisplayName = displayName
	config.GetHttpCheck().Path = httpCheckPath
	req := &monitoringpb.UpdateUptimeCheckConfigRequest{
		UpdateMask: &field_mask.FieldMask{
			Paths: []string{"display_name", "http_check.path"},
		},
		UptimeCheckConfig: config,
	}
	config, err = client.UpdateUptimeCheckConfig(ctx, req)
	if err != nil {
		return nil, fmt.Errorf("UpdateUptimeCheckConfig: %w", err)
	}
	fmt.Fprintf(w, "Successfully updated %v", resourceName)
	return config, nil
}

Node.js

// 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 uptimeCheckConfigId = 'YOUR_UPTIME_CHECK_CONFIG_ID';
// const displayName = 'A New Display Name';
// const path = '/some/path';

const request = {
  // i.e. name: 'projects/my-project-id/uptimeCheckConfigs/My-Uptime-Check
  name: client.projectUptimeCheckConfigPath(projectId, uptimeCheckConfigId),
};

console.log(`Updating ${request.name} to ${displayName}`);

// Updates the display name and path on an uptime check config
request.uptimeCheckConfig = {
  name: request.name,
  displayName: displayName,
  httpCheck: {
    path: path,
  },
};

request.updateMask = {
  paths: ['display_name', 'http_check.path'],
};

const [response] = await client.updateUptimeCheckConfig(request);
console.log(`${response.name} config updated.`);

PHP

use Google\Cloud\Monitoring\V3\Client\UptimeCheckServiceClient;
use Google\Cloud\Monitoring\V3\GetUptimeCheckConfigRequest;
use Google\Cloud\Monitoring\V3\UpdateUptimeCheckConfigRequest;
use Google\Protobuf\FieldMask;

/**
 * Example:
 * ```
 * update_uptime_checks($projectId);
 * ```
 */
function update_uptime_checks(
    string $projectId,
    string $configName,
    string $newDisplayName = null,
    string $newHttpCheckPath = null
): void {
    $uptimeCheckClient = new UptimeCheckServiceClient([
        'projectId' => $projectId,
    ]);
    $getUptimeCheckConfigRequest = (new GetUptimeCheckConfigRequest())
        ->setName($configName);

    $uptimeCheck = $uptimeCheckClient->getUptimeCheckConfig($getUptimeCheckConfigRequest);
    $fieldMask = new FieldMask();
    if ($newDisplayName) {
        $fieldMask->getPaths()[] = 'display_name';
        $uptimeCheck->setDisplayName($newDisplayName);
    }
    if ($newHttpCheckPath) {
        $paths = $fieldMask->getPaths()[] = 'http_check.path';
        $uptimeCheck->getHttpCheck()->setPath($newHttpCheckPath);
    }
    $updateUptimeCheckConfigRequest = (new UpdateUptimeCheckConfigRequest())
        ->setUptimeCheckConfig($uptimeCheck)
        ->setUpdateMask($fieldMask);

    $uptimeCheckClient->updateUptimeCheckConfig($updateUptimeCheckConfigRequest);

    print($uptimeCheck->serializeToString() . PHP_EOL);
}

Python

def update_uptime_check_config(
    config_name: str, new_display_name: str = None, new_http_check_path: str = None
) -> uptime.UptimeCheckConfig:
    """Creates a new uptime check configuration

    Args:
        config_name: Uptime check configuration identity
        new_display_name: A new human friendly name of the configuration
        new_http_check_path: A new HTTP endpoint of the configuration

    Returns:
        A structure that describes the updated uptime check
    """
    client = monitoring_v3.UptimeCheckServiceClient()
    config = client.get_uptime_check_config(request={"name": config_name})
    field_mask = field_mask_pb2.FieldMask()
    if new_display_name:
        field_mask.paths.append("display_name")
        config.display_name = new_display_name
    if new_http_check_path:
        field_mask.paths.append("http_check.path")
        config.http_check.path = new_http_check_path
    changed_config = client.update_uptime_check_config(
        request={"uptime_check_config": config, "update_mask": field_mask}
    )
    pprint.pprint(changed_config)
    return changed_config

Ruby

gem "google-cloud-monitoring"
require "google/cloud/monitoring"

def update_uptime_check_config config_name:         nil,
                               new_display_name:    nil,
                               new_http_check_path: nil
  client = Google::Cloud::Monitoring.uptime_check_service
  config = { name: config_name }
  field_mask = { paths: [] }
  unless new_display_name.to_s.empty?
    field_mask[:paths].push "display_name"
    config[:display_name] = new_display_name
  end
  unless new_http_check_path.to_s.empty?
    field_mask[:paths].push "http_check.path"
    config[:http_check] = { path: new_http_check_path }
  end
  client.update_uptime_check_config uptime_check_config: config,
                                    update_mask:         field_mask
end

Los resultados de la nueva comprobación del tiempo de actividad pueden tardar hasta 5 minutos en aparecer. Durante ese tiempo, los resultados de la comprobación anterior del tiempo de actividad se muestran en los paneles y se utilizan en las políticas de alertas.

Eliminar una comprobación de disponibilidad del servicio

Te recomendamos que elimines una comprobación de tiempo de actividad cuando desactives el servicio o el recurso que monitoriza.

Para eliminar una comprobación de disponibilidad, haz lo siguiente:

Consola

En la Google Cloud consola, ve a la página Comprobaciones de tiempo de actividad:
Ve a Comprobaciones de disponibilidad del servicio.

Si usas la barra de búsqueda para encontrar esta página, selecciona el resultado cuya sección sea Monitorización.
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.
Busca la comprobación de tiempo de actividad que quieras editar y, a continuación, haz una de las siguientes acciones:
- Haz clic en Más y selecciona Eliminar.
- Consulta los detalles de la comprobación de tiempo de actividad y haz clic en Eliminar.

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: el identificador de la comprobación del tiempo de actividad o de la monitorización sintética. 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.

REST

Para eliminar una comprobación de disponibilidad o un monitor sintético, llama al método projects.uptimeCheckConfigs.delete. Rellena el parámetro de la siguiente manera:

name: obligatorio. Este es el nombre de recurso de la configuración de comprobación de disponibilidad del servicio que se va a eliminar:
```
projects/PROJECT_ID/uptimeCheckConfigs/CHECK_ID
```
En la expresión anterior:
- PROJECT_ID es el proyecto que almacena la comprobación de disponibilidad. 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 identificador de la comprobación de disponibilidad o del monitor sintético. Para obtener más información, consulta Buscar el identificador único de una comprobación de disponibilidad del servicio.

C#

public static object DeleteUptimeCheckConfig(string configName)
{
    var client = UptimeCheckServiceClient.Create();
    client.DeleteUptimeCheckConfig(configName);
    Console.WriteLine($"Deleted {configName}");
    return 0;
}

Java

private static void deleteUptimeCheckConfig(String checkName) throws IOException {
  try (UptimeCheckServiceClient client = UptimeCheckServiceClient.create()) {
    client.deleteUptimeCheckConfig(checkName);
  } catch (Exception e) {
    usage("Exception deleting uptime check: " + e.toString());
    throw e;
  }
}

Go


// delete is an example of deleting an uptime check. resourceName should be
// of the form `projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID]`.
func delete(w io.Writer, resourceName string) error {
	ctx := context.Background()
	client, err := monitoring.NewUptimeCheckClient(ctx)
	if err != nil {
		return fmt.Errorf("NewUptimeCheckClient: %w", err)
	}
	defer client.Close()
	req := &monitoringpb.DeleteUptimeCheckConfigRequest{
		Name: resourceName,
	}
	if err := client.DeleteUptimeCheckConfig(ctx, req); err != nil {
		return fmt.Errorf("DeleteUptimeCheckConfig: %w", err)
	}
	fmt.Fprintf(w, "Successfully deleted %q", resourceName)
	return nil
}

Node.js

// 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 uptimeCheckConfigId = 'YOUR_UPTIME_CHECK_CONFIG_ID';

const request = {
  // i.e. name: 'projects/my-project-id/uptimeCheckConfigs/My-Uptime-Check
  name: client.projectUptimeCheckConfigPath(projectId, uptimeCheckConfigId),
};

console.log(`Deleting ${request.name}`);

// Delete an uptime check config
await client.deleteUptimeCheckConfig(request);
console.log(`${request.name} deleted.`);

PHP

use Google\Cloud\Monitoring\V3\Client\UptimeCheckServiceClient;
use Google\Cloud\Monitoring\V3\DeleteUptimeCheckConfigRequest;

/**
 * Example:
 * ```
 * delete_uptime_check($projectId, $configName);
 * ```
 *
 * @param string $projectId Your project ID
 * @param string $configName
 */
function delete_uptime_check($projectId, $configName)
{
    $uptimeCheckClient = new UptimeCheckServiceClient([
        'projectId' => $projectId,
    ]);
    $deleteUptimeCheckConfigRequest = (new DeleteUptimeCheckConfigRequest())
        ->setName($configName);

    $uptimeCheckClient->deleteUptimeCheckConfig($deleteUptimeCheckConfigRequest);

    printf('Deleted an uptime check: ' . $configName . PHP_EOL);
}

Python

# `config_name` is the `name` field of an UptimeCheckConfig.
# See https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.uptimeCheckConfigs#UptimeCheckConfig.
def delete_uptime_check_config(config_name: str) -> None:
    """Deletes the uptime check configuration

    Args:
        config_name: Uptime check configuration identity
    """
    client = monitoring_v3.UptimeCheckServiceClient()
    client.delete_uptime_check_config(request={"name": config_name})
    print("Deleted ", config_name)

Ruby

gem "google-cloud-monitoring"
require "google/cloud/monitoring"

def delete_uptime_check_config config_name
  client = Google::Cloud::Monitoring.uptime_check_service
  client.delete_uptime_check_config name: config_name
  puts "Deleted #{config_name}"
end

Monitorizar una comprobación de disponibilidad del servicio

Te recomendamos que crees una política de alertas para recibir una notificación cuando falle la comprobación de disponibilidad. Para obtener más información, consulta el artículo Crear políticas de alertas para comprobaciones de disponibilidad.

Buscar el identificador único de una comprobación de disponibilidad del servicio

Cuando se crea una comprobación de disponibilidad, Monitoring le asigna un identificador, denominado ID de comprobación de disponibilidad. Este identificador se inserta en el nombre de recurso de la comprobación de disponibilidad del servicio:

projects/PROJECT_ID/uptimeCheckConfigs/CHECK_ID

El PROJECT_ID es el identificador del proyecto que almacena la comprobación de disponibilidad. 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.

El ID de la comprobación de disponibilidad del servicio se incluye en la respuesta de los métodos de la API Cloud Monitoring que crean o muestran comprobaciones de disponibilidad del servicio. También puede encontrar el ID de la comprobación de disponibilidad en el panel Configuración de la página Detalles de disponibilidad de la consolaGoogle Cloud . Para obtener información sobre cómo ver la página Detalles de tiempo de actividad, consulta la sección Ver los detalles de una comprobación de tiempo de actividad de este documento.

Gestionar comprobaciones de disponibilidad del servicio Organízate con las colecciones Guarda y clasifica el contenido según tus preferencias.

Antes de empezar

Console

gcloud

C#

Go

Java

Node.js

PHP

Python

Ruby

REST

Mostrar todas las comprobaciones de disponibilidad del servicio

Consola

gcloud

REST

C#

Java

Go

Node.js

PHP

Python

Ruby

Ver los detalles de una comprobación de disponibilidad del servicio

Consola

gcloud

REST

C#

Java

Go

Node.js

PHP

Python

Ruby

Editar una comprobación de disponibilidad del servicio

Consola

gcloud

REST

C#

Java

Go

Node.js

PHP

Python

Ruby

Eliminar una comprobación de disponibilidad del servicio

Consola

gcloud

REST

C#

Java

Go

Node.js

PHP

Python

Ruby

Monitorizar una comprobación de disponibilidad del servicio

Buscar el identificador único de una comprobación de disponibilidad del servicio

Siguientes pasos

Gestionar comprobaciones de disponibilidad del servicio