Configura la recopilación de métricas de supervisión de SAP HANA.

En esta guía se muestra cómo configurar el agente de Google Cloud para SAP a fin de recopilar las métricas de supervisión de SAP HANA de tus sistemas SAP HANA.

Si deseas obtener información sobre esta función, consulta Supervisa SAP HANA con el agente de Google Cloud para SAP.

Antes de comenzar

Configura las funciones de IAM

Para permitir que el agente de Google Cloud para SAP recopile las métricas de Process Monitoring, debes asegurarte de que la cuenta de servicio que usa tu instancia de VM de Compute Engine o el servidor de la solución Bare Metal incluya los siguientes roles:

Para agregar estos roles necesarios a tu cuenta de servicio, sigue estos pasos:

  1. En la consola de Google Cloud, ve a la página IAM.

    Ir a IAM

  2. Selecciona tu proyecto de Google Cloud.

  3. Identifica la cuenta de servicio a la que le quieres agregar un rol.

    • Si la cuenta de servicio no se encuentra aún en la lista de principales, no tiene ningún rol asignado. Haz clic en Agregar e ingresa la dirección de correo electrónico de la cuenta de servicio.
    • Si la cuenta de servicio ya se encuentra en la lista de principales es porque tiene roles existentes. Haz clic en el botón Editar de la cuenta de servicio que deseas editar.
  4. Selecciona el rol necesario de la lista de funciones disponibles:

    • Visualizador de Compute
    • Monitoring > Escritor de métricas de Monitoring
    • Secret Manager > Usuario con acceso a secretos de Secret Manager
  5. Haz clic en Agregar o Guardar para aplicar los roles a la cuenta de servicio.

Habilita la recopilación de métricas de supervisión de SAP HANA

Si deseas habilitar la recopilación de métricas de Monitoring de SAP HANA mediante el agente de Google Cloud para SAP, sigue estos pasos:

  1. Establece una conexión SSH con tu instancia de VM de Compute Engine o el servidor de la solución Bare Metal.

  2. Reemplaza el archivo de configuración del agente:

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

    Como alternativa, también puedes realizar esta configuración mediante la ejecución de comandos. Si deseas obtener más información, consulta Comandos de configuración para el agente de Google Cloud para SAP.

  3. En la sección hana_monitoring_configuration, realiza lo siguiente:

    • Para el parámetro enabled, configura el valor true.
    • En la sección hana_instances, especifica las instancias de SAP HANA que deseas que supervise el agente.
    • De manera opcional, define consultas personalizadas. Para obtener información sobre cómo definir consultas personalizadas y ver ejemplos, consulta Define consultas personalizadas.
    • De manera opcional, inhabilita las consultas integradas o predeterminadas. Para obtener instrucciones, consulta Inhabilita una consulta en SQL.

      Para obtener información sobre los parámetros de configuración, consulta Parámetros de configuración.

  4. De manera opcional, en la sección cloud_properties, puedes actualizar los valores del parámetro que se configuran de forma automática. Para hacerlo, agrega la sección cloud_properties a tu archivo de configuración y, luego, especifica las propiedades obligatorias y sus valores.

  5. Guarda el archivo de configuración.

  6. Reinicia el agente para que se aplique la configuración nueva:

    sudo systemctl restart google-cloud-sap-agent

Archivos de configuración de ejemplo

Instancia de VM de Compute Engine

El siguiente ejemplo es un archivo de configuración completo del agente de Google Cloud para SAP, que se ejecuta enuna instancia de VM de Compute Engine, en el que se habilita la recopilación de las métricas en el que se habilita la recopilación de las métricas de monitorización de SAP HANA: Ten en cuenta que la consulta personalizada incluida en este ejemplo, llamada custom_query, sigue los lineamientos de definición de consultas personalizadas que se especifican en Define consultas personalizadas.

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

Servidor de solución Bare Metal

El siguiente ejemplo es un archivo de configuración completo del agente de Google Cloud para SAP, que se ejecuta enun servidor de solución Bare Metal, en el que se habilita la recopilación de las métricas de monitorización de SAP HANA: Ten en cuenta que la consulta personalizada incluida en este ejemplo, llamada custom_query, sigue los lineamientos de definición de consultas personalizadas que se especifican en Define consultas personalizadas.

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

