Criar verificações de tempo de atividade público

Neste documento, descrevemos como criar uma verificação de tempo de atividade pública. Uma verificação de tempo de atividade público pode emitir solicitações de vários locais em todo o mundo para URLs disponíveis publicamente ou recursos do Google Cloud para ver se o recurso responde. Saiba como criar verificações de tempo de atividade para redes privadas em Criar verificações de tempo de atividade particulares.

As verificações de tempo de atividade público podem determinar a disponibilidade dos seguintes recursos monitorados:

Para links que levam a informações sobre como gerenciar e monitorar as verificações de tempo de atividade, consulte a seção A seguir deste documento.

Sobre as verificações de tempo de atividade

Para HTTP e HTTPS, todos os redirecionamentos de URL são seguidos e a resposta final recebida pela verificação de tempo de atividade é usada para avaliar todos os critérios de sucesso. Para verificações HTTPS, o prazo de validade do certificado SSL é calculado com base no certificado do servidor recebido na resposta final.

Para que uma verificação de tempo de atividade seja bem-sucedida, as seguintes condições precisam ser atendidas:

O status HTTP precisa corresponder aos critérios especificados.
Os dados de resposta não têm conteúdo obrigatório ou o conteúdo obrigatório está presente.

As verificações de tempo de atividade não carregam recursos da página nem executam JavaScript, e a configuração padrão de uma verificação de tempo de atividade não inclui autenticação.

Antes de começar

Para receber as permissões necessárias para criar verificações de tempo de atividade, peça ao administrador para conceder a você os seguintes papéis do IAM no seu projeto:
- Editor do Monitoring (roles/monitoring.editor): usuários do console do Google Cloud
- Editor de configurações de verificação de tempo de atividade do Monitoring (roles/monitoring.uptimeCheckConfigEditor): usuários da API
- Editor de AlertPolicy do Monitoring (roles/monitoring.alertPolicyEditor): usuários da API
- Editor de NotificationChannel do Monitoring (roles/monitoring.notificationChannelEditor): usuários da API
Para mais informações sobre como conceder papéis, consulte Gerenciar acesso.

Também é possível conseguir as permissões necessárias por meio de papéis personalizados ou de outros papéis predefinidos.
Verifique se o recurso que você quer verificar tem um endpoint público ou está atrás de um firewall configurável.

Para todas as outras configurações, é preciso criar uma verificação de tempo de atividade particular. Para mais informações, consulte Criar verificações de tempo de atividade particulares.
Quando seu recurso estiver protegido por um firewall, configure-o para permitir o tráfego de entrada dos endereços IP dos servidores de verificação de tempo de atividade. Para mais informações, consulte Listar endereços IP do servidor de verificação de tempo de atividade.
Configure os canais de notificação que você quer usar para receber notificações. Recomendamos que você crie vários tipos de canais de notificação. Para saber mais, consulte Criar e gerenciar canais de notificação.
Identifique pelo menos três verificadores para sua verificação de tempo de atividade. A região de verificação de tempo de atividade USA inclui as regiões USA_OREGON, USA_IOWA e USA_VIRGINIA. Cada uma das regiões USA_* tem um verificador, e USA inclui os três. As outras regiões de verificação de tempo de atividade, EUROPE, SOUTH_AMERICA e ASIA_PACIFIC, têm um verificador cada.

Se você selecionar Global ao usar o console do Google Cloud ou selecionar REGION_UNSPECIFIED ao usar a API, as verificações de tempo de atividade serão emitidas de todas as regiões de verificação de tempo de atividade.

Criar uma verificação de tempo de atividade

Nesta seção, você vê como criar e configurar verificações de tempo de atividade.

Para criar uma verificação de tempo de atividade para um balanceador de carga externo que tenha pelo menos uma porta TCP ou HTTP/s configurada, siga estas instruções. Uma alternativa é acessar a página Detalhes do serviço e clicar em Criar verificação de tempo de atividade. Quando você começa na página Detalhes do serviço, os campos específicos do serviço são preenchidos automaticamente.

Console

Para criar uma verificação de tempo de atividade usando o console do Google Cloud, faça o seguinte:

No painel de navegação do console do Google Cloud, selecione Monitoramento e Verificações de tempo de atividade:
Acesse Verificações de tempo de atividade
Clique em Criar verificação de tempo de atividade.
Especifique o destino da verificação de tempo de atividade:
1. Selecione o protocolo. Você pode selecionar HTTP, HTTPS ou TCP.
2. Escolha um dos seguintes tipos de recursos:
  - URL: qualquer nome de host ou endereço IPv4. O caminho e a porta são inseridos separadamente.
  - Serviço LoadBalancer do Kubernetes: serviço do tipo LoadBalancer do Kubernetes.
  - Instance: do Compute Engine ou AWS EC2.
  - App Engine: aplicativos do App Engine (módulos).
  - Balanceador de carga elástico: da AWS.
  Observação :não selecione IP interno, já que esse tipo de recurso não pode ser alvo de uma verificação de tempo de atividade pública.
