Configurer la collecte des métriques d'évaluation du gestionnaire de charges de travail

Ce guide vous explique comment configurer l'agent Google Cloud pour SAP afin de collecter les métriques d'évaluation du gestionnaire de charges de travail à partir de vos systèmes SAP.

Pour en savoir plus sur cette fonctionnalité, consultez la page Évaluation du gestionnaire de charges de travail à l'aide de l'agent Google Cloud pour SAP.

Avant de commencer

Définir des rôles IAM

Pour autoriser l'agent Google Cloud pour SAP à collecter les métriques d'évaluation du gestionnaire de charges de travail, vous devez vous assurer que le compte de service utilisé par votre instance Compute Engine ou votre serveur de solution Bare Metal inclut les rôles suivants:

Pour ajouter ces rôles requis à votre compte de service, procédez comme suit :

  1. Dans la console Google Cloud, accédez à la page IAM.

    Accéder à IAM

  2. Sélectionnez votre projet Google Cloud.

  3. Identifiez le compte de service auquel vous souhaitez ajouter un rôle.

    • Si ce compte de service ne figure pas déjà sur la liste des comptes principaux, cela signifie qu'aucun rôle ne lui a encore été attribué. Cliquez sur Ajouter, puis saisissez l'adresse e-mail du compte de service.
    • Si le compte de service figure déjà sur la liste des comptes principaux, il possède des rôles. Cliquez sur le bouton Modifier correspondant au compte de service que vous souhaitez modifier.

  4. Sélectionnez le rôle requis dans la liste des rôles disponibles :

    • Lecteur de Compute
    • Gestionnaire de charges de travail > Rédacteur d'insights Workload Manager
    • Secret Manager > Accesseur de secrets de Secret Manager

  5. Cliquez sur Ajouter ou sur Enregistrer pour appliquer le ou les rôles sélectionnés au compte de service.

Pour un niveau d'accès précis, vous pouvez définir les autorisations IAM suivantes sur votre propre rôle personnalisé:

  • Collecte de métriques :
    • monitoring.timeSeries.create
    • compute.zoneOperations.list
    • compute.disks.list
    • compute.nodeGroups.get
    • workloadmanager.insights.write
  • Secret Manager :
    • secretmanager.versions.access

Pour en savoir plus sur la création d'un rôle personnalisé, consultez la page Créer et gérer les rôles personnalisés.

Vérifier la version de l'agent

Google Cloud vous recommande d'installer la dernière version de l'agent pour SAP afin d'obtenir une évaluation précise de vos charges de travail SAP, car les versions périodiques de l'agent pour SAP peuvent ajouter ou modifier des métriques utilisées pour l'évaluation.

Pour vous assurer que vous disposez de la dernière version de l'agent Google Cloud pour SAP, vous devez régulièrement vérifier si des mises à jour sont disponibles et mettre à jour l'agent.

Installer une mise à jour

Sélectionnez votre système d'exploitation, puis procédez comme suit :

RHEL

  1. Établissez une connexion ssh avec votre instance.
  2. Mettez à jour votre instance d'agent :
    • (Recommandé) Pour effectuer la mise à jour vers la version 3.6 (la plus récente) de l'agent: 
      sudo yum --nogpgcheck update google-cloud-sap-agent
    • Pour effectuer la mise à jour vers une version spécifique de l'agent, procédez comme suit : 
      sudo yum install google-cloud-sap-agent-VERSION_NUMBER.x86_64

      Remplacez VERSION_NUMBER par le numéro de version de l'agent que vous souhaitez installer, par exemple 3.1-606637668. Pour en savoir plus sur les versions d'agent que vous pouvez installer, consultez la section Répertorier toutes les versions disponibles de l'agent.

