Como definir um microsserviço

Este documento descreve como criar serviços e serviços personalizados para recursos baseados no GKE e no Cloud Run.

No Cloud Monitoring, um serviço é uma construção que você pode associar a SLOs e políticas de alertas. Vários dos recursos para os quais você pode criar serviços do Monitoring também são chamados de serviços, mas com significados diferentes, como serviços GKE ou serviços do Cloud Run.

O Monitoring pode reconhecer serviços baseados no GKE e no Cloud Run como candidatos ao monitoramento. Para criar serviços para eles, indique quais candidatos você quer tratar como serviços do Monitoring. O Monitoring cria a infraestrutura necessária para você.

Também é possível definir serviços personalizados arbitrários.

Identificar ou criar um serviço

Para identificar serviços candidatos ou criar serviços personalizados, acesse o painel Definir serviço:

No painel de navegação do console do Google Cloud, selecione Monitoramento e Painéis:
Acessar SLOs
Na página Visão geral dos serviços, siga um destes procedimentos:
- Clique em Definir serviço.
- No painel Status atual, clique no link Definir serviço:

No painel Definir serviço, é possível fazer o seguinte:

Crie serviços baseados no GKE ou no Cloud Run a partir de uma lista de serviços candidatos.
Definir serviços personalizados

As seções a seguir descrevem tais opções.

Criar serviços baseados no GKE e no Cloud Run

O Cloud Monitoring pode identificar serviços em potencial dos seguintes tipos:

Namespaces do GKE
Serviços do GKE
Cargas de trabalho do GKE
Serviço do Cloud Run

Como pode haver muitos desses serviços em potencial, o Monitoring não pressupõe que você quer que todos sejam tratados como serviços com SLOs. Para indicar quais dos serviços em potencial o Monitoring deve tratar como serviços, use o Console do Google Cloud ou a API.

Usar o Console do Google Cloud para criar serviços do GKE e do Cloud Run

Para identificar um serviço de monitoramento baseado no GKE ou no Cloud Run usando o Console do Google Cloud, faça o seguinte:

Na página Visão geral dos serviços, clique em Definir serviço.
Selecione Candidatos ao Serviço.

Talvez haja um grande número de serviços candidatos na lista. Você pode filtrar a lista da seguinte maneira:
1. Clique em Filtrar tabela. Uma lista de opções de filtro é exibida:
2. Selecione uma das opções na lista de filtros. A opção selecionada será exibida na barra de filtro.
3. Clique ao lado da opção na barra de filtro e comece a digitar. Os valores correspondentes são fornecidos em uma lista. Selecione um valor na lista.
Clique em um serviço candidato na lista de serviços em potencial.

Quando você clica em uma entrada, os seguintes campos são preenchidos:
- O nome de exibição está definido como o nome da entrada na lista. Você pode mudar esse valor.
- Um bloco de código JSON para a configuração do novo serviço é gerado a partir do candidato. Não mude esse valor.
Clique em Enviar. Quando o serviço é criado, um aviso Sucesso é exibido.

Usar a API para criar serviços do GKE e do Cloud Run

Os serviços baseados no GKE e no Cloud Run também podem ser definidos usando a API SLO, parte da API Cloud Monitoring.

Para criar um serviço de maneira programática, poste um objeto de configuração como um dos seguintes no método services.create:

Namespace do GKE

Use a estrutura GkeNamespace, por exemplo:

{
  "displayName": "test-kube-namespace",
  "gkeNamespace": {
    "location": "us-central1-c",
    "clusterName": "cluster-1",
    "namespaceName": "test-kube-namespace"
  }
}

Serviço do GKE

Use a estrutura GkeService, por exemplo:

{
  "displayName": "test-kube-service",
  "gkeService": {
    "location": "us-central1-c",
    "clusterName": "cluster-1",
    "namespaceName": "kube-system",
    "serviceName": "test-kube-service"
  }
}

Carga de trabalho do GKE

Use a estrutura GkeWorkload, por exemplo:

{
  "displayName": "frontend-a",
  "gkeWorkload": {
    "location": "us-central1-b",
    "clusterName": "cluster-2",
    "namespaceName": "default",
    "topLevelControllerType": "Deployment",
    "topLevelControllerName": "frontend-a"
  }
}

Cloud Run

Use a estrutura CloudRun, por exemplo:

{
  "displayName": "test-cloudrun-service",
  "cloudRun": {
    "serviceName": "test-cloudrun-service",
    "location": "us-central1"
  }
}

Para mais informações sobre o gerenciamento programático de serviços, consulte Como trabalhar com a API.

Criar um serviço personalizado

Quando nenhum outro tipo de serviço atender às suas necessidades, crie um serviço personalizado. Com um serviço personalizado, é possível agrupar SLOs arbitrariamente de uma forma significativa para seu ambiente ou criar SLOs em métricas de negócios que não correspondam a um microsserviço atual.

Usar o Console do Google Cloud para criar um serviço personalizado

Para definir um serviço personalizado usando o Console do Google Cloud, faça o seguinte:

Clique em Definir serviço na página Visão geral dos serviços para exibir o painel Definir serviço.
Selecione Serviço personalizado.
Digite um nome de exibição para o serviço personalizado.
Clique em Enviar. Quando o serviço é criado, um aviso Sucesso é exibido.

Usar a API para criar um serviço personalizado

Para definir um serviço personalizado usando aAPI SLO , poste um objeto de configuração Custom como o exemplo para o services.create método:

{
  "displayName": "hello-world-service",
  "custom": {}
}

Para mais informações sobre o gerenciamento programático de serviços, consulte Como trabalhar com a API.

A seguir

Depois de identificar ou criar um novo serviço, você pode fazer o seguinte:

Criar um SLO para o novo serviço. Você deve definir pelo menos um SLO para que o novo serviço seja útil. Para mais informações, consulte Como criar um SLO.
Acesse o painel de controle do seu novo serviço. Para um novo serviço, o painel de controle está vazio, mas você pode definir SLOs a partir dele. Para mais informações, consulte Como usar painéis de controle de microsserviço.