Version 2 : Configurer la collecte de métriques par Monitoring

Ce guide vous explique comment configurer la version 2 de l'agent Google Cloud pour SAP afin de collecter les métriques de surveillance des processus à partir de vos systèmes SAP.

Pour en savoir plus sur cette fonctionnalité, consultez la page Surveiller des processus à 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 de surveillance des processus, vous devez vous assurer que le compte de service utilisé par votre instance de VM 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
    • Monitoring > Rédacteur de statistiques de surveillance
    • 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.

Activer la collecte des métriques de surveillance des processus

Pour activer la collecte des métriques de surveillance des processus à l'aide de l'agent SAP pour Google Cloud, procédez comme suit :

  1. Établissez une connexion SSH avec votre instance de VM hôte.

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

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

  3. Dans la section collection_configuration, procédez comme suit :

    • Pour le paramètre collect_process_metrics, spécifiez la valeur true.
    • Pour activer la collecte des métriques de surveillance des processus associées à vos instances de base de données SAP HANA, vous devez configurer des paramètres supplémentaires dans la section hana_metrics_config. Pour plus d'informations sur ces paramètres, consultez la section 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 de VM Compute Engine

L'exemple suivant est un fichier de configuration terminé de l'agent Google Cloud pour SAP, s'exécutant sur de serveur Bare Metal, où la collecte des métriques de surveillance du processus est activée :

{
  "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",
      "hdbuserstore_key": "user_store_key"
    }
  },
  "cloud_properties": {
    "project_id": "my-project",
    "instance_name": "vm-instance-1",
    "image": "rhel-8"
  },
  "discovery_configuration": {
    "enable_discovery": true
  },
  "hana_monitoring_configuration": {
    "enabled": false
  }
}

Serveur de solution Bare Metal

L'exemple suivant est un fichier de configuration terminé de l'agent Google Cloud pour SAP, s'exécutant sur une instance de VM Compute Engine, où la collecte des métriques de surveillance du processus est activée :

{
  "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",
      "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
  },
  "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 de surveillance des processus.

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 de VM, 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 de VM Compute Engine, spécifiez le nom de cette instance. L'agent détecte automatiquement le nom de l'instance de VM 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. Dans la version 2.5 ou antérieure de l'agent, spécifiez le nom du serveur de solution Bare Metal pour la propriété instance_id.
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 VM, il utilise par défaut la région de l'instance de VM sur laquelle il est installé.
cloud_properties.zone

String

Lorsque l'agent s'exécute sur une instance de VM, il utilise par défaut la zone de l'instance de VM sur laquelle il est installé.
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 VM, il détecte par défaut l'image d'OS de l'instance de VM sur laquelle il est installé.
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 VM, il détecte automatiquement l'ID numérique du 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.
  • hdbuserstore_key, pour lequel vous spécifiez une clé hdbuserstore.
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, hdbuserstore_key ou hana_db_password.
collection_configuration.hana_metrics_config.hdbuserstore_key

String

Pour authentifier l'utilisateur SAP HANA que vous spécifiez pour hana_db_user, spécifiez une clé hdbuserstore que vous avez créée pour cet utilisateur.

Pour utiliser une clé hdbuserstore pour l'authentification, assurez-vous de remplir les conditions suivantes :

  • Les outils SAP hdbsql et hdduserstore 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.
collection_configuration.hana_metrics_config.sid

String

Spécifiez le SID de votre instance SAP HANA.

Afficher les métriques collectées

Pour visualiser les métriques de surveillance des processus collectées par l'agent, vous pouvez utiliser les tableaux de bord personnalisés suivants fournis par Google Cloud :

  • Présentation de l'état de l'agent SAP HANA : ce tableau de bord fournit des graphiques qui indiquent l'état des métriques suivantes : disponibilité SAP HANA, haute disponibilité SAP HANA, réplication haute disponibilité SAP HANA, état du service SAP HANA, état du cluster haute disponibilité et des nœuds, état du cluster haute disponibilité et des ressources pour les instances SAP.

    Le fichier JSON de ce tableau de bord est sap-agent-status-overview.json.

  • Métriques brutes de l'agent SAP HANA : ce tableau de bord fournit des graphiques qui indiquent les valeurs des métriques brutes suivantes : disponibilité SAP HANA, haute disponibilité SAP HANA, réplication haute disponibilité SAP HANA, état du service SAP HANA, état du cluster haute disponibilité et des nœuds, état du cluster haute disponibilité et des ressources pour les instances SAP.

    Le fichier JSON de ce tableau de bord est sap-agent-raw-metrics.json.

Installer des tableaux de bord

Pour installer un tableau de bord personnalisé, procédez comme suit :

Console Google Cloud

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

    Accéder à Monitoring

  2. Dans le panneau de navigation Monitoring, cliquez sur Tableaux de bords.

  3. Cliquez sur l'onglet Exemple de bibliothèque.

    Affichage de l'onglet "Exemple de bibliothèque" sélectionné.

  4. Pour filtrer les tableaux de bord personnalisés spécifiques à l'agent, saisissez Agent for SAP dans le champ Filtre.

  5. (Facultatif) Pour afficher les détails d'un tableau de bord ou pour prévisualiser son contenu, cliquez sur Aperçu.

  6. Sélectionnez le tableau de bord que vous souhaitez installer.

  7. Cliquez sur Importer, puis sur Confirmer.

    Le tableau de bord est ajouté aux tableaux de bord disponibles dans votre projet Google Cloud. Pour afficher votre tableau de bord, suivez les instructions de la section Afficher le tableau de bord installé.

Google Cloud CLI

  1. Ouvrez Cloud Shell.

    Ouvrir Cloud Shell

  2. Dans Cloud Shell, clonez ou téléchargez le dépôt :

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

  3. Dans Cloud Shell, installez le tableau de bord requis à l'aide du fichier JSON correspondant :

    gcloud monitoring dashboards create --config-from-file=CONFIG_FROM_FILE

    Remplacez CONFIG_FROM_FILE par le chemin d'accès au fichier JSON contenant la configuration du tableau de bord. Les fichiers de configuration du tableau de bord peuvent se trouver à l'emplacement monitoring-dashboard-samples/dashboards/google-cloud-agent-for-sap.

    Le tableau de bord est ajouté aux tableaux de bord disponibles dans votre projet Google Cloud. Pour afficher votre tableau de bord, suivez les instructions de la section Afficher le tableau de bord installé.

Afficher les tableaux de bord installés

Pour afficher les tableaux de bord installés, procédez comme suit :

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

    Accéder à Monitoring

  2. Dans le panneau de navigation Monitoring, cliquez sur Tableaux de bords.

  3. Cliquez sur le nom du tableau de bord dans la liste.

Si vous disposez d'un grand nombre de tableaux de bord, vous pouvez appliquer un filtre pour n'afficher que les tableaux de bord personnalisés ou le nom du nouveau tableau de bord. Pour en savoir plus sur le filtrage de cette liste, consultez la section Afficher des tableaux de bord personnalisés.

L'image suivante est un exemple qui montre une partie du tableau de bord personnalisé pour les métriques SAP HANA dans Monitoring.

Capture d'écran montrant le tableau de bord personnalisé pour les métriques SAP HANA dans Monitoring