Configurar a coleta de métricas do monitoramento do SAP HANA

Neste guia, mostramos como configurar o agente do Google Cloud para SAP para coletar as métricas de monitoramento do SAP HANA dos sistemas SAP HANA.

Para informações sobre esse recurso, consulte Como monitorar o SAP HANA 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 do SAP HANA, 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)
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 de monitoramento do SAP HANA

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

Estabeleça uma conexão SSH com a instância de VM do Compute Engine ou o servidor da Solução Bare Metal.
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 hana_monitoring_configuration, faça o seguinte:
- Para o parâmetro enabled, defina o valor true.
- Na seção hana_instances, especifique as instâncias do SAP HANA que você quer que o agente monitore.
- Como opção, defina as consultas personalizadas. Para informações sobre como definir consultas personalizadas e ver exemplos, consulte Como definir consultas personalizadas.
- Como opção, desative as consultas integradas ou padrão. Para instruções, consulte Desativar uma consulta SQL.
  
  Para informações sobre os parâmetros de configuração, consulte este link.
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 exemplo a seguir é um arquivo de configuração completo do Agente para SAP do Google Cloud em execução em uma instância de VM dodo Compute Engine, em que a coleção de métricas de monitoramento do SAP HANA está ativada. Observe que a consulta personalizada incluída neste exemplo, chamada custom_query, segue as diretrizes de definição de consultas personalizadas especificadas em Como definir consultas personalizadas.

{
  "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": false
  },
  "cloud_properties": {
    "project_id": "my-project",
    "instance_name": "vm-instance-1",
    "image": "rhel-8"
  },
  "discovery_configuration": {
    "enable_discovery": true,
    "enable_workload_discovery": true
  },
  "hana_monitoring_configuration": {
    "enabled": true,
    "sample_interval_sec": 60,
    "query_timeout_sec": 30,
    "execution_threads": 20,
    "hana_instances": [
      {
        "name": "local",
        "sid": "DEH",
        "host": "localhost",
        "port": "30015",
        "user": "system",
        "secret_name": "password-secret-name",
        "hdbuserstore_key": "user_store_key"
      },
      {
        "name": "remote",
        "sid": "DEH",
        "host": "10.123.0.12",
        "port": "30015",
        "user": "system",
        "secret_name": "password-secret-name",
        "hdbuserstore_key": "user_store_key"
      }
    ],
    "queries": [
      {
        "name": "custom_query",
        "enabled": true,
        "sql": "SELECT * FROM MyTable;",
        "columns": [
          {
            "name": "string",
            "metric_type": "METRIC_LABEL",
            "value_type": "VALUE_STRING"
          },
          {
            "name": "bool",
            "metric_type": "METRIC_GAUGE",
            "value_type": "VALUE_BOOL"
          },
          {
            "name": "int",
            "metric_type": "METRIC_GAUGE",
            "value_type": "VALUE_INT64"
          },
          {
            "name": "double",
            "metric_type": "METRIC_GAUGE",
            "value_type": "VALUE_DOUBLE"
          }
        ]
      },
      {
        "name": "default_host_queries",
        "enabled": false
      }
    ]
  }
}

Servidor da Solução Bare Metal

O exemplo a seguir é um arquivo de configuração completo do Agente para SAP do Google Cloud em execução em uma instância de VM doservidor da Solução Bare Metal, em que a coleção de métricas de monitoramento do SAP HANA está ativada. Observe que a consulta personalizada incluída neste exemplo, chamada custom_query, segue as diretrizes de definição de consultas personalizadas especificadas em Como definir consultas personalizadas.

