Installer et configurer l'agent Google Cloud pour SAP sur une instance Compute Engine

L'agent Google Cloud pour SAP est requis pour la compatibilité SAP des systèmes SAP exécutés sur Google Cloud, y compris SAP NetWeaver, SAP HANA, SAP ASE, SAP MaxDB, etc.

Lorsque vous installez l'agent Google Cloud pour SAP sur une instance Compute Engine, pour les métriques de l'agent hôte SAP, l'agent combine les données de surveillance de Cloud Monitoring et des API Compute Engine, puis transmet ces données à l'agent hôte SAP.

Si vous utilisez les images "pour SAP" suivantes des OS RHEL ou SLES, fournies par Google Cloud, l'agent Google Cloud pour SAP sera empaqueté avec les images d'OS :

  • RHEL : toutes les images "for SAP"
  • SLES : SLES 15 SP4 pour SAP et versions ultérieures

Pour plus d'informations sur les systèmes d'exploitation compatibles avec l'agent Google Cloud pour SAP, consultez la page Systèmes d'exploitation compatibles.

Pour installer et configurer la version 2 de l'agent Google Cloud pour SAP sur un serveur de solution Bare Metal, consultez la section Installer l'agent Google Cloud pour SAP sur un serveur de solution Bare Metal.

Présentation de l'installation

Sous Linux, vous installez l'agent Google Cloud pour SAP à l'aide des commandes standards de gestion des packages du système d'exploitation : la commande yum sur RHEL et la commande zypper sur SLES. La commande de gestion des packages effectue les tâches suivantes :

  • Elle télécharge l'agent Google Cloud pour SAP.
  • Elle crée l'agent en tant que service systemd Linux nommé google-cloud-sap-agent.
  • Elle active et démarre le service google-cloud-sap-agent.

Sous Windows, vous installez l'agent Google Cloud pour SAP à l'aide de la commande de gestion des packages GooGet googet. La commande de gestion des packages effectue les tâches suivantes :

  • Elle télécharge l'agent Google Cloud pour SAP.
  • Elle crée un service Windows nommé google-cloud-sap-agent et une tâche planifiée qui s'exécute toutes les minutes pour vérifier si le service est toujours en cours d'exécution et, si nécessaire, le redémarrer.

Prérequis pour l'agent

Avant d'installer l'agent Google Cloud pour SAP, vous devez vous assurer que les conditions préalables suivantes sont remplies.

Définir les rôles IAM requis

Au minimum, le compte de service utilisé par l'agent Google Cloud pour SAP doit inclure les rôles Lecteur Compute (roles/compute.viewer), Lecteur Monitoring (roles/monitoring.viewer) et Rédacteur d'insights Workload Manager (roles/workloadmanager.insightWriter).

Pour ajouter un rôle 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 :

    • Compute Engine > Lecteur Compute
    • Monitoring > Lecteur Monitoring
    • Gestionnaire de charges de travail > Rédacteur d'insights Workload Manager
  5. Cliquez sur Ajouter ou sur Enregistrer pour appliquer le ou les rôles sélectionnés au compte de service.

Activer l'accès aux API Google Cloud

Compute Engine recommande de configurer vos instances de calcul de façon à accorder un niveau d'accès complet à toutes les APIs Cloud et à n'utiliser que les autorisations IAM du compte de service de l'instance pour contrôler les accès aux ressources Google Cloud. Pour en savoir plus, consultez la page Créer une VM qui utilise un compte de service géré par l'utilisateur.

Si vous limitez l'accès aux APIs Cloud, l'agent Google Cloud pour SAP nécessite au minimum les niveaux d'accès suivants aux API Cloud sur l'instance Compute Engine hôte:

  • Cloud Platform : activé
  • Compute Engine : lecture seule
  • API Stackdriver Monitoring : lecture seule

Si vous exécutez des applications SAP sur une instance de calcul qui ne possède pas d'adresse IP externe, vous devez activer l'accès privé à Google sur le sous-réseau de l'instance de calcul afin que l'agent Google Cloud pour SAP puisse accéder aux API et services Google. Pour activer l'accès privé à Google sur un sous-réseau, consultez la page Configurer l'accès privé à Google.