Define una consulta en SQL personalizada

El agente de Google Cloud para SAP recopila las métricas de supervisión de SAP HANA mediante la ejecución de consultas de SQL en las instancias de SAP HANA. Además de estas consultas predeterminadas, puedes definir y ejecutar consultas en SQL personalizadas si completas los siguientes pasos:

  1. Establece una conexión SSH con tu instancia de VM de Compute Engine o el servidor de la solución Bare Metal.

  2. Reemplaza el archivo de configuración del agente:

    /etc/google-cloud-sap-agent/configuration.json
  3. En la sección hana_monitoring_configuration.queries, define tu consulta personalizada.

    Para obtener información sobre cómo definir consultas personalizadas y ver ejemplos, consulta Define consultas personalizadas.

  4. Para habilitar una consulta personalizada, establece su parámetro enabled en true.

  5. Guarda el archivo de configuración.

  6. Reinicia el agente para que se aplique la configuración nueva:

    sudo systemctl restart google-cloud-sap-agent

Inhabilitar una consulta en SQL

Si no deseas ejecutar ninguna de las consultas en SQL integradas que proporciona el agente de Google Cloud para SAP de forma predeterminada o cualquiera de las consultas personalizadas que definas, puedes inhabilitar la consulta de SQL mediante lo siguiente: Completa los siguientes pasos:

  1. Establece una conexión SSH con tu instancia de VM de Compute Engine o el servidor de la solución Bare Metal.

  2. Reemplaza el archivo de configuración del agente:

    /etc/google-cloud-sap-agent/configuration.json
  3. Para inhabilitar una consulta integrada o predeterminada, incluye lo siguiente en la sección hana_monitoring_configuration.queries:

    {
    "name": "default_QUERY_NAME",
    "enabled": false
    }

    Reemplaza QUERY_NAME por el nombre de la consulta predeterminada. Para obtener información sobre las consultas predeterminadas, consulta Referencia de consultas predeterminadas.

  4. Para inhabilitar una consulta personalizada, establece el parámetro enabled en false para esa consulta personalizada.

  5. Guarda el archivo de configuración.

  6. Reinicia el agente para que se aplique la configuración nueva:

    sudo systemctl restart google-cloud-sap-agent

Parámetros de configuración

En la siguiente tabla se explican las propiedades de configuración del agente de SAP para Google Cloud que son específicas de la recopilación de métricas de Monitoring de SAP HANA.

Parámetros
provide_sap_host_agent_metrics

Boolean

Para habilitar la recopilación de las métricas que requiere SAP Host Agent, especifica true. La ruta predeterminada es true.
No establezcas provide_sap_host_agent_metrics en false, a menos que te dirijan el servicio de atención al cliente de Cloud o el de asistencia de SAP.

bare_metal

Boolean

Cuando el agente se instale en un servidor de solución Bare Metal, especifica true. La ruta predeterminada es false.

log_level

String

Para establecer el nivel de registro del agente, establece el valor requerido. Los niveles de registro disponibles son los siguientes:

  • DEBUG
  • INFO
  • WARNING
  • ERROR

El valor predeterminado es INFO. No cambies el nivel de registro, a menos que te dirija el servicio de atención al cliente de Cloud.

log_to_cloud

Boolean

Para redireccionar los registros del agente a Cloud Logging, especifica true. El valor predeterminado es true.

cloud_properties.project_id

String

Si tu sistema SAP se ejecuta en un servidor de la solución Bare Metal, especifica el ID del proyecto de Google Cloud que usas con la solución Bare Metal.

Cuando el agente se ejecuta en una instancia de VM, de forma predeterminada, detecta el ID del proyecto automáticamente.

cloud_properties.instance_name

String

Si el sistema SAP se ejecuta en una instancia de VM de Compute Engine, especifica el nombre de esa instancia de VM. El agente detecta automáticamente el nombre de la instancia de VM durante la instalación.

Si tu sistema SAP se ejecuta en un servidor de la solución Bare Metal, especifica el nombre de ese servidor.

cloud_properties.region