3. Insira os campos específicos do protocolo:
  - Para verificações de TCP, digite a porta.
  - Para verificações HTTP e HTTPS, é possível inserir um caminho no host ou recurso. Todas as verificações de tempo de atividade que usam esses protocolos enviam uma solicitação para http://target/path. Nesta expressão, para um recurso de URL, target é um nome de host ou endereço IP. Para um recurso do App Engine, target é um nome de host derivado do nome do serviço. Para recursos de instância e balanceador de carga, target é um endereço IP derivado do nome fornecido para o recurso ou o grupo de recursos.
    
    Se você deixar o campo path em branco ou definir o valor como /, a solicitação será emitida como http://target/.
    
    Por exemplo, para emitir uma verificação de tempo de atividade para o recurso de URL example.com/tester, defina o campo Nome do host como example.com e o campo Caminho como /tester.
    
    Suponha que você tenha implantado um servidor no App Engine com um agente compatível com / e /hello. Para emitir a verificação de tempo de atividade para o gerenciador "/", deixe o campo Caminho vazio. Para emitir a verificação de tempo de atividade para o gerenciador /hello, defina o valor do campo Path como /hello.
4. Insira os campos específicos do recurso:
  - Em recursos de URL, digite o nome do host no campo Nome do host. Por exemplo, insira example.com.
    
    Observação :crie verificações em URLs diretos quando possível.
  - Para recursos do App Engine, insira o nome do serviço no campo Serviço.
  - Para os recursos Elastic Load Balancer e Instance, preencha o campo Aplica-se a da seguinte maneira:
    - Para emitir uma verificação de tempo de atividade para uma única instância ou balanceador de carga, selecione Único e use o menu para selecionar a instância ou o balanceador de carga específico.
    - Para emitir uma verificação de tempo de atividade para um grupo do Monitoring, selecione Grupo e use o menu para selecionar o nome do grupo.
5. Opcional: para definir com que frequência a verificação de tempo de atividade é executada, use o campo Frequência de verificação.
6. Opcional: para selecionar regiões do verificador ou configurar certificados SSL, autenticação, cabeçalhos e portas para verificações HTTP e HTTPS, clique em Mais opções de destino:
  - Regiões: selecione as regiões em que as verificações de tempo de atividade devem receber solicitações. Uma verificação de tempo de atividade precisa ter pelo menos três verificadores. Há um verificador em todas as regiões, exceto nos Estados Unidos, que têm três verificadores. A configuração padrão, Global, inclui todas as regiões.
  - Pings ICMP: configure a verificação de tempo de atividade para enviar até três pings. Para mais informações, consulte Usar pings do ICMP.
  - Método de solicitação: para verificações HTTP, selecione o método de solicitação.
  - Corpo: para verificações HTTP POST, insira o corpo codificado do URL. Você precisa fazer a codificação. Em todas as outras verificações, deixe esse campo em branco.
  - Cabeçalho do host: preencha este campo para verificar os hosts virtuais. Esse campo não está disponível para verificações TCP.
  - Port: especifique um número de porta.
  - Cabeçalhos personalizados: forneça cabeçalhos personalizados e criptografe-os, se desejar. A criptografia oculta os valores do cabeçalho do formulário. Use a criptografia para cabeçalhos relacionados à autenticação que você não quer que outras pessoas vejam.
  - Autenticação: esses valores são enviados como um cabeçalho de autorização. Esse campo não está disponível para verificações TCP.
    
    Observação :não defina os campos Authentication ao enviar um cabeçalho "Autorização". Se você definir os campos de Autenticação e enviar um cabeçalho de autorização, ocorrerá um erro Invalid Argument.
    
    Escolha uma destas opções:
    - Autenticação básica: forneça um único nome de usuário e senha. As senhas sempre estarão ocultas no formulário.
    - Autenticação do agente de serviço: quando ativada, um token de identidade é gerado para o agente de serviço de monitoramento. Essa opção está disponível apenas para verificações HTTPS.
  - Validação do certificado SSL: se você selecionou HTTPS para um recurso de URL, por padrão, o serviço tenta se conectar por HTTPS e validar o certificado SSL. As verificações de tempo de atividade falham quando um URL tem um certificado inválido. Os motivos para um certificado inválido incluem o seguinte:
    - Um certificado expirado
    - Um certificado autoassinado
    - Um certificado com uma incompatibilidade de nome de domínio
    - Um certificado que usa a extensão Authority Information Access (AIA).
    Observação :uma certificação SSL revogada não é considerada inválida.
    
    Para forçar uma verificação de tempo de atividade HTTPS para validar o certificado SSL, selecione Validar certificados SSL.
    
    Para desativar a validação do certificado SSL, desmarque Validar certificados SSL.
    
    Se você tiver certificados SSL com extensões AIA, desative a validação do certificado SSL. Esses tipos de certificados não são compatíveis e falham na sequência de validação. Normalmente, a mensagem de erro é "Responder com erro de handshake SSL em 10.000 ms".
    
    É possível usar a métrica monitoring.googleapis.com/uptime_check/time_until_ssl_cert_expires para criar uma política de alertas que envia notificações antes que o certificado expire. Para mais informações, consulte Políticas de amostra: política de verificação de tempo de atividade.
    
    Marque a caixa de seleção Validar certificados SSL.
