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

Mantenha tudo organizado com as coleções Salve e categorize o conteúdo com base nas suas preferências.

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

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

Para acessar links para informações sobre como gerenciar e monitorar suas verificações de tempo de atividade, consulte a seção Próximas etapas 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 que você especificar.
  • 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 não inclui autenticação.

Antes de começar

Siga estas etapas:

  1. Verifique se o recurso que você quer verificar tem um endpoint público ou está protegido por um firewall configurável.

    Para as outras configurações, crie uma verificação de tempo de atividade particular. Para mais informações, consulte Criar verificações de tempo de atividade privadas.

  2. Quando seu recurso estiver protegido por um firewall, configure-o para permitir o tráfego de entrada proveniente 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.

  3. Configure os canais de notificação que você quer usar para receber alertas. Recomendamos que você crie vários tipos de canais de notificação. Para mais informações, consulte Gerenciar canais de notificação.

  4. Identifique pelo menos três verificadores para sua verificação de tempo de atividade. A região USA da verificação de tempo de atividade inclui as regiões USA_OREGON, USA_IOWA e USA_VIRGINIA. Cada uma das regiões USA_* tem um verificador, e USA inclui todas as três. As outras regiões de verificação de tempo de atividade, EUROPE, SOUTH_AMERICA e ASIA_PACIFIC, têm um verificador.

    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.

Crie 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

O fluxo para criar uma verificação de tempo de atividade está sendo atualizado. Para informações sobre como usar o fluxo legado, que tem disponibilidade geral, clique na guia Legado. Para informações sobre o fluxo atualizado, clique na guia Visualizar.

