Configurar a coleta de métricas de avaliação do gerenciador de cargas de trabalho

Neste guia, mostramos como configurar o agente do Google Cloud para SAP para coletar as métricas de avaliação do gerenciador de cargas de trabalho dos seus sistemas SAP.

Para informações sobre esse recurso, consulte Avaliação do gerenciador de cargas de trabalho usando o agente do Google Cloud para SAP.

Antes de começar

Defina papéis do IAM

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

Para adicionar esses papéis necessários à sua 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:

    • Leitor do Compute
    • Gerenciador de cargas de trabalho > Gravador de insights do gerenciador de cargas de trabalho
    • Secret Manager > Acessador de secrets do Secret Manager

  5. Clique em Adicionar ou Salvar para aplicar os papéis à conta de serviço.

Para um nível granular de acesso, defina as seguintes permissões do IAM para sua função personalizada:

  • Coleta de métricas:
    • monitoring.timeSeries.create
    • compute.zoneOperations.list
    • compute.disks.list
    • compute.nodeGroups.get
    • workloadmanager.insights.write
  • Secrets Manager:
    • secretmanager.versions.access

Para mais informações sobre como criar um papel personalizado, consulte Criar e gerenciar papéis personalizados.

Verificar a versão do agente

O Google Cloud recomenda que você instale a versão mais recente do agente do Google Cloud para SAP para uma avaliação precisa das suas cargas de trabalho SAP, porque versões periódicas do agente para SAP podem adicionar ou alterar as métricas usadas para a avaliação.

Para garantir que você tenha a versão mais recente do agente do Google Cloud para SAP, é preciso verificar as atualizações periodicamente e atualizar o agente.

Instalar uma atualização

Selecione seu sistema operacional e siga estas etapas:

RHEL

  1. Estabeleça uma conexão SSH com sua instância.
  2. Atualize a instância do agente:
    • (Recomendado) Para atualizar para a versão 3.6 (mais recente) do agente: 
      sudo yum --nogpgcheck update google-cloud-sap-agent
    • Para atualizar para uma versão específica do agente: 
      sudo yum install google-cloud-sap-agent-VERSION_NUMBER.x86_64

      Substitua VERSION_NUMBER pelo número da versão do agente que você quer instalar, como 3.1-606637668. Para informações sobre as versões do agente que podem ser instaladas, consulte Listar todas as versões disponíveis do agente.

SLES

  1. Estabeleça uma conexão SSH com sua instância.
  2. Atualize a instância do agente:
    • (Recomendado) Para atualizar para a versão 3.6 (mais recente) do agente: 
      sudo zypper --no-gpg-checks update google-cloud-sap-agent
    • Para atualizar para uma versão específica do agente: 
      sudo zypper install google-cloud-sap-agent-VERSION_NUMBER.x86_64

      Substitua VERSION_NUMBER pelo número da versão do agente que você quer instalar, como 3.1-606637668. Para informações sobre as versões do agente que podem ser instaladas, consulte Listar todas as versões disponíveis do agente.

Ativar a coleta de métricas de avaliação do gerenciador de cargas de trabalho

A partir da versão 3.2, as novas instalações do agente do Google Cloud para SAP são ativadas por padrão para coletar as métricas de avaliação do gerenciador de cargas de trabalho. Se você estiver atualizando de uma versão anterior para a 3.2, também poderá ativar explicitamente o recurso. Para isso, siga as etapas abaixo:

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

  2. Para permitir que o agente colete as métricas de avaliação do gerenciador de cargas de trabalho: 

    sudo /usr/bin/google_cloud_sap_agent configure -feature=workload_evaluation -enable

  3. Para ativar a coleta das métricas "Insights do SAP HANA" e "Práticas recomendadas de segurança do SAP HANA":

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

    2. Adicione a seção workload_validation_db_metrics_config após collect_workload_validation_metrics e especifique os parâmetros abaixo:

      • hana_db_user: especifique a conta de usuário do banco de dados do SAP HANA que é usada para consultar a instância do SAP HANA.
      • hostname: especifique o identificador da máquina local ou remota que hospeda a instância do SAP HANA.
      • port: especifique a porta em que a instância do SAP HANA aceita consultas.
      • sid: especifique o SID da instância do SAP HANA.

      • hana_db_password_secret_name: especifique o nome do secret no Secret Manager que armazena a senha da conta de usuário

        Como alternativa ao secret, use o parâmetro de configuração hdbuserstore_key.

      • hdbuserstore_key: especifique a chave hdbuserstore que autentica o usuário especificado para hana_db_user.

        Se você especificar hdbuserstore_key, a especificação dos parâmetros hostname e port será ignorada.

      Para informações sobre esses parâmetros, consulte Parâmetros de configuração.

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

  5. Salve o arquivo de configuração.

  6. 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 do Compute Engine