SLES

  1. Établissez une connexion ssh avec votre instance.
  2. Mettez à jour votre instance d'agent :
    • (Recommandé) Pour effectuer la mise à jour vers la version 3.6 (la plus récente) de l'agent: 
      sudo zypper --no-gpg-checks update google-cloud-sap-agent
    • Pour effectuer la mise à jour vers une version spécifique de l'agent, procédez comme suit : 
      sudo zypper install google-cloud-sap-agent-VERSION_NUMBER.x86_64

      Remplacez VERSION_NUMBER par le numéro de version de l'agent que vous souhaitez installer, par exemple 3.1-606637668. Pour en savoir plus sur les versions d'agent que vous pouvez installer, consultez la section Répertorier toutes les versions disponibles de l'agent.

Activer la collecte des métriques d'évaluation du gestionnaire de charges de travail

À partir de la version 3.2, les nouvelles installations de l'agent Google Cloud pour SAP sont activées par défaut pour collecter les métriques d'évaluation du gestionnaire de charges de travail. Si vous passez à la version 3.2 à partir d'une version précédente, vous pouvez également activer explicitement cette fonctionnalité. Pour cela, procédez comme suit :

  1. Établissez une connexion SSH avec votre instance Compute Engine ou votre serveur de solution Bare Metal.

  2. Pour permettre à l'agent de collecter les métriques d'évaluation du gestionnaire de charges de travail, procédez comme suit: 

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

  3. Pour activer la collecte des métriques "Insights SAP HANA" et "Bonnes pratiques de sécurité SAP HANA", procédez comme suit :

    1. Modifiez le fichier de configuration de l'agent :

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

      Vous pouvez également effectuer cette configuration en exécutant des commandes. Pour en savoir plus, consultez Commandes de configuration pour l'agent Google Cloud pour SAP.

    2. Ajoutez la section workload_validation_db_metrics_config après collect_workload_validation_metrics, puis spécifiez les paramètres suivants :

      • hana_db_user : spécifiez le compte utilisateur de base de données SAP HANA utilisé pour interroger l'instance SAP HANA.
      • hostname : spécifiez l'identifiant de la machine locale ou distante qui héberge votre instance SAP HANA.
      • port : spécifiez le port sur lequel l'instance SAP HANA accepte les requêtes.
      • sid : spécifiez le SID de votre instance SAP HANA.

      • hana_db_password_secret_name : spécifiez le nom du secret Secret Manager qui stocke le mot de passe du compte utilisateur.

        À la place du secret, vous pouvez utiliser le paramètre de configuration hdbuserstore_key.

      • hdbuserstore_key : spécifiez la clé hdbuserstore qui authentifie l'utilisateur que vous avez spécifié pour hana_db_user.

        Si vous spécifiez hdbuserstore_key, vous ne devez pas spécifier les paramètres hostname et port.

      Pour plus d'informations sur ces paramètres, consultez Paramètres de configuration.

  4. Si vous le souhaitez, dans la section cloud_properties, vous pouvez mettre à jour les valeurs de paramètres définies automatiquement. Pour ce faire, ajoutez la section cloud_properties à votre fichier de configuration, puis spécifiez les paramètres requis et leurs valeurs.

  5. Enregistrez le fichier de configuration.

  6. Redémarrez l'agent pour que les nouveaux paramètres prennent effet :

    sudo systemctl restart google-cloud-sap-agent

Exemples de fichiers de configuration

Instance Compute Engine

Les exemples suivants sont des fichiers de configuration terminés de l'agent Google Cloud pour SAP s'exécutant sur unede serveur Bare Metal, où la collecte des métriques d'évaluation du gestionnaire de charges de travail est activée.

Pour l'authentification SAP HANA, l'agent utilise l'ordre de préférence suivant: si spécifié, le paramètre de configuration hdbuserstore_key est préféré au paramètre hana_db_password, qui est préféré au paramètre hana_db_password_secret_name. Nous vous recommandons de ne définir qu'une seule option d'authentification dans votre fichier de configuration.

  • L'exemple suivant utilise une clé de magasin d'utilisateurs sécurisé (hdbuserstore) pour l'authentification 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
  }
}
  • L'exemple suivant utilise un nom d'utilisateur et un secret Secret Manager pour l'authentification 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
  }
}
  • L'exemple suivant utilise un nom d'utilisateur et un mot de passe pour l'authentification SAP HANA. Nous vous recommandons d'utiliser plutôt un secret Secret Manager ou une clé de magasin d'utilisateurs sécurisé (hdbuserstore) pour l'authentification 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
  }
}

