Instalar e configurar o agente do Google Cloud para SAP em uma instância do Compute Engine

O agente do Google Cloud para SAP é necessário para a compatibilidade da SAP com sistemas SAP em execução no Google Cloud, incluindo SAP NetWeaver, SAP HANA, SAP ASE, SAP MaxDB e outros.

Quando você instala o agente do Google Cloud para SAP em uma instância do Compute Engine, para as métricas do agente de host da SAP, o agente combina dados de monitoramento do Cloud Monitoring com as APIs do Compute Engine e fornece esses dados ao agente de host da SAP.

Se você usar as seguintes imagens de SO do RHEL ou do SLES "for SAP" fornecidas pelo Google Cloud, o agente do Google Cloud para SAP será empacotado com as imagens do SO:

  • RHEL: todas as imagens "for SAP"
  • SLES: SLES 15 SP4 para SAP e versões posteriores

Para informações sobre os sistemas operacionais compatíveis com o agente do Google Cloud para SAP, consulte Sistemas operacionais compatíveis.

Para instalar e configurar a versão 2 do agente do Google Cloud para SAP em um servidor da Solução Bare Metal, consulte Instalar o agente do Google Cloud para SAP em um servidor da Solução Bare Metal.

Visão geral da instalação

No Linux, você instala o agente do Google Cloud para SAP usando comandos padrão de gerenciamento de pacotes do sistema operacional: no RHEL, o comando yum, no SLES, o comando zypper. O comando de gerenciamento de pacotes conclui as seguintes tarefas:

  • Faz o download do agente do Google Cloud para SAP.
  • Cria o agente como um serviço systemd do Linux, chamado google-cloud-sap-agent.
  • Ativa e inicia o serviço google-cloud-sap-agent.

No Windows, instale o agente do Google Cloud para SAP usando o comando de gerenciamento de pacotes GooGet, googet. O comando de gerenciamento de pacotes conclui as seguintes tarefas:

  • Faz o download do agente do Google Cloud para SAP.
  • Cria um serviço do Windows chamado google-cloud-sap-agent e uma tarefa programada que é executada a cada minuto para verificar se o serviço ainda está em execução e, se necessário, reiniciá-lo.

Pré-requisitos do agente

Antes de instalar o agente do Google Cloud para SAP, os pré-requisitos a seguir precisam ser atendidos.

Definir os papéis do IAM necessários

No mínimo, a conta de serviço que o agente do Google Cloud para SAP usa precisa incluir os papéis de Leitor do Compute (roles/compute.viewer), Leitor do Monitoring (roles/monitoring.viewer), e Gravador de insights do gerenciador de carga de trabalho (roles/workloadmanager.insightWriter).

Para adicionar um papel necessário à conta de serviço, siga estas etapas:

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

    Acessar IAM

  2. Selecione seu projeto do Google Cloud.

  3. 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.
  4. Selecione o papel necessário na lista de papéis disponíveis:

    • Compute Engine > Visualizador do Compute
    • Monitoramento > Leitor do Monitoring
    • Gerenciador de cargas de trabalho > Gravador de insights do gerenciador de cargas de trabalho
  5. Clique em Adicionar ou Salvar para aplicar os papéis à conta de serviço.

Ativar o acesso às APIs do Google Cloud

O Compute Engine recomenda configurar as instâncias de computação para permitir todos os escopos de acesso a todas as APIs do Cloud e usar apenas as permissões do IAM da conta de serviço da instância para controlar o acesso aos recursos do Google Cloud. Para mais informações, consulte Criar uma VM que usa uma conta de serviço gerenciada pelo usuário.

Se você limitar o acesso às APIs do Cloud, o Agente do Google Cloud para SAP exigirá os seguintes escopos mínimos de acesso da API Cloud na instância do Compute Engine do host:

  • Cloud Platform: ativado
  • Compute Engine: somente leitura
  • API Stackdriver Monitoring: somente leitura

Se você estiver executando aplicativos SAP em uma instância de computação que não tenha um endereço IP externo, ative o Acesso particular do Google na sub-rede da instância de computação para que o agente do Google Cloud para SAP possa acessar as APIs e os serviços do Google. Para ativar o acesso privado do Google em uma sub-rede, consulte Como configurar o acesso privado do Google.

Instalar o agente

Recomendamos que você instale a versão mais recente do agente do Google Cloud para SAP, que dá suporte a mais recursos. Para instruções, consulte Instalar e configurar o agente do Google Cloud para SAP em uma instância do Compute Engine.

Para instalar a versão 2 do agente do Google Cloud para SAP, entre em contato com o Cloud Customer Care.

Depois de instalar o agente do Google Cloud para SAP e o agente de host da SAP, valide a instalação do agente do Google Cloud para SAP, conforme descrito em Validar a instalação do agente.

Validar a instalação do agente

Para verificar se o agente está em execução, selecione seu sistema operacional e siga as etapas:

Linux

  1. Estabeleça uma conexão SSH com a instância do Compute Engine.

  2. Execute este comando:

    systemctl status google-cloud-sap-agent

    Se o agente estiver funcionando corretamente, a saída conterá active (running). Por exemplo:

    google-cloud-sap-agent.service - Google Cloud Agent for SAP
    Loaded: loaded (/usr/lib/systemd/system/google-cloud-sap-agent.service; enabled; vendor preset: disabled)
    Active:  active (running)  since Fri 2022-12-02 07:21:42 UTC; 4 days ago
    Main PID: 1337673 (google-cloud-sa)
    Tasks: 9 (limit: 100427)
    Memory: 22.4 M (max: 1.0G limit: 1.0G)
    CGroup: /system.slice/google-cloud-sap-agent.service
           └─1337673 /usr/bin/google-cloud-sap-agent
    

