SAP HANA® integration for Grafana Cloud

Before you begin

In order for the integration to work properly, you must set up the SUSE hanadb exporter on your primary host.

Using the example config, metrics will be available on port 9668 by default.

Once deployed, Grafana Alloy will be able to scrape the endpoint.

Install SAP HANA® integration for Grafana Cloud

1. In your Grafana Cloud stack, click Connections in the left-hand menu.
2. Find SAP HANA® and click its tile to open the integration.
3. Review the prerequisites in the Configuration Details tab and set up Grafana Agent to send SAP HANA® metrics and logs to your Grafana Cloud instance.
4. Click Install to add this integration’s pre-built dashboards and alerts to your Grafana Cloud instance, and you can start monitoring your SAP HANA® setup.

Configuration snippets for Grafana Alloy

Simple mode

These snippets are configured to scrape a single SAP HANA® instance running locally with default ports.

First, manually copy and append the following snippets into your alloy configuration file.

Metrics snippets

river Copy

discovery.relabel "metrics_integrations_integrations_sap_hana" {
	targets = [{
		__address__ = "localhost:9668",
	}]

	rule {
		target_label = "instance"
		replacement  = constants.hostname
	}
}

prometheus.scrape "metrics_integrations_integrations_sap_hana" {
	targets      = discovery.relabel.metrics_integrations_integrations_sap_hana.output
	forward_to   = [prometheus.remote_write.metrics_service.receiver]
	job_name     = "integrations/sap-hana"
	metrics_path = "/"
}

Logs snippets

linux

river Copy

local.file_match "logs_integrations_integrations_sap_hana" {
	path_targets = [{
		__address__ = "localhost",
		__path__    = "/opt/hana/shared/*/HDB*/*/trace/*.trc",
		instance    = constants.hostname,
	}]
}

loki.source.file "logs_integrations_integrations_sap_hana" {
	targets    = local.file_match.logs_integrations_integrations_sap_hana.targets
	forward_to = [loki.write.grafana_cloud_loki.receiver]
}

Advanced mode

The following snippets provide examples to guide you through the configuration process.

To instruct Grafana Alloy to scrape your SAP HANA® instances, manually copy and append the snippets to your alloy configuration file, then follow subsequent instructions.

Advanced metrics snippets

river Copy

discovery.relabel "metrics_integrations_integrations_sap_hana" {
	targets = [{
		__address__ = "localhost:9668",
	}]

	rule {
		target_label = "instance"
		replacement  = constants.hostname
	}
}

prometheus.scrape "metrics_integrations_integrations_sap_hana" {
	targets      = discovery.relabel.metrics_integrations_integrations_sap_hana.output
	forward_to   = [prometheus.remote_write.metrics_service.receiver]
	job_name     = "integrations/sap-hana"
	metrics_path = "/"
}

To monitor your SAP HANA® instance, you must use a discovery.relabel component to discover your SAP HANA® Prometheus endpoint and apply appropriate labels, followed by a prometheus.scrape component to scrape it.

Configure the following properties within each discovery.relabel component:

• __address__: The address to your SAP HANA® Prometheus metrics endpoint.
• instance label: constants.hostname sets the instance label to your Grafana Alloy server hostname. If that is not suitable, change it to a value uniquely identifies this SAP HANA® instance. Make sure this label value is the same for all telemetry data collected for this instance.

If you have multiple SAP HANA® servers to scrape, configure one discovery.relabel for each and scrape them by including each under targets within the prometheus.scrape component.

Advanced logs snippets

linux

river Copy

local.file_match "logs_integrations_integrations_sap_hana" {
	path_targets = [{
		__address__ = "localhost",
		__path__    = "/opt/hana/shared/*/HDB*/*/trace/*.trc",
		instance    = constants.hostname,
	}]
}

loki.source.file "logs_integrations_integrations_sap_hana" {
	targets    = local.file_match.logs_integrations_integrations_sap_hana.targets
	forward_to = [loki.write.grafana_cloud_loki.receiver]
}

To monitor your SAP HANA® instance logs, you will use a combination of the following components:

• local.file_match defines where to find the log file to be scraped. Change the following properties according to your environment:

  • __address__: The SAP HANA® instance address
  • __path__: Select which trace files you would like to include with a path like .../trace/{filename.trc, nameserver*.trc, ...}. You can also set __path_exclude__ patterns.
  • instance label: constants.hostname sets the instance label to your Grafana Alloy server hostname. If that is not suitable, change it to a value uniquely identifies this SAP HANA® instance. Make sure this label value is the same for all telemetry data collected for this instance.

• loki.source.file sends logs to Loki.

On linux, you must add the alloy user to the sapsys group with sudo usermod -a -G sapsys alloy

Verify that the /opt/hana/shared/<sid>/HDB<insnr> directory has read permission for the sapsys group (with ls -la, or set with chmod g+r HDB<insnr>)

Ensure that the path from that directory to each trace log you are monitoring also has read permission set for the sapsys group

If you have issues with setting permissions, contact your system administrator or run the Grafana Agent as the root user.

Before you begin

In order for the integration to work properly, you must set up the SUSE hanadb exporter on your primary host.

