Criar painéis de visualização

Esta página descreve o processo de criação e gerenciamento de painéis na instância do Grafana, usada para visualizações de registros e métricas do projeto isolado do Google Distributed Cloud (GDC).

Um painel oferece uma representação visual dinâmica do desempenho do sistema. Ele consiste em um ou mais painéis personalizáveis, cada um configurado para consultar e mostrar métricas específicas dos componentes do GDC. Esses painéis permitem que você faça o seguinte:

• Visualize métricas em vários tipos de gráficos.
• Defina limites de alerta para acionar notificações com base nos valores das métricas.
• Personalize as propriedades de exibição, como rótulos, unidades e intervalos de tempo.
• Defina resoluções de tempo consistentes para comparações precisas.

Ao usar os painéis do Grafana de maneira eficaz, você pode ter insights valiosos sobre o desempenho e a integridade do ambiente do GDC.

Antes de começar

Para receber as permissões necessárias para trabalhar com painéis em uma organização, peça ao administrador do IAM da organização para conceder a você os seguintes papéis:

• Criar um painel personalizado: criador de PA do painel (dashboard-pa-creator)
• Editar e excluir um painel personalizado: editor de PA do painel (dashboard-pa-editor)
• Acessar um painel personalizado: leitor de PA do painel (dashboard-pa-viewer)

Para receber as permissões necessárias para trabalhar com painéis de um projeto, peça ao administrador do IAM do projeto para conceder a você os seguintes papéis no namespace do projeto:

• Criar, editar e excluir um painel personalizado: editor de painel (dashboard-editor)
• Acessar um painel personalizado: leitor de painel (dashboard-viewer)
• Criar e editar um ConfigMap: editor de ConfigMap (observabilitypipeline-configmap-editor)

Depois de receber os papéis correspondentes, siga estas etapas antes de criar painéis:

1. Colete métricas das cargas de trabalho.

2. Defina o caminho do arquivo kubeconfig como uma variável de ambiente:

   export KUBECONFIG=KUBECONFIG_PATH
   

   Substitua KUBECONFIG_PATH pelo caminho do arquivo kubeconfig do servidor da API Management em que você quer criar o painel.

Identificar o endpoint do Grafana

O URL a seguir é o endpoint da instância do Grafana do seu projeto:

https://GDC_URL/PROJECT_NAMESPACE/grafana

Substitua:

• GDC_URL: o URL da sua organização no GDC.
• PROJECT_NAMESPACE: o namespace do projeto.

Por exemplo, o endpoint do Grafana para o projeto platform-obs na organização org-1 é https://org-1/platform-obs/grafana.

Criar um painel personalizado

Siga estas etapas para criar um painel do Grafana e personalizar as configurações:

1. Abra o endpoint do Grafana para mostrar a interface do usuário.
2. No menu de navegação, clique em Adicionar.
3. No menu suspenso, clique em Painel. O Grafana cria um painel vazio.

4. No painel vazio, adicione todos os painéis que você quer.

5. No menu Fonte de dados de cada painel, selecione a fonte de dados que você quer para o painel, incluindo métricas (prometheus), registros de auditoria (auditloki) e registros operacionais (oploki).

   Para universos multizona, o Grafana tem fontes de dados com rótulos de zona que podem ser usadas para criar visualizações de painéis com métricas e registros de várias zonas. Essas fontes de dados são nomeadas com o formato DATA_SOURCE-ZONE_ID, em que:

   • DATA_SOURCE pode assumir um dos seguintes valores:

     • Prometheus (prometheus ou metrics) para mostrar métricas.
     • Registros de auditoria (auditloki) para mostrar registros de auditoria.
     • Registros operacionais (oploki) para mostrar registros operacionais.

   • ZONE_ID é o ID da zona em que você quer mostrar os dados no painel.

   Além disso, para criar um painel de visualização para recursos entre zonas, o nome da fonte de dados é --Mixed--. Essa fonte de dados permite adicionar várias consultas por zona e ter visualizações de dados entre zonas em um único painel. Você pode usar esse recurso para fazer comparações de comportamento entre, por exemplo, uma única métrica ou consulta de registro em várias zonas do seu universo.

6. Personalize os detalhes e edite os painéis para fornecer suas consultas ou fazer outras atualizações.

   Dica: ao personalizar o painel, implemente práticas recomendadas para seu caso de uso a fim de facilitar a visualização e interpretação dos dados de observabilidade dos componentes. Por exemplo, estabeleça limites de aceitação, mostre indicadores úteis, adicione rótulos aos gráficos e escolha uma resolução de tempo consistente.

