Configurar a coleta de métricas do monitoramento de processos

Neste guia, mostramos como configurar o agente do Google Cloud para SAP a fim de coletar as métricas do monitoramento de processos com relação aos seus sistemas SAP.

Para mais informações sobre esse recurso, consulte Monitoramento de processos usando o agente do Google Cloud para SAP.

Antes de começar

Valide a instalação do agente do Google Cloud para SAP. Para instruções, consulte o guia de instalação para seu cenário.
Ao instalar o agente em um servidor da Solução Bare Metal, verifique se você concluiu os pré-requisitos e configurou uma conta de serviço. Para instruções, consulte Configurar o agente do Google Cloud para SAP no Linux.

Defina papéis do IAM

Para permitir que o agente do Google Cloud para SAP colete as métricas do monitoramento de processos, verifique se a conta de serviço usada pela instância de VM do Compute Engine ou pelo servidor da Solução Bare Metal inclui os seguintes papéis:

Leitor do Compute (roles/compute.viewer)
Papéis de Gravador de métricas do Monitoring (roles/monitoring.metricWriter).
Acessador de secrets do Secret Manager (roles/secretmanager.secretAccessor), se você usa o Secret Manager para armazenar senhas do banco de dados do SAP HANA.

Para adicionar esses papéis necessários à sua conta de serviço, siga estas etapas:

No console do Google Cloud, abra a página IAM.

Acessar IAM
Selecione seu projeto do Google Cloud.
Identifique a conta de serviço em que você quer incluir um papel.
- Se a conta de serviço ainda não estiver na lista de principais, ela não terá nenhum papel atribuído a ela. Clique em Adicionar e digite o endereço de e-mail da conta do serviço.
- Se a conta de serviço estiver na lista de principais, a conta de serviço já terá papéis. Clique no botão Editar da conta de serviço que você quer editar.
Selecione o papel necessário na lista de papéis disponíveis:
- Leitor do Compute
- Monitoramento > Gravador da métrica de monitoramento
- Secret Manager > Acessador de secrets do Secret Manager
Clique em Adicionar ou Salvar para aplicar os papéis à conta de serviço.

Ativar a coleta de métricas do monitoramento de processos

Para ativar a coleta de métricas do monitoramento de processos usando o agente do Google Cloud para SAP, siga estas etapas:

Estabeleça uma conexão SSH com a instância de VM do host.
Abra o arquivo de configuração do agente:
```
/etc/google-cloud-sap-agent/configuration.json
```
Como alternativa, também é possível realizar essa configuração executando comandos. Para mais informações, consulte Comandos de configuração do agente do Google Cloud para SAP.
Na seção collection_configuration, faça o seguinte:
- Para o parâmetro collect_process_metrics, especifique o valor true.
- Para ativar a coleta de métricas de monitoramento de processos relacionadas às instâncias de banco de dados do SAP HANA, é preciso configurar parâmetros adicionais na seção hana_metrics_config. Para informações sobre esses parâmetros, consulte Parâmetros de configuração.
Como opção, na seção cloud_properties, é possível atualizar os valores de parâmetros definidos automaticamente. Para fazer isso, adicione a seção cloud_properties ao arquivo de configuração e especifique os parâmetros necessários e respectivos valores.
Salve o arquivo de configuração.
Reinicie o agente para que as novas configurações entrem em vigor.
```
sudo systemctl restart google-cloud-sap-agent
```

Exemplos de arquivos de configuração

Instância de VM do Compute Engine

O seguinte exemplo é um arquivo de configuração completo do Agente do Google Cloud para SAP, em execução em uma instância de VM do Compute Engine, em que a coleta de métricas do monitoramento de processos está ativada:

{
  "provide_sap_host_agent_metrics": true,
  "bare_metal": false,
  "log_level": "INFO",
  "log_to_cloud": true,
  "collection_configuration": {
    "collect_workload_validation_metrics": true,
    "collect_process_metrics": true,
    "process_metrics_frequency": 5,
    "slow_process_metrics_frequency": 30,
    "hana_metrics_config": {
      "hana_db_user": "db_user_name",
      "hana_db_password_secret_name": "db_pwd_secret_name"
    }
  },
  "cloud_properties": {
    "project_id": "my-project",
    "instance_name": "vm-instance-1",
    "image": "rhel-8"
  },
  "discovery_configuration": {
    "enable_discovery": true
  },
  "hana_monitoring_configuration": {
    "enabled": false
  }
}

Servidor da Solução Bare Metal

O exemplo a seguir é um arquivo de configuração completo do agente do Google Cloud para SAP, em execução no servidor da Solução Bare Metal, em que a coleta de métricas do monitoramento de processos está ativada:

{
  "provide_sap_host_agent_metrics": true,
  "bare_metal": true,
  "log_level": "INFO",
  "log_to_cloud": true,
  "collection_configuration": {
    "collect_workload_validation_metrics": true,
    "collect_process_metrics": true,
    "process_metrics_frequency": 5,
    "slow_process_metrics_frequency": 30,
    "hana_metrics_config": {
      "hana_db_user": "db_user_name",
      "hana_db_password_secret_name": "db_pwd_secret_name"
    }
  },
  "cloud_properties": {
    "project_id": "my-project",
    "instance_name": "bms-machine-1"
    "region": "us-central1",
    "image": "rhel-8"
  },
  "discovery_configuration": {
    "enable_discovery": true
  },
  "hana_monitoring_configuration": {
    "enabled": false
  }
}

Parâmetros de configuração

Na tabela a seguir, explicamos os parâmetros de configuração do agente do Google Cloud para SAP específicas da coleta de métricas do monitoramento de processos.

Parâmetros
`provide_sap_host_agent_metrics`	`Boolean` Para ativar a coleta de métricas exigidas pelo agente de host SAP, especifique `true`. O padrão é `true`. Não defina `provide_sap_host_agent_metrics` como `false`, a menos que isso seja orientado pelo Cloud Customer Care ou pelo suporte da SAP.
`bare_metal`	`Boolean` Quando o agente for instalado em um servidor da Solução Bare Metal, especifique `true`. O padrão é `false`.
`log_level`	`String` Para definir o nível de geração de registros do agente, defina o valor necessário. Os níveis de registro disponíveis são estes: `DEBUG` `INFO` `WARNING` `ERROR` O padrão é `INFO`. Não altere o nível de geração de registros, a menos que isso seja orientado pelo Cloud Customer Care.
`log_to_cloud`	`Boolean` Para redirecionar os registros do agente para o Cloud Logging, especifique `true`. O padrão é `true`.
`cloud_properties.project_id`	`String` Se o sistema SAP estiver em execução em um servidor da Solução Bare Metal, especifique o ID do projeto do Google Cloud que você está usando com a Solução Bare Metal. Por padrão, quando o agente é executado em uma instância de VM, ele detecta o ID do projeto automaticamente.
`cloud_properties.instance_name`	`String` Se o sistema SAP estiver em execução em uma instância de VM do Compute Engine, especifique o nome dessa instância de VM. O agente detecta automaticamente o nome da instância de VM durante a instalação. Se o sistema SAP estiver em execução em um servidor da Solução Bare Metal, especifique o nome desse servidor.
`cloud_properties.region`	`String` Se o sistema SAP estiver em execução em um servidor da Solução Bare Metal, especifique a região do servidor da Solução Bare Metal. Por padrão, quando o agente é executado em uma instância de VM, ele usa a região da instância em que o agente está instalado.
`cloud_properties.zone`	`String` Por padrão, quando o agente é executado em uma instância de VM, ele usa a zona da instância da VM em que o agente está instalado.
`cloud_properties.image`	`String` Especifique o nome da imagem do SO da instância. Por padrão, quando o agente é executado em uma instância de VM, ele detecta a imagem do SO da instância de VM em que o agente está instalado.
`cloud_properties.numeric_project_id`	`String` Especifique o ID numérico do projeto do Google Cloud em que o sistema SAP está sendo executado. Por padrão, quando o agente é executado em uma instância de VM, ele detecta o ID numérico do projeto automaticamente.
`discovery_configuration.enable_workload_discovery`	`Boolean` Para permitir que o agente colete os nomes e as versões dos produtos SAP em execução no host, especifique `true`. O valor padrão é `true`. Para mais informações, consulte a base de código do agente no repositório `google-cloud-sap-agent` do GitHub em GoogleCloudPlatform/sapagent.
`discovery_configuration.enable_discovery`	`Boolean` Para enviar ao Cloud Logging as informações coletadas pelo agente sobre os produtos SAP em execução no host, especifique `true`. O valor padrão é `true`. Se você especificar o valor `false`, o agente armazenará as informações coletadas no host e não as enviará para o Cloud Logging.
`collection_configuration.collect_process_metrics`	`Boolean` Para ativar a coleta de métricas de monitoramento de processo, especifique `true`. O padrão é `false`. Esse parâmetro é aplicável somente ao Linux. Se você ativar a coleta de métricas do processo para o SAP HANA, será necessário configurar outros parâmetros listados em `hana_metrics_config`.
`collection_configuration.process_metrics_frequency`	`Int` A partir da versão 2.6, esse parâmetro determina a frequência de coleta das métricas do monitoramento de processos com rápida mudança, em segundos. As métricas do monitoramento de processos com rápida mudança são: `sap/hana/availability`, `sap/hana/ha/availability` e `sap/nw/availability`. O valor padrão desse parâmetro é `5` segundos. Recomendamos que você use esse valor padrão. Todas as outras métricas do monitoramento de processos (com mudanças lentas) são coletadas a uma frequência padrão de 30 segundos. Para mudar a frequência de coleta das métricas do monitoramento de processos com mudanças lentas, use o parâmetro `slow_process_metrics_frequency`.
`collection_configuration.slow_process_metrics_frequency`	`Int` Especifique a frequência de coleta das métricas do monitoramento de processos com mudanças lentas, em segundos. O valor padrão desse parâmetro é `30` segundos.
`collection_configuration.process_metrics_to_skip`	`Array` Especifique as métricas do monitoramento de processos que você não quer que o agente colete. Esse parâmetro aceita um valor separado por vírgulas dos nomes das métricas do monitoramento de processos. Por exemplo, `"process_metrics_to_skip": ["/sap/nw/abap/sessions", "/sap/nw/abap/rfc"]`.
`collection_configuration.hana_metrics_config.hana_db_user`	`String` Especifique a conta de usuário do banco de dados que o agente usa para consultar o SAP HANA. O padrão é `SYSTEM`.
`collection_configuration.hana_metrics_config.hana_db_password`	`String` Especifique a senha de texto simples para a conta de usuário do banco de dados que o agente usa para consultar o SAP HANA. Em vez de usar uma senha de texto simples, recomendamos usar um secret no Secret Manager especificando o nome do secret em `hana_db_password_secret_name`. Não especifique uma senha se você estiver usando o Secret Manager para armazenar as credenciais de usuário do banco de dados. Quando `hana_db_password` e `hana_db_password_secret_name` são especificados na configuração, um erro é acionado e o agente não conseguirá se conectar ao banco de dados.
`collection_configuration.hana_metrics_config.hana_db_password_secret_name`	`String` Para fornecer com segurança a senha da conta de usuário do banco de dados que o agente usa para consultar o SAP HANA, especifique o nome do secret que contém as credenciais de segurança para a conta de usuário do banco de dados. As métricas relacionadas ao SAP HANA serão coletadas apenas se `hana_db_password_secret_name` ou `hana_db_password` estiver definido. Importante: o secret e a instância de VM do host precisam existir no mesmo projeto do Google Cloud.