Serveur de solution Bare Metal

Les exemples suivants sont des fichiers de configuration terminés de l'agent Google Cloud pour SAP s'exécutant sur uneinstance Compute Engine, où la collecte des métriques d'évaluation du gestionnaire de charges de travail est activée.

Pour l'authentification SAP HANA, l'agent utilise l'ordre de préférence suivant: si spécifié, le paramètre de configuration hdbuserstore_key est préféré au paramètre hana_db_password, qui est préféré au paramètre hana_db_password_secret_name. Nous vous recommandons de ne définir qu'une seule option d'authentification dans votre fichier de configuration.

  • L'exemple suivant utilise une clé de magasin d'utilisateurs sécurisé (hdbuserstore) pour l'authentification 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
  }
}
  • L'exemple suivant utilise un nom d'utilisateur et un secret Secret Manager pour l'authentification 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
  }
}
  • L'exemple suivant utilise un nom d'utilisateur et un mot de passe pour l'authentification SAP HANA. Nous vous recommandons d'utiliser plutôt un secret Secret Manager ou une clé de magasin d'utilisateurs sécurisé (hdbuserstore) pour l'authentification 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
  }
}

Paramètres de configuration

Le tableau suivant explique les paramètres de configuration de l'agent Google Cloud pour SAP qui sont spécifiques à la collecte des métriques d'évaluation du gestionnaire de charges de travail.

Paramètres
provide_sap_host_agent_metrics

Boolean

Pour activer la collecte des métriques requises par l'agent hôte SAP, spécifiez true. La valeur par défaut est true.
Ne définissez pas provide_sap_host_agent_metrics sur false, sauf si vous êtes dirigé par le service client Cloud Customer Care ou l'assistance SAP.

bare_metal

Boolean

Lorsque l'agent est installé sur un serveur de solution Bare Metal, spécifiez true. La valeur par défaut est false.
log_level

String

Pour définir le niveau de journalisation de l'agent, définissez la valeur requise. Les niveaux de journalisation disponibles sont les suivants :

  • DEBUG
  • INFO
  • WARNING
  • ERROR

La valeur par défaut est INFO. Ne modifiez pas le niveau de journalisation, sauf si vous êtes dirigé par le service client Cloud Customer Care.
log_to_cloud

Boolean

Pour rediriger les journaux de l'agent vers Cloud Logging, spécifiez true. La valeur par défaut est true.
cloud_properties.project_id

String

Si votre système SAP s'exécute sur un serveur de solution Bare Metal, spécifiez l'ID du projet Google Cloud que vous utilisez avec la solution Bare Metal.

Lorsque l'agent s'exécute sur une instance Compute Engine, il détecte automatiquement l'ID du projet par défaut.
cloud_properties.instance_name

String

Si votre système SAP s'exécute sur une instance Compute Engine, spécifiez le nom de cette instance. L'agent détecte automatiquement le nom de l'instance Compute lors de l'installation.

Si votre système SAP s'exécute sur un serveur de solution Bare Metal, spécifiez le nom de ce serveur.
cloud_properties.region

String

Si votre système SAP s'exécute sur un serveur de solution Bare Metal, spécifiez la région du serveur de solution Bare Metal.

Lorsque l'agent s'exécute sur une instance de calcul, il utilise par défaut la région dans laquelle l'instance de calcul est déployée.
cloud_properties.zone

String

Lorsque l'agent s'exécute sur une instance de calcul, il utilise par défaut la zone où l'instance de calcul est déployée.
cloud_properties.image

String

Indiquez le nom d'image de l'OS de l'instance.

Lorsque l'agent s'exécute sur une instance de calcul, il détecte automatiquement l'image d'OS utilisée par l'instance de calcul par défaut.
cloud_properties.numeric_project_id