Os exemplos a seguir são arquivos de configuração completos do Agente para SAP do Google Cloud em execução em uma do Compute Engine, em que a coleta de métricas de avaliação do Workload Manager está ativada.

Para a autenticação do SAP HANA, o agente usa a seguinte ordem de preferência: se especificado, o parâmetro de configuração hdbuserstore_key é preferido em relação ao parâmetro hana_db_password, que é preferido em relação ao parâmetro hana_db_password_secret_name. Recomendamos definir apenas uma opção de autenticação no arquivo de configuração.

  • O exemplo a seguir usa uma chave de armazenamento seguro de usuários (hdbuserstore) para a autenticação do SAP HANA: 
    {
  "provide_sap_host_agent_metrics": true,
  "bare_metal": false,
  "log_level": "INFO",
  "log_to_cloud": true,
  "collection_configuration": {
    "collect_workload_validation_metrics": true,
    "workload_validation_db_metrics_frequency": 3600,
    "workload_validation_db_metrics_config": {
      "hana_db_user": "system",
      "sid": "DEH",
      "hdbuserstore_key": "user_store_key"
    },
    "collect_process_metrics": false
  },
  "discovery_configuration": {
    "enable_discovery": true,
    "enable_workload_discovery": true
  },
  "hana_monitoring_configuration": {
    "enabled": false
  }
}
  • O exemplo a seguir usa um nome de usuário e um secret do Secret Manager para a autenticação do SAP HANA: 
    {
  "provide_sap_host_agent_metrics": true,
  "bare_metal": false,
  "log_level": "INFO",
  "log_to_cloud": true,
  "collection_configuration": {
    "collect_workload_validation_metrics": true,
    "workload_validation_db_metrics_frequency": 3600,
    "workload_validation_db_metrics_config": {
      "hana_db_user": "system",
      "sid": "DEH",
      "hana_db_password_secret_name": "instance-id-hana-db-password-secret",
      "hostname": "localhost",
      "port": "30015"
    },
    "collect_process_metrics": false
  },
  "discovery_configuration": {
    "enable_discovery": true,
    "enable_workload_discovery": true
  },
  "hana_monitoring_configuration": {
    "enabled": false
  }
}
  • O exemplo a seguir usa um nome de usuário e uma senha para a autenticação do SAP HANA. Recomendamos que você use um segredo do Secret Manager ou uma chave do armazenamento seguro de usuários (hdbuserstore) para a autenticação do SAP HANA. 
    {
  "provide_sap_host_agent_metrics": true,
  "bare_metal": false,
  "log_level": "INFO",
  "log_to_cloud": true,
  "collection_configuration": {
    "collect_workload_validation_metrics": true,
    "workload_validation_db_metrics_frequency": 3600,
    "workload_validation_db_metrics_config": {
      "hana_db_user": "system",
      "sid": "DEH",
      "hana_db_password": "TempPa55word",
      "hostname": "localhost",
      "port": "30015"
    },
    "collect_process_metrics": false
  },
  "discovery_configuration": {
    "enable_discovery": true,
    "enable_workload_discovery": true
  },
  "hana_monitoring_configuration": {
    "enabled": false
  }
}

Servidor da Solução Bare Metal

Os exemplos a seguir são arquivos de configuração completos do Agente para SAP do Google Cloud em execução em uma instância de servidor da Solução Bare Metal, em que a coleta de métricas de avaliação do Workload Manager está ativada.

Para a autenticação do SAP HANA, o agente usa a seguinte ordem de preferência: se especificado, o parâmetro de configuração hdbuserstore_key é preferido em relação ao parâmetro hana_db_password, que é preferido em relação ao parâmetro hana_db_password_secret_name. Recomendamos definir apenas uma opção de autenticação no arquivo de configuração.

  • O exemplo a seguir usa uma chave de armazenamento seguro de usuários (hdbuserstore) para a autenticação do SAP HANA: 
    {
  "provide_sap_host_agent_metrics": true,
  "bare_metal": true,
  "log_level": "INFO",
  "log_to_cloud": true,
  "collection_configuration": {
    "collect_workload_validation_metrics": true,
    "workload_validation_db_metrics_frequency": 3600,
    "workload_validation_db_metrics_config": {
      "hana_db_user": "system",
      "sid": "DEH",
      "hdbuserstore_key": "user_store_key"
    },
    "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": false
  }
}
  • O exemplo a seguir usa um nome de usuário e um secret do Secret Manager para a autenticação do SAP HANA: 
    {
  "provide_sap_host_agent_metrics": true,
  "bare_metal": true,
  "log_level": "INFO",
  "log_to_cloud": true,
  "collection_configuration": {
    "collect_workload_validation_metrics": true,
    "workload_validation_db_metrics_frequency": 3600,
    "workload_validation_db_metrics_config": {
      "hana_db_user": "system",
      "sid": "DEH",
      "hana_db_password_secret_name": "instance-id-hana-db-password-secret",
      "hostname": "localhost",
      "port": "30015"
    },
    "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": false
  }
}
  • O exemplo a seguir usa um nome de usuário e uma senha para a autenticação do SAP HANA. Recomendamos que você use um segredo do Secret Manager ou uma chave do armazenamento seguro de usuários (hdbuserstore) para a autenticação do SAP HANA. 
    {
  "provide_sap_host_agent_metrics": true,
  "bare_metal": true,
  "log_level": "INFO",
  "log_to_cloud": true,
  "collection_configuration": {
    "collect_workload_validation_metrics": true,
    "workload_validation_db_metrics_frequency": 3600,
    "workload_validation_db_metrics_config": {
      "hana_db_user": "system",
      "sid": "DEH",
      "hana_db_password": "TempPa55word",
      "hostname": "localhost",
      "port": "30015"
    },
    "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": false
  }
}