Installer l'agent

Nous vous recommandons d'installer la dernière version de l'agent Google Cloud pour SAP, car elle prend en charge un plus grand nombre de fonctionnalités. Pour obtenir des instructions, consultez la section Installer et configurer l'agent Google Cloud pour SAP sur une instance Compute Engine.

Pour installer la version 2 de l'agent Google Cloud pour SAP, contactez l'assistance Cloud Customer Care.

Après avoir installé l'agent Google Cloud pour SAP et l'agent hôte SAP, vérifiez l'installation de l'agent Google Cloud pour SAP, comme décrit dans la section Vérifier l'installation de l'agent.

Vérifier l'installation de l'agent

Pour vérifier que l'agent est en cours d'exécution, sélectionnez votre système d'exploitation, puis procédez comme suit :

Linux

  1. Établissez une connexion SSH avec votre instance Compute Engine.

  2. Exécutez la commande suivante :

    systemctl status google-cloud-sap-agent

    Si l'agent fonctionne correctement, la sortie contient active (running). Exemple :

    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. Utilisez RDP pour vous connecter à l'instance Compute Engine.

  2. En tant qu'administrateur, exécutez la commande suivante à partir de PowerShell :

    $(Get-Service -Name 'google-cloud-sap-agent' -ErrorAction Ignore).Status
    Si l'agent est en cours d'exécution, l'état indique Running.

Si l'agent n'est pas en cours d'exécution, redémarrez-le.

Vérifier que l'agent hôte SAP reçoit les métriques

Pour vérifier que les métriques d'infrastructure sont collectées par l'agent Google Cloud pour SAP et envoyées correctement à l'agent hôte SAP, procédez comme suit :

  1. Dans votre système SAP, saisissez la transaction ST06.
  2. Dans le volet de synthèse, vérifiez la disponibilité et le contenu des champs suivants pour vous assurer de la configuration de façon correcte et complète de l'infrastructure de surveillance SAP et Google :

    • Fournisseur cloud : Google Cloud Platform
    • Accès à la surveillance améliorée : TRUE
    • Détails de la surveillance améliorée : ACTIVE

Configurer l'agent Google Cloud pour SAP sous Linux

Après avoir installé l'agent Google Cloud pour SAP, vous pouvez éventuellement activer d'autres fonctionnalités de l'agent en effectuant les configurations suivantes. Par défaut, seule la collecte des métriques de l'agent hôte SAP est activée.

Fichier de configuration par défaut

L'extrait suivant est un exemple de configuration par défaut de la version 2 de l'agent Google Cloud pour 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
  }
}

Paramètres de configuration

Le tableau suivant explique les paramètres de configuration de la version 2 de l'agent Google Cloud pour SAP.

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.

sap_system_discovery

Boolean

Pour activer la détection du système SAP, 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.

collection_configuration.collect_process_metrics

Boolean

Pour activer la collecte des métriques de surveillance des processus, spécifiez true. La valeur par défaut est false.
Ce paramètre ne s'applique qu'à Linux.

Si vous activez la collecte des métriques de processus pour SAP HANA, vous devez configurer des paramètres supplémentaires répertoriés sous hana_metrics_config.

collection_configuration.process_metrics_frequency

Int

À partir de la version 2.6, ce paramètre détermine la fréquence de collecte des métriques de surveillance des processus qui évoluent rapidement, en secondes. Les métriques de surveillance des processus qui évoluent rapidement sont: sap/hana/availability, sap/hana/ha/availability et sap/nw/availability.

La valeur par défaut pour ce paramètre est 5 secondes. Nous vous recommandons d'utiliser cette valeur par défaut.

Toutes les autres métriques de surveillance du processus (à évolution lente) sont collectées à une fréquence par défaut de 30 secondes. Pour modifier la fréquence de collecte des métriques de surveillance des processus qui évoluent lentement, utilisez le paramètre slow_process_metrics_frequency.

collection_configuration.slow_process_metrics_frequency

Int

Spécifiez la fréquence de collecte des métriques de surveillance du processus à l'évolution lente en secondes.