Clique em Continuar e configure os requisitos de resposta. Todas as configurações nesta seção têm valores padrão:
- Para alterar o tempo limite da verificação de tempo de atividade, use o campo Tempo limite de resposta. Essa verificação falha quando nenhuma resposta é recebida de mais de um local nesse período.
  
  Observação :se você criar verificações em URLs de redirecionamento, aumente o Tempo limite de resposta para 30 segundos ou mais.
- Para configurar a verificação de tempo de atividade para realizar a correspondência de conteúdo, confira se o rótulo de alternância está A correspondência de conteúdo está ativada:
  - Selecione o Tipo de correspondência de conteúdo de resposta no menu de opções. Esse campo determina como o conteúdo da resposta é comparado aos dados retornados. Por exemplo, suponha que o conteúdo da resposta seja abcd e o tipo de correspondência do conteúdo seja Contains. A verificação de tempo de atividade só é bem-sucedida quando os dados de resposta contêm abcd. Para mais informações, consulte Validar dados de resposta.
  - Digite o Conteúdo da resposta. O conteúdo da resposta precisa ser uma string de até 1.024 bytes. Na API, esse campo é o objeto ContentMatcher.
  Observação: ative a correspondência de conteúdo de resposta ao selecionar o protocolo TCP.
- Para impedir que entradas de registro sejam criadas devido a verificações de tempo de atividade, limpe Falhas na verificação de registro.
- Para as verificações de tempo de atividade HTTP, configure os códigos de resposta aceitáveis. Por padrão, as verificações de tempo de atividade HTTP marcam qualquer resposta 2xx como bem-sucedida.
Clique em Continuar e configure as notificações.

Para receber uma notificação quando uma verificação de tempo de atividade falhar, crie uma política de alertas e configure canais de notificação para ela:
1. Opcional: atualize o nome da política de alertas.
2. Opcional: no campo Duração, selecione por quanto tempo as verificações de tempo de atividade precisam falhar antes do envio das notificações. Por padrão, as notificações são enviadas quando pelo menos duas regiões relatam falhas na verificação de tempo de atividade por pelo menos um minuto.
3. Na caixa Canais de notificação, clique em Menu , selecione os canais a serem adicionados e clique em OK.
  
  No menu, os canais de notificação são agrupados em ordem alfabética para cada tipo de canal.
Se você não quiser criar uma política de alertas, verifique se o texto do botão é Do not create an alert.
Clique em Continuar e conclua a verificação de tempo de atividade:
1. Insira um título descritivo para a verificação de tempo de atividade.
2. Opcional: para adicionar rótulos definidos pelo usuário à verificação de tempo de atividade, faça o seguinte:
  1. Clique em Mostrar rótulos do usuário.
  2. No campo Chave, digite um nome para o rótulo. Os nomes de rótulos precisam começar com uma letra minúscula e podem conter letras minúsculas, numerais, sublinhados e traços. Por exemplo, insira severity.
  3. No campo Valor, digite um valor para o rótulo. Os valores de rótulo podem conter letras minúsculas, numerais, sublinhados e traços. Por exemplo, insira critical.
  4. Para cada rótulo adicional, clique em Adicionar rótulo de usuário e insira a chave e o valor do rótulo.
3. Para verificar a configuração da verificação de tempo de atividade, clique em Test. Se o resultado não for o esperado, consulte Falhas na verificação, corrija a configuração e repita a etapa de verificação.
4. Clique em Criar. Se você selecionar Criar e um campo obrigatório não for preenchido, uma mensagem de erro será exibida.

