Aerospike integration for Grafana Cloud

Before you begin

Aerospike

This integration is designed to target clustered Aerospike environments. For best results, namespaces within a single cluster should have unique names.

By default, Aerospike logs to STDERR. To enable log collection for your Aerospike instance, create the /var/log/aerospike directory and modify the logging section of the instance’s aerospike.conf file to send logs to a file. Save these changes and restart Aerospike to begin logging to a file.

• context any instructs Aerospike to capture log messages from all contexts. For a full list of logging contexts, see this documentation.
• info instructs Aerospike to capture log messages of severity level info or higher. Other possible values are critical, warning, debug, and detail.

This example is the recommended configuration for an Aerospike instance, but if your log file path or name differs, modify your configuration accordingly.

Copy

logging {
        file /var/log/aerospike/aerospike.log {
                context any info
        }
}

Certain metrics used in this integration may not appear depending on your Aerospike instance’s configuration (aerospike.conf):

• to monitor disk metrics, one or more namespaces must be configured to use storage-engine device
• to monitor cache metrics, one or more namespace must be configured to use storage-engine device with data-in-memory false

Example namespace configuration:

Copy

namespace test {
        replication-factor 2
        memory-size 1G

        storage-engine device {
                file /opt/aerospike/data/test.data
                filesize 1G
                data-in-memory false
                read-page-cache true
        }
}

Aerospike prometheus exporter

This integration supports metrics and logs from an Aerospike instance. It is configured to work with the Aerospike Prometheus Exporter, which must be installed and configured separately from Grafana Alloy.

To export logs from your Aerospike instance, modify the logging configuration section of ape.toml:

Copy

log_file = "/var/log/aerospike/aerospike.log"
log_level = "info"

Install Aerospike integration for Grafana Cloud

1. In your Grafana Cloud stack, click Connections in the left-hand menu.
2. Find Aerospike and click its tile to open the integration.
3. Review the prerequisites in the Configuration Details tab and set up Grafana Agent to send Aerospike 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 Aerospike setup.

Configuration snippets for Grafana Alloy

Advanced mode

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

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

Advanced metrics snippets

river Copy

prometheus.scrape "metrics_integrations_integrations_aerospike" {
	targets = [{
		__address__       = "<node-hostname>:9145",
		aerospike_cluster = "<as-cluster-name>",
	}]
	forward_to = [prometheus.remote_write.metrics_service.receiver]
	job_name   = "integrations/aerospike"
}

To monitor your Aerospike instance, you must use a discovery.relabel component to discover your Aerospike 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 Aerospike 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 Aerospike instance. Make sure this label value is the same for all telemetry data collected for this instance.
• aerospike_cluster: The aerospike_cluster label to group your Aerospike instances within a cluster. Set the same value for all nodes within your cluster.

If you have multiple Aerospike 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_aerospike" {
	path_targets = [{
		__address__       = "localhost",
		__path__          = "/var/log/aerospike/aerospike.log",
		aerospike_cluster = "<as-cluster-name>",
		instance          = "<node-hostname>:9145",
		job               = "integrations/aerospike",
	}]
}

loki.process "logs_integrations_integrations_aerospike" {
	forward_to = [loki.write.grafana_cloud_loki.receiver]

	stage.multiline {
		firstline     = "\\w{3} \\d{2} \\d{4}"
		max_lines     = 0
		max_wait_time = "3s"
	}

	stage.regex {
		expression = "\\w{3} \\d{2} \\d{4} \\d{2}:\\d{2}:\\d{2} \\w{3}: (?P<level>\\w+) \\((?P<context>\\w+)\\): (?P<trace>\\(\\S+\\))\\s+(?P<message>(?s:.*))$"
	}

	stage.labels {
		values = {
			context = null,
			level   = null,
		}
	}
}

loki.source.file "logs_integrations_integrations_aerospike" {
	targets    = local.file_match.logs_integrations_integrations_aerospike.targets
	forward_to = [loki.process.logs_integrations_integrations_aerospike.receiver]
}

To monitor your Aerospike 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 Aerospike instance address
  • __path__: The path to the log file.
  • 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 Aerospike instance. Make sure this label value is the same for all telemetry data collected for this instance.
  • aerospike_cluster: The aerospike_cluster label to group your Aerospike instances within a cluster. Set the same value for all nodes within your cluster.

• loki.process defines how to process logs before sending it to Loki.

• loki.source.file sends logs to Loki.

