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

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 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
    • Monitoramento > Gravador da métrica de monitoramento
    • 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.instances.get
    • compute.nodeGroups.list
    • compute.nodeGroups.get
  • Secrets Manager:
    • secretmanager.versions.access

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

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:

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

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

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

  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 do monitoramento de processos 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,
    "collect_process_metrics": true,
    "process_metrics_frequency": 5,
    "slow_process_metrics_frequency": 30,
    "hana_metrics_config": {
      "hana_db_user": "db_user_name",
      "sid": "DEH",
      "hdbuserstore_key": "user_store_key"
    }
  },
  "cloud_properties": {
    "project_id": "my-project",
    "instance_name": "instance-1",
    "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": 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",
      "sid": "DEH",
      "hana_db_password_secret_name": "db_pwd_secret_name"
    }
  },
  "cloud_properties": {
    "project_id": "my-project",
    "instance_name": "instance-1",
    "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": 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",
      "sid": "DEH",
      "hana_db_password": "TempPa55word"
    }
  },
  "cloud_properties": {
    "project_id": "my-project",
    "instance_name": "instance-1",
    "image": "rhel-8"
  },
  "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 do Compute Engine, em que a coleta de métricas do monitoramento de processos 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,
    "collect_process_metrics": true,
    "process_metrics_frequency": 5,
    "slow_process_metrics_frequency": 30,
    "hana_metrics_config": {
      "hana_db_user": "db_user_name",
      "sid": "DEH",
      "hdbuserstore_key": "user_store_key"
    }
  },
  "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,
    "collect_process_metrics": true,
    "process_metrics_frequency": 5,
    "slow_process_metrics_frequency": 30,
    "hana_metrics_config": {
      "hana_db_user": "db_user_name",
      "sid": "DEH",
      "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,
    "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,
    "collect_process_metrics": true,
    "process_metrics_frequency": 5,
    "slow_process_metrics_frequency": 30,
    "hana_metrics_config": {
      "hana_db_user": "db_user_name",
      "sid": "DEH",
      "hana_db_password": "TempPa55word"
    }
  },
  "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 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 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 de computação. 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_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.
  • hdbuserstore_key, para que você especifique uma chave hdbuserstore.

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.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, hdbuserstore_key ou hana_db_password.

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

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

String

Especifique o SID da instância do SAP HANA. Se você estiver usando uma chave hdbuserstore para autenticação no SAP HANA, consulte a seção hdbuserstore_key.

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

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

    Acessar Monitoring

  2. No painel de navegação do Monitoring, clique em Painéis.

  3. Clique na guia Biblioteca de exemplo.

    Exibição da guia da biblioteca de amostra selecionada.

  4. Para filtrar os painéis personalizados específicos do agente, digite Agent for SAP no campo Filtro.

  5. (Opcional) Para conferir detalhes sobre um painel ou o conteúdo, clique em Visualizar.

  6. Selecione o painel que você quer editar.

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

  1. Abra o Cloud Shell:

    Abrir o Cloud Shell

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

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

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

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

    Acessar Monitoring

  2. No painel de navegação do Monitoring, clique em Painéis.

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