{
  "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": false
  },
  "cloud_properties": {
    "project_id": "my-project",
    "instance_name": "bms-machine-1"
    "region": "us-central1",
    "image": "rhel-8"
  },
  "discovery_configuration": {
    "enable_discovery": true,
    "enable_workload_discovery": true
  },
  "hana_monitoring_configuration": {
    "enabled": true,
    "sample_interval_sec": 60,
    "query_timeout_sec": 30,
    "execution_threads": 20,
    "hana_instances": [
      {
        "name": "local",
        "sid": "DEH",
        "host": "localhost",
        "port": "30015",
        "user": "system",
        "secret_name": "password-secret-name",
        "hdbuserstore_key": "user_store_key"
      },
      {
        "name": "remote",
        "sid": "DEH",
        "host": "10.123.0.12",
        "port": "30015",
        "user": "system",
        "secret_name": "password-secret-name",
        "hdbuserstore_key": "user_store_key"
      }
    ],
    "queries": [
      {
        "name": "custom_query",
        "enabled": true,
        "sql": "SELECT * FROM MyTable;",
        "columns": [
          {
            "name": "string",
            "metric_type": "METRIC_LABEL",
            "value_type": "VALUE_STRING"
          },
          {
            "name": "bool",
            "metric_type": "METRIC_GAUGE",
            "value_type": "VALUE_BOOL"
          },
          {
            "name": "int",
            "metric_type": "METRIC_GAUGE",
            "value_type": "VALUE_INT64"
          },
          {
            "name": "double",
            "metric_type": "METRIC_GAUGE",
            "value_type": "VALUE_DOUBLE"
          }
        ]
      },
      {
        "name": "default_host_queries",
        "enabled": false
      }
    ]
  }
}

Definir uma consulta SQL personalizada

O agente do Google Cloud para SAP coleta as métricas de monitoramento do SAP HANA executando consultas SQL nas instâncias do SAP HANA. Além dessas consultas padrão, é possível definir e executar consultas SQL personalizadas concluindo as seguintes etapas:

Estabeleça uma conexão SSH com a instância de VM do Compute Engine ou o servidor da Solução Bare Metal.

Abra o arquivo de configuração do agente:

/etc/google-cloud-sap-agent/configuration.json

Na seção hana_monitoring_configuration.queries, defina sua consulta personalizada.

Para informações sobre como definir consultas personalizadas e ver exemplos, consulte Como definir consultas personalizadas.
Para ativar uma consulta personalizada, defina o parâmetro enabled como true.
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
```

Desativar uma consulta SQL

Se você não quiser executar nenhuma das consultas SQL integradas que o Agente para SAP do Google Cloud fornece por padrão ou qualquer uma das consultas personalizadas que você definir, desative a consulta SQL concluindo as seguintes etapas:

Estabeleça uma conexão SSH com a instância de VM do Compute Engine ou o servidor da Solução Bare Metal.

Abra o arquivo de configuração do agente:

/etc/google-cloud-sap-agent/configuration.json

Para desativar uma consulta integrada ou padrão, inclua o seguinte na seção hana_monitoring_configuration.queries:
```
{
"name": "default_QUERY_NAME",
"enabled": false
}
```
Substitua QUERY_NAME pelo nome da consulta padrão. Para informações sobre as consultas padrão, consulte Referência de consultas padrão.
Para desativar uma consulta personalizada, defina o parâmetro enabled como false para essa consulta personalizada.
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
```