La valeur par défaut de ce paramètre est 30 secondes.

collection_configuration.process_metrics_to_skip

Array

Spécifiez les métriques de surveillance de processus que vous ne souhaitez pas que l'agent collecte. Ce paramètre accepte les noms de métriques de surveillance des processus séparés par une virgule. Par exemple : "process_metrics_to_skip": ["/sap/nw/abap/sessions", "/sap/nw/abap/rfc"].

collection_configuration.hana_metrics_config.hana_db_user

String

Spécifiez le compte utilisateur de base de données utilisé par l'agent pour interroger SAP HANA. La valeur par défaut est SYSTEM.

collection_configuration.hana_metrics_config.hana_db_password

String

Spécifiez le mot de passe en texte brut du compte utilisateur de base de données utilisé par l'agent pour interroger SAP HANA.

Au lieu de spécifier un mot de passe en texte brut, nous vous recommandons d'utiliser l'une des options suivantes :

  • hana_db_password_secret_name, pour lequel vous spécifiez un secret stocké dans Secret Manager.
collection_configuration.hana_metrics_config.hana_db_password_secret_name

String

Pour fournir le mot de passe du compte utilisateur de base de données utilisé par l'agent pour interroger SAP HANA de manière sécurisée, spécifiez le nom du secret contenant les identifiants de sécurité du compte utilisateur de base de données.

L'agent ne collecte les métriques liées à SAP HANA que lorsque vous spécifiez hana_db_password_secret_name ou hana_db_password.

collection_configuration.hana_metrics_config.sid

String

Spécifiez le SID de votre instance SAP HANA.

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

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.

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.

hana_monitoring_configuration.enabled

Boolean

Facultatif. Pour autoriser l'agent Google Cloud pour SAP à collecter les métriques de surveillance SAP HANA, spécifiez true. La valeur par défaut est false.

Les paramètres enfants suivants ne s'appliquent que lorsque vous spécifiez hana_monitoring_configuration.enabled: true.
hana_monitoring_configuration.sample_interval_sec

Int

Facultatif. Spécifiez l'intervalle d'échantillonnage, en secondes, qui détermine la fréquence à laquelle l'agent Google Cloud pour SAP interroge vos instances SAP HANA pour collecter les métriques de surveillance SAP HANA. La valeur par défaut est de 300 secondes.

Pour chaque requête définie dans le fichier de configuration de l'agent Google Cloud pour SAP, vous pouvez remplacer l'intervalle d'échantillonnage global en spécifiant l'intervalle requis sur le paramètre sample_interval_sec. Les intervalles d'échantillonnage doivent être d'au moins 5 secondes.

hana_monitoring_configuration.query_timeout_sec

Int

Facultatif. Indiquez le délai avant expiration de chaque requête adressée aux instances SAP HANA. La valeur par défaut est de 300 secondes.

hana_monitoring_configuration.execution_threads

Int

Facultatif. Spécifiez le nombre de threads utilisés pour envoyer des requêtes aux instances SAP HANA. Chaque requête s'exécute sur son propre thread. La valeur par défaut est 10.

hana_monitoring_configuration.hana_instances.name

String

Spécifiez l'identifiant de nom de votre instance SAP HANA.

hana_monitoring_configuration.hana_instances.sid

String

Spécifiez le SID de votre instance SAP HANA. Cette chaîne est ajoutée en tant que libellé à toutes les métriques résultant de l'interrogation de vos instances SAP HANA.

hana_monitoring_configuration.hana_instances.host

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

hana_monitoring_configuration.hana_instances.user

String

Spécifiez le compte utilisateur utilisé pour interroger l'instance SAP HANA.

Assurez-vous que cet utilisateur dispose du droit de lire les vues de surveillance de votre base de données SAP HANA. Si ce privilège n'est pas accordé, les métriques de surveillance SAP HANA associées aux vues de surveillance ne contiennent aucune donnée.

hana_monitoring_configuration.hana_instances.password

String

Facultatif. Spécifiez le mot de passe, en texte brut, qui authentifie le compte utilisateur pour interroger l'instance SAP HANA.

