SAP HANA

L'intégration SAP HANA collecte les métriques et les journaux SAP HANA. Les métriques sont collectées en interrogeant les vues de surveillance pertinentes. Cette intégration écrit des journaux trace structurés.

Pour en savoir plus sur HANA, consultez la documentation de SAP HANA.

Prérequis

Pour collecter les données de télémétrie HANA, vous devez installer l'agent Ops :

  • Pour les métriques, installez la version 2.18.1 ou ultérieure.
  • Pour les journaux, installez la version 2.18.1 ou ultérieure.

Cette intégration est compatible avec HANA version 2.0.

Configurer votre instance HANA

Pour collecter des métriques, un utilisateur de surveillance doit disposer d'un accès SELECT aux vues de surveillance pertinentes. Le script SQL suivant crée un rôle de surveillance et l'applique à un utilisateur de surveillance, à condition qu'il soit exécuté par un utilisateur disposant d'autorisations suffisantes et connecté à l'instance SAP HANA.

--Create the user
CREATE RESTRICTED USER otel_monitoring_user PASSWORD ;
--Enable user login
ALTER USER otel_monitoring_user ENABLE CLIENT CONNECT;
--Create the monitoring role
CREATE ROLE OTEL_MONITORING;
--Grant permissions to the relevant views
GRANT CATALOG READ TO OTEL_MONITORING;
GRANT SELECT ON SYS.M_BACKUP_CATALOG TO OTEL_MONITORING;
GRANT SELECT ON SYS.M_BLOCKED_TRANSACTIONS TO OTEL_MONITORING;
GRANT SELECT ON SYS.M_CONNECTIONS TO OTEL_MONITORING;
GRANT SELECT ON SYS.M_CS_ALL_COLUMNS TO OTEL_MONITORING;
GRANT SELECT ON SYS.M_CS_TABLES TO OTEL_MONITORING;
GRANT SELECT ON SYS.M_DATABASE TO OTEL_MONITORING;
GRANT SELECT ON SYS.M_DISKS TO OTEL_MONITORING;
GRANT SELECT ON SYS.M_HOST_RESOURCE_UTILIZATION TO OTEL_MONITORING;
GRANT SELECT ON SYS.M_LICENSES TO OTEL_MONITORING;
GRANT SELECT ON SYS.M_RS_TABLES TO OTEL_MONITORING;
GRANT SELECT ON SYS.M_SERVICE_COMPONENT_MEMORY TO OTEL_MONITORING;
GRANT SELECT ON SYS.M_SERVICE_MEMORY TO OTEL_MONITORING;
GRANT SELECT ON SYS.M_SERVICE_REPLICATION TO OTEL_MONITORING;
GRANT SELECT ON SYS.M_SERVICE_STATISTICS TO OTEL_MONITORING;
GRANT SELECT ON SYS.M_SERVICE_THREADS TO OTEL_MONITORING;
GRANT SELECT ON SYS.M_SERVICES TO OTEL_MONITORING;
GRANT SELECT ON SYS.M_VOLUME_IO_TOTAL_STATISTICS TO OTEL_MONITORING;
GRANT SELECT ON SYS.M_WORKLOAD TO OTEL_MONITORING;
GRANT SELECT ON _SYS_STATISTICS.STATISTICS_CURRENT_ALERTS TO OTEL_MONITORING;
GRANT SELECT ON DUMMY TO OTEL_MONITORING;
--Add the OTEL_MONITOR role to the monitoring user
GRANT OTEL_MONITORING TO otel_monitoring_user;

Configurer l'agent Ops pour HANA

En suivant le guide de configuration de l'agent Ops, ajoutez les éléments requis pour collecter la télémétrie des instances HANA et redémarrez l'agent.

Exemple de configuration

Les commandes suivantes créent la configuration de collecte et d'ingestion de la télémétrie pour HANA et redémarrent l'agent Ops.

# Configures Ops Agent to collect telemetry from the app and restart Ops Agent.

set -e

# Create a back up of the existing file so existing configurations are not lost.
sudo cp /etc/google-cloud-ops-agent/config.yaml /etc/google-cloud-ops-agent/config.yaml.bak