gcloud

Para criar a verificação de tempo de atividade, execute o comando gcloud monitoring uptime create:

gcloud monitoring uptime create DISPLAY_NAME REQUIRED_FLAGS OPTIONAL_FLAGS

Antes de executar o comando anterior, faça o seguinte:

Substitua DISPLAY_NAME pelo nome da verificação de tempo de atividade.
Configure o REQUIRED_FLAGS para especificar o recurso sondado pela verificação de tempo de atividade. Por exemplo, o comando a seguir cria uma verificação de tempo de atividade que testa o URL EXAMPLE.com para um projeto específico:
```
gcloud monitoring uptime create DISPLAY_NAME \
--resource-labels=host=EXAMPLE.com,project_id=PROJECT_ID \
--resource-type=uptime_url
```
O comando anterior especifica valores para cada rótulo exigido pelo tipo de recurso uptime_url.
Configure as sinalizações OPTIONAL_FLAGS para substituir os valores padrão. Por exemplo, defina a sinalização --protocol quando o protocolo não for http.

API

Para criar uma verificação de tempo de atividade, chame o método projects.uptimeCheckConfigs.create. Defina os parâmetros dele da seguinte maneira:

parent: obrigatório. Precisa ser o nome do projeto em que será criada a verificação de tempo de atividade. Substitua PROJECT_ID pelo ID do seu projeto do Google Cloud. O formato é:
```
projects/PROJECT_ID
```
O corpo da solicitação precisa conter um objeto UptimeCheckConfig para a nova verificação de tempo de atividade. Nesta página, há informações sobre alguns campos. Para ver a documentação completa sobre esse objeto e seus campos, consulte UptimeCheckConfig:
- Deixe o campo name do objeto de configuração em branco. O sistema define esse campo quando constrói o objeto de configuração de resposta.
- Se você estiver configurando uma verificação HTTP ou HTTPS, preencha o campo HttpCheck do objeto UptimeCheckConfig. Nesse objeto, defina o campo requestMethod como GET ou POST. Se esse campo for omitido ou definido como METHOD_UNSPECIFIED, uma solicitação GET será emitida.
  
  Se você estiver configurando uma solicitação POST, preencha os campos contentType, customContentType e body opcionais.

O método create retorna o objeto UptimeCheckConfig da nova configuração.

Se a configuração de tempo de atividade criada não funcionar como esperado, consulte a seção Falhas na verificação nesta página.

C#

Para autenticar no Monitoring, configure o Application Default Credentials. Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento 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 autenticar no Monitoring, configure o Application Default Credentials. Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento 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 autenticar no Monitoring, configure o Application Default Credentials. Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento 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 autenticar no Monitoring, configure o Application Default Credentials. Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento 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 autenticar no Monitoring, configure o Application Default Credentials. Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento 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 autenticar no Monitoring, configure o Application Default Credentials. Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento 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 autenticar no Monitoring, configure o Application Default Credentials. Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento 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

Para saber como aplicar ou remover uma configuração do Terraform, consulte Comandos básicos do Terraform. Para mais informações, consulte a documentação de referência do provedor Terraform.

Para criar uma verificação de tempo de atividade e uma política de alertas que monitore essa verificação, faça o seguinte:

Edite o arquivo de configuração do Terraform, adicione um recurso google_monitoring_uptime_check_config e aplique o arquivo de configuração.

O exemplo abaixo ilustra uma configuração que verifica um URL público:

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"
}

Opcional: crie um canal de notificação e uma política de alertas:

As etapas a seguir usam o console do Google Cloud para criar o canal de notificação e a política de alertas. Com essa abordagem, a política de alertas monitora apenas os dados gerados pela verificação de tempo de atividade.
1. Para criar um canal de notificação, faça o seguinte:
  1. No painel de navegação do console do Google Cloud, selecione Monitoramento e Alertas:
    Acessar Alertas
  2. Selecione Gerenciar canais de notificação.
  3. Acesse o tipo de canal que você quer adicionar, clique em Adicionar e preencha a caixa de diálogo.
2. Para criar uma política de alertas, siga estas etapas:
  1. No painel de navegação do console do Google Cloud, selecione Monitoramento e Verificações de tempo de atividade:
    Acesse Verificações de tempo de atividade
  2. Localize a verificação de tempo de atividade, selecione Mais e, em seguida, Adicionar política de alertas.
  3. Na caixa de diálogo, vá para a seção Notificações e nome, expanda Canais de notificação e faça suas seleções.
  4. Nomeie a política de alertas e clique em Criar política.