Acessar as métricas coletadas

Para visualizar as métricas do monitoramento de processos coletadas pelo agente, use os seguintes painéis personalizados fornecidos pelo Google Cloud:

Agente do SAP: visão geral do HANA: este painel fornece gráficos que exibem a visão geral do status das seguintes métricas: Disponibilidade do SAP HANA, Disponibilidade de alta disponibilidade do SAP HANA, Replicação de alta disponibilidade do SAP HANA, Status de serviço do SAP HANA, Cluster de alta disponibilidade - Estado do nó e Cluster de alta disponibilidade - Estado de recurso para instâncias SAP.

O arquivo JSON desse painel é sap-agent-status-overview.json.
Agente do SAP: métricas brutas do HANA: este painel fornece gráficos que mostram valores de métricas brutas para as seguintes métricas: Disponibilidade do SAP HANA, Disponibilidade de alta disponibilidade do SAP HANA, Replicação de alta disponibilidade do SAP HANA, Status de serviço do SAP HANA, Cluster de alta disponibilidade - Estado do nó e Cluster de alta disponibilidade - Estado de recurso para instâncias SAP.

O arquivo JSON desse painel é sap-agent-raw-metrics.json.

Instalar painéis

Para instalar um painel personalizado, siga estas etapas:

Console do Google Cloud

No Console do Google Cloud, acesse a página Monitoring.

Acessar Monitoring
No painel de navegação do Monitoring, clique em Painéis.
Clique na guia Biblioteca de exemplo.
Para filtrar os painéis personalizados específicos do agente, digite Agent for SAP no campo Filtro.
(Opcional) Para conferir detalhes sobre um painel ou o conteúdo, clique em Visualizar.
Selecione o painel que você quer editar.
Clique em Importar e em Confirmar.

O painel é adicionado aos painéis disponíveis no projeto do Google Cloud. Para consultar o painel, siga as instruções em Consultar o painel instalado.

Google Cloud CLI

Abra o Cloud Shell:

Abrir o Cloud Shell

No Cloud Shell, clone ou faça o download do repositório:

git clone https://github.com/GoogleCloudPlatform/monitoring-dashboard-samples/

No Cloud Shell, instale o painel necessário usando o arquivo JSON correspondente:
```
gcloud monitoring dashboards create --config-from-file=CONFIG_FROM_FILE
```
Substitua CONFIG_FROM_FILE pelo caminho para o arquivo JSON que contém a configuração do painel. Os arquivos de configuração do painel podem estar localizados no caminho: monitoring-dashboard-samples/dashboards/google-cloud-agent-for-sap.

O painel é adicionado aos painéis disponíveis no projeto do Google Cloud. Para acessar o painel, siga as instruções em Visualizar o painel instalado.

Consultar os painéis instalados

Para consultar os painéis instalados, siga estas etapas:

No Console do Google Cloud, acesse a página Monitoring.

Acessar Monitoring
No painel de navegação do Monitoring, clique em Painéis.
Clique no nome do painel na lista.

Se você tiver muitos painéis, filtre por painéis personalizados ou pelo nome do novo painel. Para mais informações sobre como filtrar essa lista, consulte Consultar painéis personalizados.

A imagem a seguir é um exemplo que mostra uma parte do painel personalizado para métricas do SAP HANA no Monitoring.

A captura de tela mostra o painel personalizado para métricas do SAP HANA no Monitoring