Legado

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

  1. No console do Google Cloud, selecione Monitoramento ou clique no botão a seguir:
    Acessar o Monitoring
  2. No painel de navegação, selecione Verificações de tempo de atividade.
  3. Na barra de ferramentas, confira se o botão de alternância Visualizar fluxo está desativado.

  4. Clique em Criar verificação de tempo de atividade.

    Crie uma caixa de diálogo da verificação de tempo de atividade.

  5. Insira um título descritivo para a verificação de tempo de atividade.

  6. 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 de usuários.
    2. No campo Chave, insira 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, insira um valor para o rótulo. Os valores do 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.

  7. Clique em Próxima e 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.

    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 Path 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:

      • Para recursos de URL, insira o nome do host no campo Nome do host. Por exemplo, insira example.com.

      • Nos recursos de serviço LoadBalancer do Kubernetes, insira o nome do serviço no campo Serviço do Kubernetes.

      • Para recursos do App Engine, insira o nome do serviço no campo Serviço.

      • Nos recursos Balanceador de carga elástico e Instância, preencha o campo Aplica-se a da seguinte maneira:

        • Para verificar uma única instância ou balanceador de carga, selecione Single e use o menu para selecionar a instância ou o balanceador de carga específico.
        • Para verificar um grupo do Monitoring, selecione Grupo e use o menu para selecionar o nome do grupo.

    5. Opcional: para definir a frequência de execução da verificação, 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 tem três verificadores. A configuração padrão, Global, inclui todas as regiões.
      • Método de solicitação: para verificações de HTTP, selecione o método de solicitação.
      • Corpo: para verificações HTTP POST, insira o corpo codificado no URL. Você mesmo precisa fazer a codificação. Para todas as outras verificações, deixe esse campo em branco.
      • Cabeçalho do host: preencha este campo para verificar 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 no formulário. Use a criptografia para cabeçalhos relacionados à autenticação que você não quer que outras pessoas vejam.

      • Autenticação: forneça um único nome de usuário e senha. Esses valores são enviados como um cabeçalho de autorização. Se você definir os valores, não configure um cabeçalho de autorização separado. Se definir um cabeçalho de autorização, não configure valores no campo. As senhas sempre estarão ocultas no formulário. Esse campo não está disponível para verificações TCP.

      • Validação do certificado SSL: se você selecionou HTTPS para um recurso de URL, o serviço tentará 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 um certificado expirado, um certificado autoassinado, um certificado com uma incompatibilidade de nome de domínio e um certificado que usa a extensão Acesso às informações da autoridade (AIA).

        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 a opção Validar certificados SSL.

        Se você tiver certificados SSL com extensões do AIA, precisará desativar 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 um alerta que notifique você 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.

    7. Clique em Next.

  8. Configure os requisitos de resposta:

    • Opcional: para alterar o tempo limite da verificação, use o campo Tempo limite de resposta. Uma verificação de tempo de atividade falha quando nenhuma resposta é recebida de mais de um local nesse período.

    • Opcional: para configurar a verificação de tempo de atividade para realizar a correspondência de conteúdo, verifique se o rótulo de alternância é A correspondência de conteúdo está ativada:

      • Selecione o Tipo de correspondência de conteúdo da resposta no menu de opções. Esse campo determina como o conteúdo da resposta é comparado aos dados retornados. Por exemplo, se o conteúdo da resposta for abcd e o tipo de correspondência de conteúdo for Contém, a verificação de tempo de atividade será bem-sucedida se os dados da resposta contiverem abcd. A verificação de tempo de atividade falhará se a resposta não tiver 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.

    • Opcional: para evitar que entradas de registro sejam criadas devido a verificações de tempo de atividade, desmarque 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 uma resposta bem-sucedida.

    • Clique em Próximo.

  9. Crie uma política de alertas. Quando uma política de alertas monitora a verificação de tempo de atividade, se o tempo de atividade falhar, um incidente será criado e uma notificação será enviada a todos os canais de notificação anexados à política. Por exemplo, se você adicionar um endereço de e-mail à política, um e-mail será enviado a esse endereço. É possível criar a política de alertas nesta etapa ou criar uma política de alertas depois que a verificação for criada.

    Recomendamos que você crie uma política de alertas para sua verificação de tempo de atividade. No entanto, para pular essa etapa, verifique se o texto do botão de alternância é Não criar um alerta. Clique no botão para mudar o estado.

    Para criar uma política de alertas como parte desse fluxo, faça o seguinte:

    1. Verifique se o texto do botão de alternância é Criar um alerta. Clique no botão, se necessário.

    2. No campo de nome, insira um nome para a política de alertas ou use o nome padrão.

    3. Para adicionar um ou mais canais de notificação à política de alertas, na caixa denominada Canais de notificação, clique em Menu . Selecione os canais a serem adicionados e clique em OK. Os canais de notificação são agrupados em ordem alfabética para cada tipo de canal.

      Se um canal de notificação que você quer adicionar à política de alertas não estiver listado, clique em Gerenciar canais de notificação.

      Caixa de diálogo de notificação que exibe os botões de atualização e gerenciamento de canais.

      Você será direcionado para a janela Canais de notificação em uma nova guia do navegador. Adicione os canais de notificação e volte a essa guia, clique em Atualizar e selecione os canais de notificação a serem adicionados à política de alertas. Para mais informações, consulte Canais de notificação.

    4. Opcional: no campo de duração, selecione por quanto tempo as verificações de tempo de atividade precisam falhar antes de um incidente ser criado. Por padrão, a política de alertas é configurada para criar um incidente se pelo menos duas regiões relatarem falhas na verificação de tempo de atividade por um minuto.

    Para informações sobre como desativar, editar e excluir políticas de alertas, consulte [Como gerenciar políticas][manage].

  10. 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.

  11. Clique em Criar. Uma mensagem de erro é exibida quando você salva uma verificação de tempo de atividade e um campo obrigatório não é preenchido. Depois de salvar as mudanças, a caixa de diálogo Verificação de tempo de atividade criada vai ser exibida.