Windows

  1. Use o RDP para se conectar à instância do Compute Engine.

  2. Como administrador, emita o seguinte comando no PowerShell:

    $(Get-Service -Name 'google-cloud-sap-agent' -ErrorAction Ignore).Status
    Se o agente estiver em execução, o status mostrará Running.

Se o agente não estiver em execução, reinicie-o.

Verificar se o SAP Host Agent está recebendo métricas

Para verificar se as métricas de infraestrutura são coletadas pelo agente do Google Cloud para SAP e enviadas corretamente ao agente de host da SAP, siga estas etapas:

  1. No sistema SAP, insira a transação ST06.
  2. No painel de visão geral, verifique a disponibilidade e o conteúdo dos seguintes campos para a configuração completa da infraestrutura de monitoramento da SAP e do Google:

    • Provedor de nuvem: Google Cloud Platform
    • Acesso ao monitoramento avançado: TRUE
    • Detalhes do monitoramento avançado: ACTIVE

Configurar o agente do Google Cloud para SAP no Linux

Depois de instalar o agente do Google Cloud para SAP, é possível ativar outros recursos do agente executando as configurações a seguir. Por padrão, a coleta apenas das métricas do agente SAP Host está ativada.

Arquivo de configuração padrão

O snippet a seguir é um exemplo da configuração padrão da versão 2 (mais recente) do agente do Google Cloud para SAP:

{
  "provide_sap_host_agent_metrics": true,
  "bare_metal": ,
  "log_level": "INFO",
  "log_to_cloud": true,
  "collection_configuration": {
    "collect_workload_validation_metrics": false,
    "collect_process_metrics": false,
    "sap_system_discovery": true
  },
  "hana_monitoring_configuration": {
    "enabled": false
  }
}

Parâmetros de configuração

A tabela a seguir explica os parâmetros de configuração da versão 2 do agente para SAP do Google Cloud.

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.

sap_system_discovery

Boolean

Para ativar a descoberta do sistema SAP, 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 do Compute Engine, ele detecta o ID do projeto automaticamente.

cloud_properties.instance_name

String

Se o sistema SAP estiver em execução em uma instância do Compute Engine, especifique o nome dessa instância. O agente detecta automaticamente o nome da instância de computação 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 computação, ele usa a região em que a instância de computação é implantada.

cloud_properties.zone

String

Por padrão, quando o agente é executado em uma instância de computação, ele usa a zona em que a instância de computação é implantada.

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 computação, ele detecta automaticamente a imagem do SO usada pela instância de computação.

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 computação, ele detecta automaticamente o número do projeto.

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 especificar uma senha de texto simples, recomendamos que você use uma das seguintes opções:

  • hana_db_password_secret_name, para o qual você especifica um secret armazenado no Secret Manager.
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.

O agente coleta as métricas relacionadas ao SAP HANA somente quando você especifica hana_db_password_secret_name, ou hana_db_password.

collection_configuration.hana_metrics_config.sid

String

Especifique o SID da instância do SAP HANA.

collection_configuration.collect_workload_validation_metrics

Boolean

Para ativar a coleta de métricas de avaliação do gerenciador de cargas de trabalho, especifique true. A partir da versão 3.2, o valor padrão é true.
Esse parâmetro é aplicável somente a Linux.

collection_configuration.workload_validation_metrics_frequency

Int

A frequência de coleta das métricas de avaliação do gerenciador de cargas de trabalho em segundos. O valor padrão é de 300 segundos.

Se você precisar modificar a frequência de coleta das métricas do gerenciador de cargas de trabalho, adicione o parâmetro workload_validation_metrics_frequency na seção collection_configuration e forneça o valor necessário.

collection_configuration.workload_validation_db_metrics_config.hana_db_user

String

Especifique a conta de usuário usada para consultar a instância do SAP HANA. A conta de usuário precisa ter a permissão de leitura para o banco de dados SAP HANA.

collection_configuration.workload_validation_db_metrics_config.hana_db_password

String

Especifique a senha da conta de usuário usada para consultar a instância do SAP HANA.

collection_configuration.workload_validation_db_metrics_config.hana_db_password_secret_name

String

Especifique o nome do secret no Secret Manager que armazena a senha da conta de usuário.

collection_configuration.workload_validation_db_metrics_config.sid

String

Especifique o SID da instância do SAP HANA.

collection_configuration.workload_validation_db_metrics_config.hostname

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.
collection_configuration.workload_validation_db_metrics_config.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.

collection_configuration.workload_validation_db_metrics_frequency

Int

A frequência de coleta das métricas do banco de dados SAP HANA, em segundos, para avaliação do Gerenciador de cargas de trabalho. O padrão é 3600 segundos.

Embora seja possível atualizar a frequência de coleta das métricas do banco de dados SAP HANA, recomendamos o uso do valor padrão. Se você precisar modificar o valor padrão, adicione o parâmetro workload_validation_db_metrics_frequency na seção collection_configuration e forneça o valor necessário. Não defina uma frequência de coleta maior que 3600 segundos.

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

Solução de problemas

Para informações sobre como diagnosticar e resolver problemas que você pode encontrar ao instalar e configurar o agente do Google Cloud para SAP, consulte o guia de solução de problemas do agente do Google Cloud para SAP.

Receber suporte

Se você precisar de ajuda para resolver problemas com o agente do Google Cloud para SAP, colete todas as informações de diagnóstico disponíveis e entre em contato com o Cloud Customer Care. Para mais informações sobre como entrar em contato com o atendimento ao cliente, consulte Como receber suporte para o SAP no Google Cloud.