Parâmetros de configuração

Na tabela a seguir, explicamos os parâmetros de configuração do agente do Google Cloud para SAP que são específicos da coleta das métricas de avaliação do Gerenciador de cargas de trabalho.

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 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.
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_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_collection_definition.fetch_latest_config

Boolean

Opcional. O valor padrão é true, o que permite que o agente colete o conjunto mais recente de métricas de avaliação do Gerenciador de cargas de trabalho sem precisar atualizar o agente. Se você quiser desativar esse comportamento, especifique esse parâmetro no arquivo de configuração e defina o valor dele como false.
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.

Para a autenticação do SAP HANA, o agente usa a seguinte ordem de preferência: se especificado, o parâmetro de configuração hdbuserstore_key é preferido em relação ao parâmetro hana_db_password, que é preferido em relação ao parâmetro hana_db_password_secret_name. Recomendamos definir apenas uma opção de autenticação no arquivo de configuração.

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.

Como alternativa, é possível especificar o parâmetro de configuração hdbuserstore_key para autenticar o usuário especificado do SAP HANA.

Para a autenticação do SAP HANA, o agente usa a seguinte ordem de preferência: se especificado, o parâmetro de configuração hdbuserstore_key é preferido em relação ao parâmetro hana_db_password, que é preferido em relação ao parâmetro hana_db_password_secret_name. Recomendamos definir apenas uma opção de autenticação no arquivo de configuração.

collection_configuration.workload_validation_db_metrics_config.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, a especificação dos parâmetros hostname e port será ignorada.

Para a autenticação do SAP HANA, o agente usa a seguinte ordem de preferência: se especificado, o parâmetro de configuração hdbuserstore_key é preferido em relação ao parâmetro hana_db_password, que é preferido em relação ao parâmetro hana_db_password_secret_name. Recomendamos definir apenas uma opção de autenticação no arquivo de configuração.

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.

Acessar as métricas coletadas

Para visualizar as métricas de avaliação do gerenciador de cargas de trabalho que o agente coleta, faça o seguinte:

  • Consulte o arquivo de registros do agente:

    1. Defina o nível de registro do agente como DEBUG:

      sudo /usr/bin/google_cloud_sap_agent configure -loglevel=debug

    2. Consulte os registros do agente após a reinicialização para alterar o nível de registro arquivo:

      /var/log/google-cloud-sap-agent.log

    3. No arquivo de registro, procure entradas que contenham o seguinte:

      workload.googleapis.com/sap/validation/

      Este é um exemplo que mostra o gerenciador de cargas de trabalho métricas de avaliação no arquivo de registros do agente:

      {"level":"debug","timestamp":"2024-05-31T20:13:39.439Z",..."context":"WorkloadManagerMetrics",
      "metric":"workload.googleapis.com/sap/validation/system","value":1}
{"level":"debug","timestamp":"2024-05-31T20:13:39.439Z",..."context":"WorkloadManagerMetrics",
      "key":"instance_name","value":"n1-hana-sles15"}
{"level":"debug","timestamp":"2024-05-31T20:13:39.439Z",..."context":"WorkloadManagerMetrics",
      "key":"os","value":"sles-15-SP4"}
...
{"level":"debug","timestamp":"2024-05-31T20:13:39.439Z",..."context":"WorkloadManagerMetrics",
      "metric":"workload.googleapis.com/sap/validation/corosync","value":0}
...

  • Se a instância do agente estiver configurada para enviar registros ao Cloud Logging: é possível visualizar os registros do agente no Cloud Logging.

  • Crie e execute uma avaliação para sua carga de trabalho SAP no Gerenciador de cargas de trabalho. Para mais informações, consulte Crie e execute uma avaliação.

    Para informações sobre as práticas recomendadas compatíveis com o Gerenciador de cargas de trabalho para avaliar cargas de trabalho do SAP em execução no Google Cloud, consulte Práticas recomendadas do Gerenciador de cargas de trabalho para SAP.