Visualizar

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

  1. No console do Google Cloud, selecione Monitoramento ou clique no botão a seguir:
    Acessar o Monitoring
  2. No painel de navegação, selecione Verificações de tempo de atividade.
  3. Na barra de ferramentas, confira se o botão de alternância Visualizar fluxo está ativado.

  4. Clique em Criar verificação de tempo de atividade.

    Crie uma caixa de diálogo da verificação de tempo de atividade.

  5. 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.

    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 Path 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:

      • Para recursos de URL, insira o nome do host no campo Nome do host. Por exemplo, insira example.com.

      • Para recursos do App Engine, insira o nome do serviço no campo Serviço.

      • Nos recursos Balanceador de carga elástico e Instância, 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 específica ou o balanceador de carga.
        • 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 a frequência de execução da verificação, use o campo Frequência de verificação.

    6. Opcional: para selecionar as 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 tem três verificadores. A configuração padrão, Global, inclui todas as regiões.
      • Pings do ICMP: configure a verificação de tempo de atividade para enviar até três pings. Para mais informações, consulte Usar pings ICMP.
      • Método de solicitação: para verificações de HTTP, selecione o método de solicitação.
      • Corpo: para verificações HTTP POST, insira o corpo codificado no URL. Você mesmo precisa fazer a codificação. Para todas as outras verificações, deixe esse campo em branco.
      • Cabeçalho do host: preencha este campo para verificar 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 no formulário. Use a criptografia para cabeçalhos relacionados à autenticação que você não quer que outras pessoas vejam.

      • Autenticação: forneça um único nome de usuário e senha. Esses valores são enviados como um cabeçalho de autorização. Se você definir os valores, não configure um cabeçalho de autorização separado. Se definir um cabeçalho de autorização, não configure valores no campo. As senhas sempre estarão ocultas no formulário. Esse campo não está disponível para verificações TCP.

      • Validação do certificado SSL: se você selecionou HTTPS para um recurso de URL, o serviço tentará 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 um certificado expirado, um certificado autoassinado, um certificado com uma incompatibilidade de nome de domínio e um certificado que usa a extensão Acesso às informações da autoridade (AIA).

        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 a opção Validar certificados SSL.

        Se você tiver certificados SSL com extensões do AIA, precisará desativar 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 um alerta que notifique você 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.

  6. 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, use o campo Tempo limite de resposta. Uma verificação de tempo de atividade falha quando nenhuma resposta é recebida de mais de um local nesse período.

    • Para configurar a verificação de tempo de atividade para realizar a correspondência de conteúdo, verifique se o rótulo de alternância é A correspondência de conteúdo está ativada:

      • Selecione o Tipo de correspondência de conteúdo da 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 de 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.

    • Para evitar que entradas de registro sejam criadas devido a verificações de tempo de atividade, limpe as 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 uma resposta bem-sucedida.

  7. Clique em Continuar e configure alertas e notificações.

    Para receber notificações quando uma verificação de tempo de atividade falhar, crie uma política de alertas e configure os canais de notificação para essa política:

    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 um período de 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 de alternância é Do not create a alert.

  8. 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, insira 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, insira 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.

API

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. Esta página fornece 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#

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

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


// 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: %v", 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: %v", 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: %v", 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: %v", err)
	}
	fmt.Fprintf(w, "Successfully created POST uptime check %q\n", config.GetDisplayName())
	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 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

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

/**
 * 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')
{
    $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);

    $uptimeCheckConfig = $uptimeCheckClient->createUptimeCheckConfig(
        $uptimeCheckClient->projectName($projectId),
        $uptimeCheckConfig
    );

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

Python

def create_uptime_check_config_get(project_name, host_name=None, display_name=None):
    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_name, "uptime_check_config": config})
    pprint.pprint(new_config)
    return new_config

def create_uptime_check_config_post(project_name, host_name=None, display_name=None):
    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_name, "uptime_check_config": config})
    pprint.pprint(new_config)
    return new_config

Ruby

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

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 de verificações de tempo de atividade públicas com falha, configure essas verificações para enviar até três pings de ICMP durante a verificação. Os pings podem ajudar a distinguir entre falhas causadas, por exemplo, por problemas de conectividade de rede e tempos limite no seu aplicativo.

Por padrão, as verificações de tempo de atividade não enviam pings. Cada ping adiciona latência à verificação de tempo de atividade. As verificações de tempo de atividade privadas 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 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 das 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 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:

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. Para 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 o tráfego 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 deles serão gravados no Cloud Logging. Para mais informações, consulte Usar pings ICMP.

A seguir