# Configure the Ops Agent.
sudo tee /etc/google-cloud-ops-agent/config.yaml > /dev/null << EOF
logging:
  receivers:
    saphana:
      type: saphana
      include_paths:
      - /usr/sap/*/HDB*/*/trace/*.trc
      exclude_paths:
      - /usr/sap/*/HDB*/*/trace/nameserver_history*.trc
      - /usr/sap/*/HDB*/*/trace/nameserver*loads*.trc
      - /usr/sap/*/HDB*/*/trace/nameserver*executed_statements*.trc
  service:
    pipelines:
      saphana:
        receivers:
          - saphana
metrics:
  receivers:
    saphana:
      type: saphana
      username: SYSTEM
      password: G00g3l21
      endpoint: localhost:30015
  service:
    pipelines:
      saphana:
        receivers:
          - saphana
EOF

sudo service google-cloud-ops-agent restart

Configurer la collecte de journaux

Pour ingérer des journaux à partir de HANA, vous devez créer un récepteur pour les journaux produits par HANA, puis créer un pipeline pour le nouveau récepteur.

Pour configurer un récepteur pour vos journaux saphana, spécifiez les champs suivants :

Champ Par défaut Description
exclude_paths [/usr/sap/*/HDB*/${HOSTNAME}/trace/nameserver_history*.trc, /usr/sap/*/HDB*/${HOSTNAME}/trace/nameserver*loads*.trc, /usr/sap/*/HDB*/${HOSTNAME}/trace/nameserver*executed_statements*.trc] Liste des formats de chemin d'accès au système de fichiers à exclure de l'ensemble correspondant à include_paths.
include_paths [/usr/sap/*/HDB*/${HOSTNAME}/trace/*.trc] Liste des chemins d'accès du système de fichiers à lire en affichant chaque fichier. Un caractère générique (*) peut être utilisé dans les chemins d'accès.
record_log_file_path false Si cette valeur est définie sur true, le chemin d'accès au fichier spécifique à partir duquel l'enregistrement de journal a été obtenu apparaît dans l'entrée de journal de sortie en tant que valeur du libellé agent.googleapis.com/log_file_path. Lorsque vous utilisez un caractère générique, seul le chemin du fichier à partir duquel l'enregistrement a été obtenu est enregistré.
type La valeur doit être égale à saphana.
wildcard_refresh_interval 60s Intervalle d'actualisation pour les chemins d'accès de fichiers utilisant des caractères génériques dans include_paths. Renseigné sous la forme d'une durée, par exemple, 30s ou 2m. Cette propriété peut s'avérer utile lorsque le débit de journalisation est élevé et que les fichiers journaux sont alternés plus rapidement que l'intervalle par défaut.

Contenu consigné

Le champ logName est dérivé des ID de récepteur spécifiés dans la configuration. Les champs détaillés dans l'entrée de journal (LogEntry) sont les suivants.

Les journaux saphana contiennent les champs suivants dans LogEntry :

Champ Type Description
jsonPayload.component chaîne Composant SAP HANA
jsonPayload.connection_id nombre ID de la connexion à l'origine du message, si celui-ci a été consigné dans le cadre d'une connexion
jsonPayload.message chaîne Message du journal
jsonPayload.severity_flag chaîne Niveau de l'entrée de journal
jsonPayload.thread_id nombre ID du thread qui consigne le message
jsonPayload.transaction_id nombre ID de la transaction à l'origine du message, si celui-ci a été consigné dans le cadre d'une transaction.
jsonPayload.update_transaction_id nombre ID de la transaction de mise à jour à l'origine du message, si celui-ci a été consigné dans le cadre d'une transaction de mise à jour.
severity chaîne (LogSeverity) Niveau d'entrée de journal (traduit).
sourceLocation.file chaîne Nom du fichier source
sourceLocation.line nombre Ligne dans le fichier source

Configurer la collecte de métriques

Pour ingérer des métriques à partir de HANA, vous devez créer un récepteur pour les métriques produites par HANA, puis créer un pipeline pour le nouveau récepteur.

Ce récepteur ne permet pas d'utiliser plusieurs instances dans la configuration, par exemple pour surveiller plusieurs points de terminaison. Toutes ces instances écrivent dans la même série temporelle, et Cloud Monitoring n'a aucun moyen de les distinguer.

Pour configurer un récepteur pour vos métriques saphana, spécifiez les champs suivants :

Champ Par défaut Description
ca_file Chemin d'accès au certificat CA. En tant que client, cela vérifie le certificat du serveur. Si ce champ est vide, le récepteur utilise l'autorité de certification racine du système.
cert_file Chemin d'accès au certificat TLS à utiliser pour les connexions mTLS requises.
collection_interval 60s Une valeur time duration, telle que 30s ou 5m.
endpoint localhost:30015 hostname:port utilisé pour se connecter à l'instance SAP HANA.
insecure true Indique si une connexion TLS sécurisée doit être utilisée. Si ce paramètre est défini sur false, TLS est activé.
insecure_skip_verify false Indique si la validation du certificat doit être ignorée ou non. Si insecure est défini sur true, la valeur insecure_skip_verify n'est pas utilisée.
key_file Chemin d'accès à la clé TLS à utiliser pour les connexions mTLS requises.
password Mot de passe utilisé pour se connecter à l'instance.
type Cette valeur doit être saphana.
username Nom d'utilisateur utilisé pour se connecter à l'instance.

Métriques surveillées

Le tableau suivant fournit la liste des métriques que l'agent Ops collecte à partir de l'instance HANA.

Type de métrique
Genre, type
Ressources surveillées		 Étiquettes
workload.googleapis.com/saphana.alert.count
GAUGE, INT64
gce_instance 		rating
workload.googleapis.com/saphana.backup.latest
GAUGE, INT64
gce_instance 		 
workload.googleapis.com/saphana.column.memory.used
GAUGE, INT64
gce_instance 		host
subtype
type
workload.googleapis.com/saphana.component.memory.used
GAUGE, INT64
gce_instance 		component
host
workload.googleapis.com/saphana.connection.count
GAUGE, INT64
gce_instance 		host
status
workload.googleapis.com/saphana.cpu.used
CUMULATIVE, INT64
gce_instance 		host
type
workload.googleapis.com/saphana.disk.size.current
GAUGE, INT64
gce_instance 		host
path
state
usage_type
workload.googleapis.com/saphana.host.memory.current
GAUGE, INT64
gce_instance 		host
state
workload.googleapis.com/saphana.host.swap.current
GAUGE, INT64
gce_instance 		host
state
workload.googleapis.com/saphana.instance.code_size
GAUGE, INT64
gce_instance 		host
workload.googleapis.com/saphana.instance.memory.current
GAUGE, INT64
gce_instance 		host
state
workload.googleapis.com/saphana.instance.memory.shared.allocated
GAUGE, INT64
gce_instance 		host
workload.googleapis.com/saphana.instance.memory.used.peak
GAUGE, INT64
gce_instance 		host
workload.googleapis.com/saphana.license.expiration.time
GAUGE, INT64
gce_instance 		product
system
workload.googleapis.com/saphana.license.limit
GAUGE, INT64
gce_instance 		product
system
workload.googleapis.com/saphana.license.peak
GAUGE, INT64
gce_instance 		product
system
workload.googleapis.com/saphana.network.request.average_time
GAUGE, DOUBLE
gce_instance 		host
workload.googleapis.com/saphana.network.request.count
GAUGE, INT64
gce_instance 		host
state
workload.googleapis.com/saphana.network.request.finished.count
CUMULATIVE, INT64
gce_instance 		host
type
workload.googleapis.com/saphana.replication.average_time
GAUGE, DOUBLE
gce_instance 		mode
port
primary
secondary
workload.googleapis.com/saphana.replication.backlog.size
GAUGE, INT64
gce_instance 		mode
port
primary
secondary
workload.googleapis.com/saphana.replication.backlog.time
GAUGE, INT64
gce_instance 		mode
port
primary
secondary
workload.googleapis.com/saphana.row_store.memory.used
GAUGE, INT64
gce_instance 		host
type
workload.googleapis.com/saphana.schema.memory.used.current
GAUGE, INT64
gce_instance 		host
schema
type
workload.googleapis.com/saphana.schema.memory.used.max
GAUGE, INT64
gce_instance 		host
schema
workload.googleapis.com/saphana.schema.operation.count
CUMULATIVE, INT64
gce_instance 		host
schema
type
workload.googleapis.com/saphana.schema.record.compressed.count
GAUGE, INT64
gce_instance 		host
schema
workload.googleapis.com/saphana.schema.record.count
GAUGE, INT64
gce_instance 		host
schema
type
workload.googleapis.com/saphana.service.code_size
GAUGE, INT64
gce_instance 		host
service
workload.googleapis.com/saphana.service.count
GAUGE, INT64
gce_instance 		host
status
workload.googleapis.com/saphana.service.memory.compactors.allocated
GAUGE, INT64
gce_instance 		host
service
workload.googleapis.com/saphana.service.memory.compactors.freeable
GAUGE, INT64
gce_instance 		host
service
workload.googleapis.com/saphana.service.memory.effective_limit
GAUGE, INT64
gce_instance 		host
service
workload.googleapis.com/saphana.service.memory.heap.current
GAUGE, INT64
gce_instance 		host
service
state
workload.googleapis.com/saphana.service.memory.limit
GAUGE, INT64
gce_instance 		host
service
workload.googleapis.com/saphana.service.memory.shared.current
GAUGE, INT64
gce_instance 		host
service
state
workload.googleapis.com/saphana.service.memory.used
GAUGE, INT64
gce_instance 		host
service
type
workload.googleapis.com/saphana.service.stack_size
GAUGE, INT64
gce_instance 		host
service
workload.googleapis.com/saphana.service.thread.count
GAUGE, INT64
gce_instance 		host
status
workload.googleapis.com/saphana.transaction.blocked
GAUGE, INT64
gce_instance 		host
workload.googleapis.com/saphana.transaction.count
CUMULATIVE, INT64
gce_instance 		host
type
workload.googleapis.com/saphana.volume.operation.count
CUMULATIVE, INT64
gce_instance 		host
path
type
usage_type
workload.googleapis.com/saphana.volume.operation.size
CUMULATIVE, INT64
gce_instance 		host
path
type
usage_type
workload.googleapis.com/saphana.volume.operation.time
CUMULATIVE, INT64
gce_instance 		host
path
type
usage_type

Vérifier la configuration

Cette section explique comment vérifier que vous avez bien configuré le récepteur HANA. La collecte de la télémétrie par l'agent Ops peut prendre une ou deux minutes.

Pour vérifier que les journaux HANA sont envoyés à Cloud Logging, procédez comme suit:

  1. Dans la console Google Cloud, accédez à la page Explorateur de journaux.

    Accéder à l'explorateur de journaux

    Si vous utilisez la barre de recherche pour trouver cette page, sélectionnez le résultat dont le sous-titre est Logging.

  2. Saisissez la requête suivante dans l'éditeur, puis cliquez sur Exécuter la requête :
    resource.type="gce_instance"
log_id("saphana")

Pour vérifier que les métriques HANA sont envoyées à Cloud Monitoring, procédez comme suit:

  1. Dans la console Google Cloud, accédez à la page Explorateur de métriques :

    Accéder à l'explorateur de métriques

    Si vous utilisez la barre de recherche pour trouver cette page, sélectionnez le résultat dont le sous-titre est Monitoring.

  2. Dans la barre d'outils du volet de création de requêtes, sélectionnez le bouton nommé  MQL ou  PromQL.
  3. Vérifiez que MQL est sélectionné dans le bouton d'activation Langage. Le bouton de langage se trouve dans la barre d'outils qui vous permet de mettre en forme votre requête.
  4. Saisissez la requête suivante dans l'éditeur, puis cliquez sur Exécuter la requête :
    fetch gce_instance
| metric 'workload.googleapis.com/saphana.connection.count'
| every 1m

Afficher le tableau de bord

Pour afficher vos métriques HANA, vous devez configurer un graphique ou un tableau de bord. L'intégration HANA inclut un ou plusieurs tableaux de bord. Tous les tableaux de bord sont automatiquement installés après la configuration de l'intégration et que l'agent Ops a commencé à collecter des données de métriques.

Vous pouvez également afficher des aperçus statiques de tableaux de bord sans installer l'intégration.

Pour afficher un tableau de bord installé, procédez comme suit :

  1. Dans la console Google Cloud, accédez à la page Tableaux de bord .

    Accéder à la page Tableaux de bord

    Si vous utilisez la barre de recherche pour trouver cette page, sélectionnez le résultat dont le sous-titre est Monitoring.

  2. Sélectionnez l'onglet Liste des tableaux de bord, puis choisissez la catégorie Intégrations.
  3. Cliquez sur le nom du tableau de bord que vous souhaitez afficher.

Si vous avez configuré une intégration, mais que le tableau de bord n'a pas été installé, vérifiez que l'agent Ops est en cours d'exécution. Lorsqu'un graphique ne contient aucune donnée de métrique, l'installation du tableau de bord échoue. Une fois que l'agent Ops a commencé à collecter des métriques, le tableau de bord est installé.

Pour afficher un aperçu statique du tableau de bord, procédez comme suit :

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

    Accéder à la page Intégrations

    Si vous utilisez la barre de recherche pour trouver cette page, sélectionnez le résultat dont le sous-titre est Monitoring.

  2. Cliquez sur le filtre de plate-forme de déploiement Compute Engine.
  3. Recherchez l'entrée pour HANA, puis cliquez sur Afficher les détails.
  4. Cliquez sur l'onglet Tableaux de bord pour afficher un aperçu statique. Si le tableau de bord est installé, vous pouvez y accéder en cliquant sur Afficher le tableau de bord.

Pour en savoir plus sur les tableaux de bord dans Cloud Monitoring, consultez la page Tableaux de bord et graphiques.

Pour en savoir plus sur l'utilisation de la page Intégrations, consultez la page Gérer les intégrations.

Installer des règles d'alerte

Les règles d'alerte indiquent à Cloud Monitoring de vous avertir lorsque des conditions spécifiées se produisent. L'intégration HANA inclut une ou plusieurs règles d'alerte. Vous pouvez afficher et installer ces règles d'alerte à partir de la page Intégrations dans Monitoring.

Pour afficher la description des règles d'alerte disponibles et les installer, procédez comme suit :

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

    Accéder à la page Intégrations

    Si vous utilisez la barre de recherche pour trouver cette page, sélectionnez le résultat dont le sous-titre est Monitoring.

  2. Recherchez l'entrée pour HANA, puis cliquez sur Afficher les détails.
  3. Sélectionnez l'onglet Alertes. Cet onglet fournit une description des règles d'alerte disponibles et fournit une interface pour les installer.
  4. Installez les règles d'alerte. Les règles d'alerte doivent savoir où envoyer des notifications indiquant que l'alerte a été déclenchée. Elles nécessitent donc des informations de votre part pour l'installation. Pour installer des règles d'alerte, procédez comme suit :
    1. Dans la liste des règles d'alerte disponibles, sélectionnez celles que vous souhaitez installer.

    2. Dans la section Configurer les notifications, sélectionnez un ou plusieurs canaux de notification. Vous avez la possibilité de désactiver l'utilisation des canaux de notification. Toutefois, si vous le faites, vos règles d'alerte se déclenchent en mode silencieux. Vous pouvez vérifier leur état dans Monitoring, mais vous ne recevez aucune notification.

      Pour plus d'informations sur les canaux de notification, consultez la section Gérer les canaux de notification.

    3. Cliquez sur Créer des règles.

Pour plus d'informations sur les règles d'alerte dans Cloud Monitoring, consultez la section Présentation des alertes.

Pour en savoir plus sur l'utilisation de la page Intégrations, consultez la page Gérer les intégrations.

Étape suivante

Pour accéder à un tutoriel pas à pas expliquant comment utiliser Ansible pour installer l'agent Ops, configurer une application tierce et installer un exemple de tableau de bord, consultez la vidéo Install the Ops Agent to troubleshoot third-party applications (Installer l'agent Ops pour résoudre les problèmes liés à des applications tierces).