Pour l'authentification, vous devez spécifier l'un des éléments suivants :

  • Le mot de passe en texte brut du paramètre password.
  • (Recommandé) Si vous utilisez Secret Manager pour stocker le mot de passe en tant que secret, vous devez spécifier le nom de secret correspondant au paramètre secret_name.
hana_monitoring_configuration.hana_instances.secret_name

String

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

hana_monitoring_configuration.hana_instances.enable_ssl

Boolean

Facultatif. Indique si SSL est activé ou non dans votre instance SAP HANA. La valeur par défaut est false.

hana_monitoring_configuration.hana_instances.host_name_in_certificate

String

Si vous spécifiez enable_ssl: true pour une instance SAP HANA, vous devez spécifier le nom d'hôte défini dans le certificat SSL.

hana_monitoring_configuration.hana_instances.tls_root_ca_file

String

Si vous spécifiez enable_ssl: true pour une instance SAP HANA, vous devez spécifier le chemin d'accès à votre certificat de sécurité.

hana_monitoring_configuration.queries.enabled

Boolean

Facultatif. Pour activer une requête SQL pour toutes vos instances SAP HANA, spécifiez la valeur true du paramètre enabled pour cette requête SQL.

hana_monitoring_configuration.queries.name

String

Si vous avez défini des requêtes personnalisées dans votre fichier de configuration, vous devez spécifier un nom unique pour chacune d'entre elles.

Le nom de la requête doit être unique, car il permet de créer l'URL par défaut de la métrique dans Monitoring.

hana_monitoring_configuration.queries.sql

String

Spécifiez l'instruction SQL que l'agent émet à vos instances SAP HANA.

L'instruction SQL doit être conforme à la syntaxe SQL définie par SAP dans la documentation SAP HANA SQL and System Views Reference.
hana_monitoring_configuration.queries.sample_interval_sec

Int

Facultatif. Spécifiez l'intervalle d'échantillonnage pour la requête SQL. Cette opération remplace l'intervalle d'échantillonnage global. Sa valeur doit être d'au moins 5 secondes.

hana_monitoring_configuration.queries.columns.name

String

Spécifiez un nom qui identifie de manière unique chaque colonne.

Le nom de colonne doit être unique, car il permet de créer l'URL par défaut de la métrique dans Monitoring.

hana_monitoring_configuration.queries.columns.metric_type

String

Pour le traitement par Monitoring, spécifiez l'un des types de métriques suivants : METRIC_LABEL, METRIC_GAUGE ou METRIC_CUMULATIVE.

Les métriques de type METRIC_LABEL sont ajoutées en tant que libellés à toutes les métriques METRIC_GAUGE et METRIC_CUMULATIVE envoyées à Monitoring.

hana_monitoring_configuration.queries.columns.value_type

String

Pour la gestion par Monitoring, spécifiez un type de données compatible avec le type de métrique.

Les types de données acceptés sont les suivants : VALUE_BOOL, VALUE_INT64, VALUE_STRING ou VALUE_DOUBLE. Pour en savoir plus, consultez la page Combinaison acceptée.

hana_monitoring_configuration.queries.columns.name_override

String

Facultatif. Pour le traitement par Monitoring, spécifiez le chemin d'accès que vous souhaitez afficher dans l'URL de la métrique au lieu des noms de requête et de colonne. Exemple :

  • URL par défaut de la métrique : workload.googleapis.com/sap/hanamonitoring/QUERY_NAME/COLUMN_NAME
  • URL de métrique utilisant un chemin personnalisé : workload.googleapis.com/sap/hanamonitoring/CUSTOM_PATH

Dépannage

Pour en savoir plus sur le diagnostic et la résolution des problèmes que vous pourriez rencontrer lors de l'installation et de la configuration de l'agent Google Cloud pour SAP, consultez le guide de dépannage de l'agent Google Cloud pour SAP.

Obtenir de l'aide

Si vous avez besoin d'aide pour résoudre des problèmes liés à l'agent Google Cloud pour SAP, collectez toutes les informations de diagnostic disponibles et contactez Cloud Customer Care. Pour savoir comment contacter le service client, consultez la page Obtenir de l'aide pour SAP sur Google Cloud.