String

Spécifiez l'ID numérique du projet Google Cloud dans lequel le système SAP est exécuté.

Lorsque l'agent s'exécute sur une instance de calcul, il détecte automatiquement le numéro de projet par défaut.
discovery_configuration.enable_workload_discovery

Boolean

Pour permettre à l'agent de collecter les noms et les versions des produits SAP exécutés sur l'hôte, spécifiez true. La valeur par défaut est true.

Pour plus d'informations, consultez le codebase de l'agent dans le dépôt GitHub google-cloud-sap-agent sous GoogleCloudPlatform/sapagent.

discovery_configuration.enable_discovery

Boolean

Pour envoyer à Cloud Logging les informations collectées par l'agent sur les produits SAP exécutés sur l'hôte, spécifiez true. La valeur par défaut est true.

Si vous spécifiez la valeur false, l'agent stocke les informations collectées sur l'hôte et ne les envoie pas à Cloud Logging.

collection_configuration.collect_workload_validation_metrics

Boolean

Pour activer la collecte des métriques d'évaluation du gestionnaire de charges de travail, spécifiez true. À partir de la version 3.2, la valeur par défaut est true.
Ce paramètre ne s'applique qu'à Linux.
collection_configuration.workload_validation_metrics_frequency

Int

Fréquence de collecte des métriques d'évaluation du gestionnaire de charges de travail, en secondes. La valeur par défaut est de 300 secondes.

Si vous devez modifier la fréquence de collecte des métriques du gestionnaire de charges de travail, ajoutez le paramètre workload_validation_metrics_frequency sous la section collection_configuration et indiquez la valeur requise.
collection_configuration.workload_validation_collection_definition.fetch_latest_config

Boolean

Facultatif. La valeur par défaut est true, ce qui permet à l'agent de collecter le dernier ensemble de métriques d'évaluation du gestionnaire de charges de travail sans que vous ayez à mettre à jour l'agent. Si vous souhaitez désactiver ce comportement, spécifiez ce paramètre dans le fichier de configuration et définissez sa valeur sur false.
collection_configuration.workload_validation_db_metrics_config.hana_db_user

String

Spécifiez le compte utilisateur utilisé pour interroger l'instance SAP HANA. Le compte utilisateur doit disposer de l'autorisation de lecture sur la base de données SAP HANA.
collection_configuration.workload_validation_db_metrics_config.hana_db_password

String

Spécifiez le mot de passe du compte utilisateur utilisé pour interroger l'instance SAP HANA.

Pour l'authentification SAP HANA, l'agent utilise l'ordre de préférence suivant: si spécifié, le paramètre de configuration hdbuserstore_key est préféré au paramètre hana_db_password, qui est préféré au paramètre hana_db_password_secret_name. Nous vous recommandons de ne définir qu'une seule option d'authentification dans votre fichier de configuration.

collection_configuration.workload_validation_db_metrics_config.hana_db_password_secret_name

String

Spécifiez le nom du secret dans Secret Manager qui stocke le mot de passe du compte utilisateur.

Vous pouvez également spécifier le paramètre de configuration hdbuserstore_key pour authentifier l'utilisateur SAP HANA spécifié.

Pour l'authentification SAP HANA, l'agent utilise l'ordre de préférence suivant: si spécifié, le paramètre de configuration hdbuserstore_key est préféré au paramètre hana_db_password, qui est préféré au paramètre hana_db_password_secret_name. Nous vous recommandons de ne définir qu'une seule option d'authentification dans votre fichier de configuration.

collection_configuration.workload_validation_db_metrics_config.hdbuserstore_key

String

Pour vous connecter de manière sécurisée à un système SAP HANA, spécifiez une clé de magasin d'utilisateurs sécurisé (hdbuserstore) que vous avez créée pour ce système.

