Ce guide vous explique comment configurer l'agent Google Cloud pour SAP afin de collecter les métriques de surveillance SAP HANA de vos systèmes SAP HANA.
Pour en savoir plus sur cette fonctionnalité, consultez la page Surveiller SAP HANA à l'aide de l'agent Google Cloud pour SAP.
Avant de commencer
- Vérifier l'installation de l'agent Google Cloud pour SAP Pour obtenir des instructions, consultez le guide d'installation pour votre scénario.
- Si vous avez installé l'agent sur un serveur de solution Bare Metal, assurez-vous de remplir les conditions préalables requises et de configurer un compte de service. Pour obtenir des instructions, consultez la page Configurer l'agent Google Cloud pour SAP sous Linux.
Définir des rôles IAM
Pour autoriser l'agent Google Cloud pour SAP à collecter les métriques de surveillance SAP HANA, 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 :
- Lecteur Compute (
roles/compute.viewer) - Rédacteur de métriques Monitoring (
roles/monitoring.metricWriter) - Accesseur de secrets Secret Manager (
roles/secretmanager.secretAccessor), si vous utilisez Secret Manager pour stocker le mot de passe de la base de données SAP HANA.
Pour ajouter ces rôles requis à votre compte de service, procédez comme suit :
Dans la console Google Cloud, accédez à la page IAM.
Sélectionnez votre projet Google Cloud.
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.
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
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 SAP HANA
Pour activer la collecte des métriques de surveillance SAP HANA à l'aide de l'agent Google Cloud pour SAP, procédez comme suit :
Établissez une connexion SSH avec votre instance de VM Compute Engine ou votre serveur de solution Bare Metal.
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.
Dans la section
hana_monitoring_configuration, procédez comme suit :- Pour le paramètre
enabled, définissez la valeurtrue. - Dans la section
hana_instances, spécifiez les instances SAP HANA que l'agent doit surveiller. - Vous pouvez également définir des requêtes personnalisées. Pour en savoir plus sur la définition de requêtes personnalisées et pour consulter des exemples, consultez la section Définir des requêtes personnalisées.
Vous pouvez également désactiver les requêtes intégrées ou par défaut. Pour obtenir des instructions, consultez la section Désactiver une requête SQL.
Pour plus d'informations sur les paramètres de configuration, consultez Paramètres de configuration.
- Pour le paramètre
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 sectioncloud_propertiesà votre fichier de configuration, puis spécifiez les paramètres requis et leurs valeurs.Enregistrez le fichier de configuration.
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 unune instance de VM Compute Engine, où la collecte des métriques de surveillance SAP HANA est activée. Notez que la requête personnalisée incluse dans cet exemple, nomméecustom_query, suit les consignes sur la définition de requêtes personnalisées spécifiées à la section Définir des requêtes personnalisées.
{
"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": false
},
"cloud_properties": {
"project_id": "my-project",
"instance_name": "vm-instance-1",
"image": "rhel-8"
},
"discovery_configuration": {
"enable_discovery": true
},
"hana_monitoring_configuration": {
"enabled": true,
"sample_interval_sec": 60,
"query_timeout_sec": 30,
"execution_threads": 20,
"hana_instances": [
{
"name": "local",
"sid": "DEH",
"host": "localhost",
"port": "30015",
"user": "system",
"secret_name": "password-secret-name",
"hdbuserstore_key": "user_store_key"
},
{
"name": "remote",
"sid": "DEH",
"host": "10.123.0.12",
"port": "30015",
"user": "system",
"secret_name": "password-secret-name",
"hdbuserstore_key": "user_store_key"
}
],
"queries": [
{
"name": "custom_query",
"enabled": true,
"sql": "SELECT * FROM MyTable;",
"columns": [
{
"name": "string",
"metric_type": "METRIC_LABEL",
"value_type": "VALUE_STRING"
},
{
"name": "bool",
"metric_type": "METRIC_GAUGE",
"value_type": "VALUE_BOOL"
},
{
"name": "int",
"metric_type": "METRIC_GAUGE",
"value_type": "VALUE_INT64"
},
{
"name": "double",
"metric_type": "METRIC_GAUGE",
"value_type": "VALUE_DOUBLE"
}
]
},
{
"name": "default_host_queries",
"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 unserveur de solution Bare Metal, où la collecte des métriques de surveillance SAP HANA est activée. Notez que la requête personnalisée incluse dans cet exemple, nomméecustom_query, suit les consignes sur la définition de requêtes personnalisées spécifiées à la section Définir des requêtes personnalisées.
{
"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": false
},
"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": true,
"sample_interval_sec": 60,
"query_timeout_sec": 30,
"execution_threads": 20,
"hana_instances": [
{
"name": "local",
"sid": "DEH",
"host": "localhost",
"port": "30015",
"user": "system",
"secret_name": "password-secret-name",
"hdbuserstore_key": "user_store_key"
},
{
"name": "remote",
"sid": "DEH",
"host": "10.123.0.12",
"port": "30015",
"user": "system",
"secret_name": "password-secret-name",
"hdbuserstore_key": "user_store_key"
}
],
"queries": [
{
"name": "custom_query",
"enabled": true,
"sql": "SELECT * FROM MyTable;",
"columns": [
{
"name": "string",
"metric_type": "METRIC_LABEL",
"value_type": "VALUE_STRING"
},
{
"name": "bool",
"metric_type": "METRIC_GAUGE",
"value_type": "VALUE_BOOL"
},
{
"name": "int",
"metric_type": "METRIC_GAUGE",
"value_type": "VALUE_INT64"
},
{
"name": "double",
"metric_type": "METRIC_GAUGE",
"value_type": "VALUE_DOUBLE"
}
]
},
{
"name": "default_host_queries",
"enabled": false
}
]
}
}
Définir une requête SQL personnalisée
L'agent Google Cloud pour SAP collecte les métriques de surveillance SAP HANA en exécutant des requêtes SQL sur vos instances SAP HANA. Outre ces requêtes par défaut, vous pouvez définir et exécuter des requêtes SQL personnalisées en procédant comme suit :
Établissez une connexion SSH avec votre instance de VM Compute Engine ou votre serveur de solution Bare Metal.
Modifiez le fichier de configuration de l'agent :
/etc/google-cloud-sap-agent/configuration.json
Dans la section
hana_monitoring_configuration.queries, définissez votre requête personnalisée.Pour en savoir plus sur la définition de requêtes personnalisées et pour consulter des exemples, consultez la section Définir des requêtes personnalisées.
Pour activer une requête personnalisée, définissez son paramètre
enabledsurtrue.Enregistrez le fichier de configuration.
Redémarrez l'agent pour que les nouveaux paramètres prennent effet :
sudo systemctl restart google-cloud-sap-agent
Désactiver une requête SQL
Si vous ne souhaitez exécuter aucune des requêtes SQL intégrées fournies par l'agent Google Cloud pour SAP ou des requêtes personnalisées que vous définissez, vous pouvez désactiver la requête SQL en procédant comme suit :
Établissez une connexion SSH avec votre instance de VM Compute Engine ou votre serveur de solution Bare Metal.
Modifiez le fichier de configuration de l'agent :
/etc/google-cloud-sap-agent/configuration.json
Pour désactiver une requête intégrée ou par défaut, incluez les éléments suivants dans la section
hana_monitoring_configuration.queries:{ "name": "default_QUERY_NAME", "enabled": false }Remplacez
QUERY_NAMEpar le nom de la requête par défaut. Pour en savoir plus sur les requêtes par défaut, consultez la documentation de référence sur les requêtes par défaut.Pour désactiver une requête personnalisée, définissez le paramètre
enabledsurfalsepour cette requête personnalisée.Enregistrez le fichier de configuration.
Redémarrez l'agent pour que les nouveaux paramètres prennent effet :
sudo systemctl restart google-cloud-sap-agent
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 pour SAP HANA.
| Paramètres | |
|---|---|
provide_sap_host_agent_metrics |
Pour activer la collecte des métriques requises par l'agent hôte SAP, spécifiez |
bare_metal |
Lorsque l'agent est installé sur un serveur de solution Bare Metal, spécifiez |
log_level |
Pour définir le niveau de journalisation de l'agent, définissez la valeur requise. Les niveaux de journalisation disponibles sont les suivants :
La valeur par défaut est |
log_to_cloud |
Pour rediriger les journaux de l'agent vers Cloud Logging, spécifiez |
cloud_properties.project_id |
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. |
cloud_properties.instance_name
|
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. |
cloud_properties.region |
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. |
cloud_properties.zone |
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 |
Indiquez le nom d'image de l'OS de l'instance. |
cloud_properties.numeric_project_id |
Spécifiez l'ID numérique du projet Google Cloud dans lequel le système SAP est exécuté. |
discovery_configuration.enable_workload_discovery |
Pour permettre à l'agent de collecter les noms et les versions des produits SAP exécutés sur l'hôte, spécifiez Pour plus d'informations, consultez le codebase de l'agent dans le dépôt GitHub |
discovery_configuration.enable_discovery |
Pour envoyer à Cloud Logging les informations collectées par l'agent sur les produits SAP exécutés sur l'hôte, spécifiez Si vous spécifiez la valeur |
hana_monitoring_configuration.enabled |
Facultatif. Pour autoriser l'agent Google Cloud pour SAP à collecter les métriques de surveillance SAP HANA, spécifiez hana_monitoring_configuration.enabled: true.
|
hana_monitoring_configuration.sample_interval_sec |
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 |
hana_monitoring_configuration.query_timeout_sec |
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 |
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 |
Spécifiez l'identifiant de nom de votre instance SAP HANA. |
hana_monitoring_configuration.hana_instances.sid |
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 |
Spécifiez l'identifiant de la machine locale ou distante qui héberge votre instance SAP HANA. Les valeurs acceptées sont les suivantes :
|
hana_monitoring_configuration.hana_instances.port |
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 |
hana_monitoring_configuration.hana_instances.user |
Spécifiez le compte utilisateur utilisé pour interroger l'instance SAP HANA. |
hana_monitoring_configuration.hana_instances.password |
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 :
|
hana_monitoring_configuration.hana_instances.secret_name |
Facultatif. Spécifiez le nom du secret dans Secret Manager qui stocke le mot de passe du compte utilisateur. |
hana_monitoring_configuration.hana_instances.hdbuserstore_key
|
Pour authentifier l'utilisateur SAP HANA que vous spécifiez pour Pour utiliser une clé
Si vous spécifiez |
hana_monitoring_configuration.hana_instances.enable_ssl |
Facultatif. Indique si SSL est activé ou non dans votre instance SAP HANA. La valeur par défaut est |
hana_monitoring_configuration.hana_instances.host_name_in_certificate |
Si vous spécifiez |
hana_monitoring_configuration.hana_instances.tls_root_ca_file |
Si vous spécifiez |
hana_monitoring_configuration.queries.enabled |
Facultatif. Pour activer une requête SQL pour toutes vos instances SAP HANA, spécifiez la valeur |
hana_monitoring_configuration.queries.name |
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 |
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 |
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 |
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 |
Pour le traitement par Monitoring, spécifiez l'un des types de métriques suivants : Les métriques de type |
hana_monitoring_configuration.queries.columns.value_type |
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 : |
hana_monitoring_configuration.queries.columns.name_override |
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 :
|
Afficher les métriques collectées
Pour visualiser les métriques de surveillance SAP HANA collectées par l'agent, vous pouvez utiliser les tableaux de bord personnalisés suivants fournis par Google Cloud :
Présentation détaillée de l'agent pour SAP HANA : Ce tableau de bord fournit des graphiques qui indiquent l'état des métriques suivantes : mémoire de l'instance, mémoire de service utilisée, mémoire maximale estimée du schéma, taille totale de la mémoire du rowstore, anomalies de lecture du schéma, anomalies d'écriture du schéma, anomalies de décompte du dernier enregistrement compressé du schéma, connexions système, alertes, pourcentage de processeur pour les cinq premières VM, pourcentage de mémoire pour les cinq premières VM et hôtes par région.
Le fichier JSON de ce tableau de bord est
agent-for-sap-hana-detailed-overview.json.Performances de l'agent pour SAP HANA : Ce tableau de bord fournit des graphiques qui indiquent des valeurs de métriques brutes pour les métriques suivantes : mémoire de l'instance, anomalies de lecture et d'écriture de schéma, performances du schéma, utilisation de la mémoire, anomalies de décompte d'enregistrements du schéma, mémoire totale du service utilisée, taille de la mémoire du rowstore, connexions inactives du système et connexions en cours, mémoire de connexion et de rowstore, enregistrements totaux du schéma et taille totale maximale estimée du schéma.
Le fichier JSON de ce tableau de bord est
agent-for-sap-hana-performance.json.
Installer des tableaux de bord
Pour installer un tableau de bord personnalisé, procédez comme suit :
Console Google Cloud
Dans la console Google Cloud, accédez à la page Monitoring :
Dans le panneau de navigation Monitoring, cliquez sur Tableaux de bords.
Cliquez sur l'onglet Exemple de bibliothèque.
Pour filtrer les tableaux de bord personnalisés spécifiques à l'agent, saisissez
Agent for SAPdans le champ Filtre.(Facultatif) Pour afficher les détails d'un tableau de bord ou pour prévisualiser son contenu, cliquez sur Aperçu.
Sélectionnez le tableau de bord que vous souhaitez installer.
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
Ouvrez Cloud Shell.
Dans Cloud Shell, clonez ou téléchargez le dépôt :
git clone https://github.com/GoogleCloudPlatform/monitoring-dashboard-samples/
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_FILEpar 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'emplacementmonitoring-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 :
Dans la console Google Cloud, accédez à la page Monitoring :
Dans le panneau de navigation Monitoring, cliquez sur Tableaux de bords.
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.