Using the example config, metrics will be available on port 9668 by default.

Once deployed, the Grafana Agent will be able to scrape the endpoint.

Install SAP HANA® integration for Grafana Cloud

1. In your Grafana Cloud stack, click Connections in the left-hand menu.
2. Find SAP HANA® and click its tile to open the integration.
3. Review the prerequisites in the Configuration Details tab and set up Grafana Agent to send SAP HANA® metrics and logs to your Grafana Cloud instance.
4. Click Install to add this integration’s pre-built dashboards and alerts to your Grafana Cloud instance, and you can start monitoring your SAP HANA® setup.

Post-install configuration for the SAP HANA® integration

After enabling the metrics generation, instruct the Grafana Agent to scrape your SAP HANA system.

Make sure to change targets in the snippet according to your environment.

Select which trace files you would like to include with a path like .../trace/{filename.trc, nameserver*.trc, ...} or add a __path_exclude__ label (documentation)

yaml Copy

metrics:
  configs:
    - scrape_configs:
      - job_name: integrations/sap-hana
        metrics_path: "/"
        static_configs:
          - targets: ['<host-name>:<exporter-port>']
logs:
  configs:
    scrape_configs:
      - job_name: integrations/sap-hana
        static_configs:
          - targets: [localhost]
            labels:
              __path__: /opt/hana/shared/*/HDB*/*/trace/*.trc

You should ensure that the user you are running the Grafana Agent with has permissions to access your trace files.
To do this:

• The default user that the Grafana Agent runs with is grafana-agent, you can change the user in /usr/lib/systemd/system/grafana-agent.service
• For this change to take effect, run sudo systemctl daemon-reload and sudo systemctl restart grafana-agent
• Add the grafana-agent user to the sapsys group with sudo usermod -a -G sapsys grafana-agent
• Verify that the /opt/hana/shared/<sid>/HDB<insnr> directory has read permission for the sapsys group (with ls -la, or set with chmod g+r HDB<insnr>)
• Ensure that the path from that directory to each trace log you are monitoring also has read permission set for the sapsys group
• If you have issues with setting permissions, contact your system administrator or run the Grafana Agent as the root user.

Configuration snippets for Grafana Agent

Below metrics.configs.scrape_configs, insert the following lines and change the URLs according to your environment:

yaml Copy

    - job_name: integrations/sap-hana
      metrics_path: "/"
      relabel_configs:
        - replacement: '<your-instance-name>'
          target_label: instance
      static_configs:
        - targets: ['localhost:9668']

Below logs.configs.scrape_configs, insert the following lines according to your environment.

yaml Copy

    - job_name: integrations/sap-hana
      static_configs:
        - targets: [localhost]
          labels:
            __path__: /opt/hana/shared/*/HDB*/*/trace/*.trc
            instance: '<your-instance-name>'

Full example configuration for Grafana Agent

Refer to the following Grafana Agent configuration for a complete example that contains all the snippets used for the SAP HANA® integration. This example also includes metrics that are sent to monitor your Grafana Agent instance.

yaml Copy

integrations:
  prometheus_remote_write:
  - basic_auth:
      password: <your_prom_pass>
      username: <your_prom_user>
    url: <your_prom_url>
  agent:
    enabled: true
    relabel_configs:
    - action: replace
      source_labels:
      - agent_hostname
      target_label: instance
    - action: replace
      target_label: job
      replacement: "integrations/agent-check"
    metric_relabel_configs:
    - action: keep
      regex: (prometheus_target_sync_length_seconds_sum|prometheus_target_scrapes_.*|prometheus_target_interval.*|prometheus_sd_discovered_targets|agent_build.*|agent_wal_samples_appended_total|process_start_time_seconds)
      source_labels:
      - __name__
  # Add here any snippet that belongs to the `integrations` section.
  # For a correct indentation, paste snippets copied from Grafana Cloud at the beginning of the line.
logs:
  configs:
  - clients:
    - basic_auth:
        password: <your_loki_pass>
        username: <your_loki_user>
      url: <your_loki_url>
    name: integrations
    positions:
      filename: /tmp/positions.yaml
    scrape_configs:
      # Add here any snippet that belongs to the `logs.configs.scrape_configs` section.
      # For a correct indentation, paste snippets copied from Grafana Cloud at the beginning of the line.
    - job_name: integrations/sap-hana
      static_configs:
        - targets: [localhost]
          labels:
            __path__: /opt/hana/shared/*/HDB*/*/trace/*.trc
            instance: '<your-instance-name>'
metrics:
  configs:
  - name: integrations
    remote_write:
    - basic_auth:
        password: <your_prom_pass>
        username: <your_prom_user>
      url: <your_prom_url>
    scrape_configs:
      # Add here any snippet that belongs to the `metrics.configs.scrape_configs` section.
      # For a correct indentation, paste snippets copied from Grafana Cloud at the beginning of the line.
    - job_name: integrations/sap-hana
      metrics_path: "/"
      relabel_configs:
        - replacement: '<your-instance-name>'
          target_label: instance
      static_configs:
        - targets: ['localhost:9668']
  global:
    scrape_interval: 60s
  wal_directory: /tmp/grafana-agent-wal