Pour utiliser une clé hdbuserstore pour l'authentification, vérifiez les points suivants :

  • Les outils SAP hdbsql et hdbuserstore sont installés sur l'instance de calcul qui héberge l'agent.
  • La clé hdbuserstore correspond à une instance SAP HANA spécifique. Vous ne pouvez pas utiliser de clés contenant les noms d'hôte de plusieurs instances SAP HANA.
  • L'utilisateur SIDadm peut interroger la base de données SAP HANA à l'aide de cette clé. Ici, SID fait référence à la valeur que vous avez spécifiée pour le paramètre sid. Vous pouvez le vérifier en exécutant la commande suivante en tant qu'utilisateur SIDadm: 
    hdbsql -U HDB_USERSTORE_KEY "SELECT * FROM DUMMY"

Ce paramètre de configuration est compatible avec la version 3.3 de l'agent.

Si vous spécifiez hdbuserstore_key, vous pouvez ignorer les paramètres hostname et port.

Pour l'authentification SAP HANA, l'agent utilise l'ordre de préférence suivant: si spécifié, le paramètre de configuration hdbuserstore_key est préféré au paramètre hana_db_password, qui est préféré au paramètre hana_db_password_secret_name. Nous vous recommandons de ne définir qu'une seule option d'authentification dans votre fichier de configuration.

collection_configuration.workload_validation_db_metrics_config.sid

String

Spécifiez le SID de votre instance SAP HANA.
collection_configuration.workload_validation_db_metrics_config.hostname

String

Spécifiez l'identifiant de la machine locale ou distante qui héberge votre instance SAP HANA. Les valeurs acceptées sont les suivantes :

  • Si l'hôte est un ordinateur local, spécifiez la chaîne localhost ou l'adresse IP de rebouclage de l'hôte local, comme 127.0.0.1.
  • Si l'hôte est une machine distante, spécifiez son adresse IP interne ou externe.
collection_configuration.workload_validation_db_metrics_config.port

String

Spécifiez le port sur lequel l'instance SAP HANA accepte les requêtes. Pour la première ou la seule instance de base de données locataire, le port est 3NN15, où NN correspond au numéro de l'instance SAP HANA.
collection_configuration.workload_validation_db_metrics_frequency

Int

Fréquence de collecte des métriques de base de données SAP HANA, en secondes, pour l'évaluation du gestionnaire de charges de travail. La valeur par défaut est de 3600 secondes.

Bien que vous puissiez mettre à jour la fréquence de collecte des métriques de base de données SAP HANA, nous vous recommandons d'utiliser la valeur par défaut. Si vous devez modifier la valeur par défaut, ajoutez le paramètre workload_validation_db_metrics_frequency sous la section collection_configuration et indiquez la valeur requise. Assurez-vous de ne pas définir de fréquence de collecte supérieure à 3600 secondes.

Afficher les métriques collectées

Pour afficher les métriques d'évaluation du gestionnaire de charges de travail que l'agent collecte, procédez comme suit:

  • Consultez le fichier journal de l'agent:

    1. Définissez le niveau de journalisation de l'agent sur DEBUG:

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

    2. Une fois l'agent redémarré pour appliquer le nouveau niveau de journalisation, consultez le fichier journal de l'agent:

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

    3. Dans le fichier journal, recherchez les entrées contenant les éléments suivants:

      workload.googleapis.com/sap/validation/

      Voici un exemple qui montre les métriques d'évaluation du gestionnaire de charges de travail dans le fichier journal de l'agent:

      {"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}
...

  • Si votre instance d'agent est configurée pour envoyer des journaux à Cloud Logging, vous pouvez afficher les journaux de l'agent dans Cloud Logging.

  • Créez et exécutez une évaluation de votre charge de travail SAP dans le gestionnaire de charges de travail. Pour en savoir plus, consultez la section Créer et exécuter une évaluation.

    Pour en savoir plus sur les bonnes pratiques compatibles avec Workload Manager pour évaluer les charges de travail SAP exécutées sur Google Cloud, consultez la page Bonnes pratiques pour le gestionnaire de charges de travail SAP.