É possível criar uma política de alertas adicionando um recurso google_monitoring_alert_policy ao arquivo de configuração e aplicando a nova configuração.

Pode haver um atraso de até cinco minutos antes que os resultados da verificação de tempo de atividade comecem a ser transmitidos para o Monitoring. Durante esse tempo, o painel da verificação de tempo de atividade informa o status como "no data available".

Usar pings ICMP

Para ajudar a solucionar problemas em verificações de tempo de atividade públicas com falha, é possível configurar suas verificações de tempo de atividade para enviar até três pings de ICMP durante a verificação. Os pings ajudam a distinguir entre falhas causadas, por exemplo, por problemas de conectividade de rede e por tempos limite no aplicativo.

Por padrão, as verificações de tempo de atividade não enviam pings. Cada ping adiciona alguma latência à verificação de tempo de atividade. As verificações de tempo de atividade particulares não podem enviar pings.

Quando uma verificação de tempo de atividade pública falha, os resultados dos pings são gravados nos registros do Cloud Logging. Se o ping falhar, os campos a seguir serão adicionados ao campo httpRequest na entrada de registro:

rtt_usec: tempo de retorno para cada solicitação de ping malsucedida.
unreachable_count: número de solicitações de ping que retornaram o código de status ICMP_DEST_UNREACH.
no_answer_count: número de solicitações de ping que expiraram e não retornaram resposta.

Os resultados dos pings de verificações de tempo de atividade bem-sucedidas não são registrados.

Configurar pings

Cada configuração de verificação de tempo de atividade inclui um objeto HttpCheck ou TcpCheck. Esses dois objetos incluem um campo pingConfig. Use esse campo para especificar o número de pings do ICMP a serem incluídos em cada verificação, até três. Por padrão, nenhum ping é enviado.

Para configurar pings, siga um destes procedimentos:

Ao usar o console do Google Cloud, expanda Mais opções de destino e insira um valor no campo Pings do ICMP.
Ao usar a API Cloud Monitoring, use o objeto PingConfig, que tem a seguinte estrutura:
```
{
  "pingsCount": integer
}
```
Para mais informações sobre como usar a API Monitoring para configurações de verificação de tempo de atividade, consulte Criar uma verificação de tempo de atividade: API ou Editar uma verificação de tempo de atividade: API.

Testar verificação de tempo de atividade

Ao criar uma verificação de tempo de atividade no console do Google Cloud, é possível testar a configuração antes de salvar.

Verificações bem-sucedidas

Uma verificação de tempo de atividade é bem-sucedida quando as seguintes condições são verdadeiras:

O status HTTP corresponde aos critérios selecionados.
A resposta não pode ter conteúdo obrigatório, ou uma pesquisa da resposta para o conteúdo obrigatório precisa ser bem-sucedida.

Verificações com falha

Veja a seguir algumas possíveis causas de falha na verificação de tempo de atividade:

Connection Error - Refused: se você usa o tipo de conexão padrão HTTP, verifique se há um servidor da Web instalado que esteja respondendo a solicitações HTTP. Um erro de conexão pode ocorrer em uma nova instância se você não tiver instalado um servidor da Web. Consulte o Guia de início rápido do Compute Engine. Se você usa um tipo de conexão HTTPS, talvez tenha que executar mais algumas etapas de configuração. Se tiver problemas de firewall, consulte Listar endereços IP do servidor de verificação de tempo de atividade.
Nome ou serviço não encontrado: o nome do host pode estar incorreto.
403 Proibido: o serviço está retornando um código de erro para o verificador de tempo de atividade. Por exemplo, a configuração do servidor da Web Apache padrão retorna esse código no Amazon Linux, mas retorna 200 (Success) em algumas outras versões do Linux. Consulte o Tutorial de LAMP para Amazon Linux (em inglês) ou a documentação do servidor da Web.
404 Não encontrado: o caminho pode estar incorreto.
408 Tempo esgotado da solicitação ou sem resposta: o número da porta pode estar incorreto, o serviço pode não estar em execução ou estar inacessível ou o tempo limite pode estar muito baixo. Verifique se o firewall permite tráfego proveniente dos servidores de tempo de atividade. Consulte Listar endereços IP do servidor de verificação de tempo de atividade. O tempo limite é especificado como parte das opções de Validação de resposta.

Se a verificação de tempo de atividade estiver configurada para enviar pings, os resultados de pings para verificações de tempo de atividade com falha serão gravados no Cloud Logging. Para mais informações, consulte Usar pings do ICMP.