String

Si tu sistema SAP se ejecuta en un servidor de la solución Bare Metal, especifica la región del servidor de la solución Bare Metal.

Cuando el agente se ejecuta en una instancia de VM, de forma predeterminada, usa la región de la instancia de VM en la que está instalado el agente.

cloud_properties.zone

String

Cuando el agente se ejecuta en una instancia de VM, de forma predeterminada, usa la zona de la instancia de VM en la que está instalado el agente.

cloud_properties.image

String

Especifica el nombre de la imagen de SO de la instancia.

Cuando el agente se ejecuta en una instancia de VM, de forma predeterminada, detecta el imagen de SO de la instancia de VM en la que está instalado el agente.

cloud_properties.numeric_project_id

String

El ID numérico del proyecto de Google Cloud en el que se ejecuta el sistema SAP.

Cuando el agente se ejecuta en una instancia de VM, de forma predeterminada, detecta el ID del proyecto numérico automáticamente.

discovery_configuration.enable_workload_discovery

Boolean

Para permitir que el agente recopile los nombres y las versiones de los productos SAP que se ejecutan en el host, especifica true. El valor predeterminado es true.

Para obtener más información, consulta la base de código del agente en el repositorio google-cloud-sap-agent de GitHub en GoogleCloudPlatform/sapagent.

discovery_configuration.enable_discovery

Boolean

Para enviar a Cloud Logging la información que el agente recopila sobre los productos de SAP que se ejecutan en el host, especifica true. El valor predeterminado es true.

Si especificas el valor false, el agente almacenará la información recopilada en el host y no la enviará a Cloud Logging.

hana_monitoring_configuration.enabled

Boolean

Opcional. Si deseas habilitar el agente de Google Cloud para SAP a fin de recopilar las métricas de supervisión de SAP HANA, especifica true. El valor predeterminado es false.

Los siguientes parámetros secundarios solo se aplican cuando especificas hana_monitoring_configuration.enabled: true.
hana_monitoring_configuration.sample_interval_sec

Int

Opcional. Especifica el intervalo de muestra, en segundos, que determina la frecuencia con la que el agente de Google Cloud para SAP consulta tus instancias de SAP HANA para recopilar las métricas de supervisión de SAP HANA. El valor predeterminado es 300 segundos.

Para cada consulta definida en el archivo de configuración del agente de Google Cloud para SAP, puedes reemplazar el intervalo de muestra global si especificas el intervalo requerido en el parámetro sample_interval_sec. Los intervalos de muestra deben ser de 5 segundos o más.

hana_monitoring_configuration.query_timeout_sec

Int

Opcional. Especifica el tiempo de espera para cada consulta realizada a las instancias de SAP HANA. El valor predeterminado es 300 segundos.

hana_monitoring_configuration.execution_threads

Int

Opcional. Especifica la cantidad de subprocesos que se usan para enviar consultas a las instancias de SAP HANA. Cada consulta se ejecuta en su propio subproceso. El valor predeterminado es 10.

hana_monitoring_configuration.hana_instances.name

String

Especifica el identificador de nombre para tu instancia de SAP HANA.

hana_monitoring_configuration.hana_instances.sid

String

Especifica el SID de tu instancia de SAP HANA. Esta cadena se agrega como una etiqueta a todas las métricas resultantes de la consulta de tus instancias de SAP HANA.

hana_monitoring_configuration.hana_instances.host

String

Especifica el identificador de la máquina, ya sea local o remoto, que aloja la instancia de SAP HANA. Los siguientes son los valores admitidos:

  • Si el host es una máquina local, especifica la cadena localhost o la dirección IP de bucle invertido del host local, como 127.0.0.1.
  • Si el host es una máquina remota, especifica su dirección IP interna o externa.
hana_monitoring_configuration.hana_instances.port

String

Especifica el puerto en el que la instancia de SAP HANA acepta consultas. Para la primera o única instancia de base de datos de usuario, el puerto es 3NN15, en el que NN es el número de instancia de la instancia de SAP HANA.

hana_monitoring_configuration.hana_instances.user

String

Especifica la cuenta de usuario que se usa para consultar la instancia de SAP HANA.