7. Na barra de menus, clique em Configurações do painel para abrir a página Configurações.

8. No menu de navegação, selecione Modelo JSON.

9. Copie o modelo JSON do painel e cole-o em um arquivo de texto simples para uso futuro.

Criar um objeto ConfigMap

Siga estas etapas para criar um objeto ConfigMap que contenha o modelo JSON do painel:

1. Abra uma janela do terminal.

2. Crie um objeto ConfigMap. Na seção data do objeto ConfigMap, cole o modelo JSON que você copiou anteriormente:

   apiVersion: v1
   kind: ConfigMap
   metadata:
     namespace: PROJECT_NAMESPACE
     name: CONFIGMAP_NAME
   data:
     JSON_FILE_NAME.json: |
       {
       JSON_MODEL
       }
   

   Substitua:

   • PROJECT_NAMESPACE: o namespace do projeto.
   • CONFIGMAP_NAME: o nome que você quer dar ao objeto ConfigMap.
   • JSON_FILE_NAME: o nome que você quer dar ao arquivo do modelo JSON do painel.
   • JSON_MODEL: o modelo JSON do seu painel personalizado.

   Para um exemplo de como esse objeto precisa ser, consulte um ConfigMap exemplo.

3. Aplique o objeto ConfigMap ao servidor da API Management:

   kubectl --kubeconfig ${KUBECONFIG} apply -f CONFIGMAP_NAME.yaml
   

Um exemplo de ConfigMap

O arquivo YAML a seguir mostra um exemplo do objeto ConfigMap de um painel no namespace platform-obs:

  apiVersion: v1
  kind: ConfigMap
  metadata:
    namespace: platform-obs
    name: my-project-dashboard-configmap
  data:
    my-project-dashboard.json: |
      {
      "annotations": {
        "list": [
          {
            "builtIn": 1,
            "datasource": "--",
            "enable": true,
            "hide": true,
            "iconColor": "rgba(0, 211, 255, 1)",
            "name": "Annotations & Alerts",
            "type": "dashboard"
          }
        ]
      },
      "editable": true,
      "graphTooltip": 0,
      "id": null,
      "links": [],
      "panels": [],
      "schemaVersion": 27,
      "style": "dark",
      "tags": [],
      "templating": {
        "list": []
      },
      "time": {
        "from": "now-6h",
        "to": "now"
      },
      "timepicker": {},
      "timezone": "",
      "title": "Sample dashboard",
      "uid": null,
      "version": 0
      }

Criar um recurso personalizado Dashboard

**Importante** :os painéis, as métricas e os registros são isolados por projeto. Para reutilizar um painel em vários projetos, implante um Dashboard recurso personalizado para cada projeto e verifique se os dados subjacentes estão acessíveis.

Siga estas etapas para criar um recurso personalizado Dashboard e importar seu painel personalizado para a instância do Grafana do seu projeto:

1. Abra uma janela do terminal.

2. Crie um recurso personalizado Dashboard e configure o arquivo com o nome que você deu ao objeto ConfigMap:

   apiVersion: observability.gdc.goog/v1
   kind: Dashboard
   metadata:
     namespace: PROJECT_NAMESPACE
     name: DASHBOARD_NAME
   spec:
     configMapRef:
       name: CONFIGMAP_NAME
       namespace: PROJECT_NAMESPACE
       key: JSON_FILE_NAME.json
     foldername: Default
   

   Substitua:

   • PROJECT_NAMESPACE: o namespace do projeto.
   • DASHBOARD_NAME: o nome que você quer dar ao recurso personalizado Dashboard.
   • CONFIGMAP_NAME: o nome que você deu ao ConfigMap objeto.
   • JSON_FILE_NAME: o nome que você deu ao arquivo que contém o modelo JSON do painel no objeto ConfigMap.
   Observação: Para organizar os painéis em pastas, especifique o foldername na seção spec do recurso Dashboard. Se você omitir esse campo, a pasta Default será usada por padrão. As pastas serão criadas automaticamente se não existirem.

3. Aplique o recurso personalizado Dashboard ao servidor da API Management:

   kubectl --kubeconfig ${KUBECONFIG} apply -f DASHBOARD_NAME.yaml
   

O sistema monitora as mudanças no recurso personalizado Dashboard e no objeto ConfigMap associado. Para atualizar ou excluir um painel, modifique esses recursos. Todas as modificações acionam uma atualização do Grafana. Não é possível salvar atualizações feitas diretamente na interface do usuário do Grafana.