Parâmetros de configuração

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

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.
`hana_monitoring_configuration.enabled`	`Boolean` Opcional. Para permitir que o agente do Google Cloud para SAP colete as métricas de monitoramento do SAP HANA, especifique `true`. O valor padrão é `false`. Os parâmetros filhos a seguir são aplicáveis somente quando você especifica `hana_monitoring_configuration.enabled: true`.
`hana_monitoring_configuration.sample_interval_sec`	`Int` Opcional. Especifique o intervalo de amostra, em segundos, que determina a frequência com que o agente do Google Cloud para SAP consulta as instâncias do SAP HANA para coletar as métricas de monitoramento do SAP HANA. O valor padrão é de 300 segundos. Para cada consulta definida no arquivo de configuração do agente do Google Cloud para SAP, é possível substituir o intervalo de amostra global especificando o intervalo necessário para o parâmetro `sample_interval_sec`. Os intervalos de amostra precisam ter cinco segundos ou mais.
`hana_monitoring_configuration.query_timeout_sec`	`Int` Opcional. Especifique o tempo limite de cada consulta feita às instâncias do SAP HANA. O valor padrão é de 300 segundos.
`hana_monitoring_configuration.execution_threads`	`Int` Opcional. Especifique o número de linhas de execução usadas para enviar consultas às instâncias do SAP HANA. Cada consulta é executada na própria linha de execução. O valor padrão é 10.
`hana_monitoring_configuration.hana_instances.name`	`String` Especifique o identificador de nome da instância do SAP HANA.
`hana_monitoring_configuration.hana_instances.sid`	`String` Especifique o SID da instância do SAP HANA. Essa string é adicionada como uma etiqueta a todas as métricas resultantes da consulta às instâncias do SAP HANA.
`hana_monitoring_configuration.hana_instances.host`	`String` Especifique o identificador da máquina local ou remota que hospeda a instância do SAP HANA. Confira a seguir os valores compatíveis: Se o host for uma máquina local, especifique a string `localhost` ou o endereço IP do loopback do localhost, como `127.0.0.1`. Se o host for uma máquina remota, especifique o endereço IP interno ou externo.
`hana_monitoring_configuration.hana_instances.port`	`String` Especifique a porta em que a instância do SAP HANA aceita consultas. Para a primeira ou única instância do banco de dados do locatário, a porta é `3NN15`, em que `NN` é o número da instância do SAP HANA.
`hana_monitoring_configuration.hana_instances.user`	`String` Especifique a conta de usuário usada para consultar a instância do SAP HANA. Verifique se esse usuário tem o privilégio para ler as visualizações de monitoramento no banco de dados do SAP HANA. Se esse privilégio não for concedido, as métricas de monitoramento do SAP HANA relacionadas às visualizações de monitoramento não conterão dados.
`hana_monitoring_configuration.hana_instances.password`	`String` Opcional. Especifique a senha, como texto simples, que autentica a conta de usuário para consultar a instância do SAP HANA. Para a autenticação, especifique uma das seguintes opções: A senha de texto simples para o parâmetro `password`. (Recomendado) Se você usar o Secret Manager para armazenar a senha como um secret, especifique o nome do secret correspondente ao parâmetro `secret_name`. (Recomendado) Uma chave `hdbuserstore` para o parâmetro `hdbuserstore_key`.
`hana_monitoring_configuration.hana_instances.secret_name`	`String` Opcional. Especifique o nome do secret no Secret Manager que armazena a senha da conta de usuário.
`hana_monitoring_configuration.hana_instances.hdbuserstore_key`	`String` Para se conectar com segurança a um sistema SAP HANA, especifique um Proteger a chave do repositório de usuários (`hdbuserstore`) que você criou para esse item em todo o sistema. Para usar uma chave `hdbuserstore` para autenticação, verifique o seguinte: As ferramentas SAP `hdbsql` e `hdbuserstore` estão instaladas na instância da computação que hospeda o agente. A chave `hdbuserstore` corresponde a uma instância específica do SAP HANA. Não é possível usar chaves que contenham nomes de host de várias instâncias do SAP HANA. O usuário `SIDadm` pode consultar o banco de dados SAP HANA usando esta chave. Aqui, `SID` se refere ao valor especificado para o parâmetro `sid`. Você pode verificar isso executando o seguinte comando como o usuário `SIDadm`: hdbsql -U `HDB_USERSTORE_KEY` "SELECT * FROM DUMMY" Esse parâmetro de configuração é compatível com a versão 3.3 do agente. Se você especificar `hdbuserstore_key`, poderá pular a especificação dos parâmetros `host` e `port`.
`hana_monitoring_configuration.hana_instances.enable_ssl`	`Boolean` Opcional. Especifique se o SSL está ativado na instância do SAP HANA. O valor padrão é `false`.
`hana_monitoring_configuration.hana_instances.host_name_in_certificate`	`String` Se você especificar `enable_ssl: true` para uma instância do SAP HANA, será necessário especificar o nome do host definido no certificado SSL.
`hana_monitoring_configuration.hana_instances.tls_root_ca_file`	`String` Se você especificar `enable_ssl: true` para uma instância do SAP HANA, será necessário especificar o caminho para seu certificado de segurança.
`hana_monitoring_configuration.queries.enabled`	`Boolean` Opcional. Para ativar uma consulta SQL para todas as instâncias do SAP HANA, especifique o valor `true` para o parâmetro `enabled` nessa consulta SQL.
`hana_monitoring_configuration.queries.name`	`String` Se você definiu consultas personalizadas no arquivo de configuração, especifique um nome exclusivo para cada consulta personalizada. O nome da consulta precisa ser exclusivo porque ele é usado para criar o URL padrão da métrica no Monitoring.
`hana_monitoring_configuration.queries.sql`	`String` Especifique a instrução SQL que o agente emite para as instâncias do SAP HANA. A instrução SQL precisa estar em conformidade com a sintaxe SQL definida pela SAP em Referência do SQL do SAP HANA e referência de visualizações do sistema.
`hana_monitoring_configuration.queries.sample_interval_sec`	`Int` Opcional. Especifique o intervalo de amostra da consulta SQL. Isso substitui o intervalo global da amostra. O valor precisa ser de cinco segundos ou mais.
`hana_monitoring_configuration.queries.columns.name`	`String` Especifique um nome exclusivo que identifique cada coluna. O nome da coluna precisa ser exclusivo porque ele é usado para criar o URL padrão da métrica no Monitoring.
`hana_monitoring_configuration.queries.columns.metric_type`	`String` Para gerenciar pelo Monitoring, especifique um dos seguintes tipos de métrica: `METRIC_LABEL`, `METRIC_GAUGE` ou `METRIC_CUMULATIVE`. As métricas do tipo `METRIC_LABEL` são anexadas como etiquetas a todas as métricas `METRIC_GAUGE` e `METRIC_CUMULATIVE` enviadas ao Monitoring.
`hana_monitoring_configuration.queries.columns.value_type`	`String` Para gerenciar pelo Monitoring, especifique um tipo de dados compatível com o tipo de métrica. Os tipos de dados compatíveis são: `VALUE_BOOL`, `VALUE_INT64`, `VALUE_STRING` ou `VALUE_DOUBLE`. Para mais informações, consulte Combinação compatível.
`hana_monitoring_configuration.queries.columns.name_override`	`String` Opcional. Para processamento pelo Monitoring, especifique o caminho que você quer mostrar no URL da métrica no lugar dos nomes da consulta e da coluna. Por exemplo: URL padrão da métrica: `workload.googleapis.com/sap/hanamonitoring/QUERY_NAME/COLUMN_NAME` URL da métrica usando o caminho personalizado: `workload.googleapis.com/sap/hanamonitoring/CUSTOM_PATH`

Acessar as métricas coletadas

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

Agente para SAP: visão geral detalhada do HANA: esse painel apresenta gráficos que exibem a visão geral do status das seguintes métricas: memória da instância, memória de serviço usada, memória máxima estimada do esquema, tamanho total da memória do repositório de linhas, outliers de leitura do esquema, outliers de gravação do esquema, últimos outliers de contagem de registros compactados do esquema, conexões do sistema, alertas, porcentagem de CPU das cinco VMs principais, porcentagem de memória das cinco VMs principais e os hosts por região.

O arquivo JSON desse painel é agent-for-sap-hana-detailed-overview.json.
Agente para SAP - Desempenho do HANA: esse painel apresenta gráficos que exibem valores brutos das seguintes métricas: memória da instância, outliers de leitura e gravação do esquema, desempenho do esquema, uso da memória, outliers de contagem de registros do esquema, memória total do serviço usada, tamanho da memória do armazenamento de linhas, conexões inativas e em execução do sistema, memória da conexão e do repositório de linhas, registros totais do esquema e tamanho total máximo estimado do esquema.

O arquivo JSON desse painel é agent-for-sap-hana-performance.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