hana_monitoring_configuration.hana_instances.password

String

Opcional. Especifica la contraseña, como texto sin formato, que autentica la cuenta de usuario para consultar la instancia de SAP HANA.

Para la autenticación, debes especificar una de las siguientes opciones:

  • La contraseña de texto sin formato al parámetro password.
  • (Recomendado) Si usas Secret Manager para almacenar la contraseña como un secreto, debes especificar el nombre del secreto correspondiente al parámetro secret_name.
  • (Recomendado) Una clave hdbuserstore para el parámetro hdbuserstore_key.
hana_monitoring_configuration.hana_instances.secret_name

String

Opcional. Especifica el nombre del secreto en Secret Manager que almacena la contraseña de la cuenta de usuario.

hana_monitoring_configuration.hana_instances.hdbuserstore_key

String

Para conectarte de forma segura a un sistema SAP HANA, especifica una clave de almacenamiento seguro de usuario (hdbuserstore) que hayas creado para ese sistema.

Para usar una clave hdbuserstore para la autenticación, asegúrate de lo siguiente:

  • Las herramientas de SAP hdbsql y hdduserstore se instalan en la instancia de procesamiento que aloja el agente.
  • La clave hdbuserstore corresponde a una instancia específica de SAP HANA. No puedes usar claves que contengan nombres de host de varias instancias de SAP HANA.

Si especificas hdbuserstore_key, puedes omitir la especificación de los parámetros host y port.

hana_monitoring_configuration.hana_instances.enable_ssl

Boolean

Opcional. Especifica si SSL está habilitado en tu instancia de SAP HANA. El valor predeterminado es false.

hana_monitoring_configuration.hana_instances.host_name_in_certificate

String

Si especificas enable_ssl: true para una instancia de SAP HANA, debes especificar el nombre de host que se configura en el certificado SSL.

hana_monitoring_configuration.hana_instances.tls_root_ca_file

String

Si especificas enable_ssl: true para una instancia de SAP HANA, debes especificar la ruta de acceso de tu certificado de seguridad.

hana_monitoring_configuration.queries.enabled

Boolean

Opcional. A fin de habilitar una consulta en SQL para todas tus instancias de SAP HANA, especifica el valor true del parámetro enabled de esa consulta de SQL.

hana_monitoring_configuration.queries.name

String

Si definiste consultas personalizadas en tu archivo de configuración, debes especificar un nombre único para cada consulta personalizada.

El nombre de la consulta debe ser único, ya que se usa para compilar la URL predeterminada de la métrica en Monitoring.

hana_monitoring_configuration.queries.sql

String

Especifica la instrucción de SQL que el agente emite a tus instancias de SAP HANA.

La instrucción de SQL debe cumplir con la sintaxis de SQL definida por SAP en SAP HANA SQL and System Views Reference.
hana_monitoring_configuration.queries.sample_interval_sec

Int

Opcional. Especifica el intervalo de muestra para la consulta de SQL. Esto anula el intervalo de muestra global. El valor debe ser de 5 segundos o más.

hana_monitoring_configuration.queries.columns.name

String

Especifica un nombre que identifique de forma única cada columna.

El nombre de columna debe ser único porque se usa para compilar la URL predeterminada de la métrica en Monitoring.

hana_monitoring_configuration.queries.columns.metric_type

String

Para el manejo mediante Monitoring, especifica uno de los siguientes tipos de métricas: METRIC_LABEL, METRIC_GAUGE o METRIC_CUMULATIVE.

Las métricas de tipo METRIC_LABEL se agregan como etiquetas a todas las métricas METRIC_GAUGE y METRIC_CUMULATIVE que se envían a Monitoring.

hana_monitoring_configuration.queries.columns.value_type

String

Para el control de Monitoring, especifica un tipo de datos que sea compatible con el tipo de métrica.

Los tipos de datos compatibles son los siguientes: VALUE_BOOL, VALUE_INT64, VALUE_STRING o VALUE_DOUBLE. Para obtener más información, consulta Combinación compatible.

hana_monitoring_configuration.queries.columns.name_override

String