Before you begin

Aerospike

This integration is designed to target clustered Aerospike environments. For best results, namespaces within a single cluster should have unique names.

By default, Aerospike logs to STDERR. To enable log collection for your Aerospike instance, create the /var/log/aerospike directory and modify the logging section of the instance’s aerospike.conf file to send logs to a file. Save these changes and restart Aerospike to begin logging to a file.

• context any instructs Aerospike to capture log messages from all contexts. For a full list of logging contexts, see this documentation.
• info instructs Aerospike to capture log messages of severity level info or higher. Other possible values are critical, warning, debug, and detail.

This example is the recommended configuration for an Aerospike instance, but if your log file path or name differs, modify your configuration accordingly.

Copy

logging {
        file /var/log/aerospike/aerospike.log {
                context any info
        }
}

Certain metrics used in this integration may not appear depending on your Aerospike instance’s configuration (aerospike.conf):

• to monitor disk metrics, one or more namespaces must be configured to use storage-engine device
• to monitor cache metrics, one or more namespace must be configured to use storage-engine device with data-in-memory false

Example namespace configuration:

Copy

namespace test {
        replication-factor 2
        memory-size 1G

        storage-engine device {
                file /opt/aerospike/data/test.data
                filesize 1G
                data-in-memory false
                read-page-cache true
        }
}

Aerospike prometheus exporter

This integration supports metrics and logs from an Aerospike instance. It is configured to work with the Aerospike Prometheus Exporter, which must be installed and configured separately from the Grafana Agent.

To export logs from your Aerospike instance, modify the logging configuration section of ape.toml:

Copy

log_file = "/var/log/aerospike/aerospike.log"
log_level = "info"

Install Aerospike integration for Grafana Cloud

1. In your Grafana Cloud stack, click Connections in the left-hand menu.
2. Find Aerospike and click its tile to open the integration.
3. Review the prerequisites in the Configuration Details tab and set up Grafana Agent to send Aerospike 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 Aerospike setup.

Post-install configuration for the Aerospike integration

After enabling the metrics generation, instruct the Grafana Agent to scrape your Aerospike Prometheus Exporter.

If you want to show logs and metrics signals correlated in your dashboards, as a single pane of glass, ensure the following:

• job, aerospike_cluster, and instance label values must match for metrics and logs scrape config in your agent configuration file.
• job label must be set to integrations/aerospike (already configured in the snippets).
• aerospike_cluster label must be set to a value that identifies your Aerospike cluster.
• instance label must be set to a value that uniquely identifies your Aerospike node. Please replace the default hostname value according to your environment - it must be set manually.

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/aerospike
      metrics_path: /metrics
      static_configs:
        - targets: ["<node-hostname>:9145"]
          labels:
            aerospike_cluster: '<as-cluster-name>'

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

yaml Copy

    - job_name: integrations/aerospike
      static_configs:
        - targets: [localhost]
          labels:
            job: integrations/aerospike
            aerospike_cluster: '<as-cluster-name>'
            instance: '<node-hostname>:9145'
            __path__: /var/log/aerospike/aerospike.log
      pipeline_stages:
        - multiline:
            firstline: '\w{3} \d{2} \d{4}'
        - regex:
            expression: '\w{3} \d{2} \d{4} \d{2}:\d{2}:\d{2} \w{3}: (?P<level>\w+) \((?P<context>\w+)\): (?P<trace>\(\S+\))\s+(?P<message>(?s:.*))$'
        - labels:
            level:
            context:

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 Aerospike 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/aerospike
      static_configs:
        - targets: [localhost]
          labels:
            job: integrations/aerospike
            aerospike_cluster: '<as-cluster-name>'
            instance: '<node-hostname>:9145'
            __path__: /var/log/aerospike/aerospike.log
      pipeline_stages:
        - multiline:
            firstline: '\w{3} \d{2} \d{4}'
        - regex:
            expression: '\w{3} \d{2} \d{4} \d{2}:\d{2}:\d{2} \w{3}: (?P<level>\w+) \((?P<context>\w+)\): (?P<trace>\(\S+\))\s+(?P<message>(?s:.*))$'
        - labels:
            level:
            context:
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/aerospike
      metrics_path: /metrics
      static_configs:
        - targets: ["<node-hostname>:9145"]
          labels:
            aerospike_cluster: '<as-cluster-name>'
  global:
    scrape_interval: 60s
  wal_directory: /tmp/grafana-agent-wal