Opcional. Para el manejo mediante Monitoring, especifica la ruta de acceso que deseas mostrar en la URL de la métrica en lugar de los nombres de columna y consulta. Por ejemplo:

  • URL predeterminada de la métrica: workload.googleapis.com/sap/hanamonitoring/QUERY_NAME/COLUMN_NAME
  • URL de la métrica con ruta de acceso personalizada: workload.googleapis.com/sap/hanamonitoring/CUSTOM_PATH

Visualiza las métricas recopiladas

Para visualizar las métricas de supervisión de SAP HANA que recopila el agente, puedes usar los siguientes paneles personalizados que proporciona Google Cloud:

  • Agente para SAP - Descripción general detallada de HANA: en este panel, se proporcionan gráficos que muestran la descripción general del estado para las siguientes métricas: memoria de la instancia, memoria usada del servicio, memoria máxima estimada del esquema, tamaño total de la memoria del almacén de filas, valores atípicos de lectura del esquema, valores atípicos de escritura del esquema, valores atípicos de recuento de registros comprimidos del último esquema, conexiones del sistema, alertas, porcentaje de CPU para las 5 VMs principales, porcentaje de memoria para las 5 VMs principales y los hosts por región.

    El archivo JSON para este panel es agent-for-sap-hana-detailed-overview.json.

  • Agente para SAP - Rendimiento de HANA: en este panel, se proporcionan gráficos que muestran valores de métricas sin procesar para las siguientes métricas: memoria de la instancia, valores atípicos de lectura y escritura del esquema, rendimiento del esquema, uso de memoria, valores atípicos del recuento de registros del esquema, memoria usada total del servicio, tamaño de memoria del almacén de filas, conexiones inactivas y en ejecución del sistema, memoria de conexión y del almacén de filas, registros totales del esquema y el tamaño máximo total estimado del esquema.

    El archivo JSON para este panel es agent-for-sap-hana-performance.json.

Instala paneles

Para instalar un panel personalizado, sigue estos pasos:

Consola de Google Cloud

  1. En la consola de Google Cloud, ve a la página Monitoring.

    Ir a Monitoring

  2. En el panel de navegación de Monitoring, haz clic en Paneles.

  3. Haz clic en la pestaña Biblioteca de muestra.

    Se muestra la pestaña de la biblioteca de muestra seleccionada.

  4. Para filtrar los paneles personalizados específicos del agente, en el campo Filtro, escribe Agent for SAP.

  5. (Opcional) Para ver los detalles sobre un panel o la vista previa de su contenido, haz clic en Vista previa.

  6. Selecciona el panel que deseas instalar.

  7. Haz clic en Importar y, luego, en Confirmar.

    El panel se agrega a los paneles disponibles en tu proyecto de Google Cloud. Para ver tu panel, sigue las instrucciones en Visualiza el panel instalado.

Google Cloud CLI

  1. Abre Cloud Shell:

    Abra Cloud Shell

  2. En Cloud Shell, clona o descarga el repositorio:

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

  3. En Cloud Shell, instala el panel necesario con el archivo JSON correspondiente:

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

    Reemplaza CONFIG_FROM_FILE por la ruta de acceso al archivo JSON que contiene la configuración del panel. Los archivos de configuración del panel se pueden ubicar en la ruta: monitoring-dashboard-samples/dashboards/google-cloud-agent-for-sap.

    El panel se agrega a los paneles disponibles en tu proyecto de Google Cloud. Para ver tu panel, sigue las instrucciones en Visualiza el panel instalado.

Visualiza los paneles instalados

Para ver los paneles instalados, sigue estos pasos:

  1. En la consola de Google Cloud, ve a la página Monitoring.

    Ir a Monitoring

  2. En el panel de navegación de Monitoring, haz clic en Paneles.

  3. Haz clic en el nombre del panel de la lista.

Si tienes muchos paneles, puedes filtrar los paneles personalizados o el nombre del panel nuevo. Si deseas obtener información para filtrar esta lista, consulta Visualiza paneles personalizados.

La siguiente imagen es un ejemplo que muestra una parte del panel personalizado para las métricas de SAP HANA en Monitoring.

La captura de pantalla muestra el panel personalizado para las métricas de SAP HANA en Monitoring