Console
    Contact Us Start free

    Aerospike

    This document describes how to configure your Google Kubernetes Engine deployment so that you can use Google Cloud Managed Service for Prometheus to collect metrics from Aerospike. This document shows you how to do the following:

    • Set up the exporter for Aerospike to report metrics.
    • Access a dashboard in Cloud Monitoring to view the metrics.
    • Configure alerting rules to monitor the metrics.

    These instructions apply only if you are using managed collection with Managed Service for Prometheus. If you are using self-deployed collection, then see the source repository for the Aerospike exporter for installation information.

    These instructions are provided as an example and are expected to work in most Kubernetes environments. If you are having trouble installing an application or exporter due to restrictive security or organizational policies, then we recommend you consult open-source documentation for support.

    For information about Aerospike, see Aerospike .

    Prerequisites

    To collect metrics from Aerospike by using Managed Service for Prometheus and managed collection, your deployment must meet the following requirements:

    • Your cluster must be running Google Kubernetes Engine version 1.28.15-gke.2475000 or later.
    • You must be running Managed Service for Prometheus with managed collection enabled. For more information, see Get started with managed collection .
    • To use dashboards available in Cloud Monitoring for the Aerospike integration, you must use aerospike-prometheus-exporter version 1.8.0 or later.

      For more information about available dashboards, see View dashboards .

    Install the Aerospike exporter

    We recommend that you install the Aerospike exporter, aerospike-prometheus-exporter , as a sidecar to your Aerospike workload. For information about using sidecars, see Extended applications on Kubernetes with multi-container pods .

    To install aerospike-prometheus-exporter as a sidecar to Aerospike, modify your Aerospike configuration as shown in the following example:

      # Copyright 2022 Google LLC 
 # 
 # Licensed under the Apache License, Version 2.0 (the "License"); 
 # you may not use this file except in compliance with the License. 
 # You may obtain a copy of the License at 
 # 
 #     https://www.apache.org/licenses/LICENSE-2.0 
 # 
 # Unless required by applicable law or agreed to in writing, software 
 # distributed under the License is distributed on an "AS IS" BASIS, 
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 
 # See the License for the specific language governing permissions and 
 # limitations under the License. 
 apiVersion 
 : 
  
 apps 
 / 
 v1 
 kind 
 : 
  
 StatefulSet 
 metadata 
 : 
  
 name 
 : 
  
 aerospike 
  
 labels 
 : 
  
 app 
 . 
 kubernetes 
 . 
 io 
 / 
 name 
 : 
  
 aerospike 
 spec 
 : 
  
 serviceName 
 : 
  
 aerospike 
  
 replicas 
 : 
  
 1 
  
 selector 
 : 
  
 matchLabels 
 : 
 + 
  
 app 
 . 
 kubernetes 
 . 
 io 
 / 
 name 
 : 
  
 aerospike 
  
 template 
 : 
  
 metadata 
 : 
  
 labels 
 : 
 + 
  
 app 
 . 
 kubernetes 
 . 
 io 
 / 
 name 
 : 
  
 aerospike 
  
 spec 
 : 
  
 containers 
 : 
  
 - 
  
 name 
 : 
  
 aerospike 
  
 image 
 : 
  
 aerospike 
 / 
 aerospike 
 - 
 server 
 : 
 6.0 
 . 
 0.2 
  
 ports 
 : 
  
 - 
  
 containerPort 
 : 
  
 3000 
 + 
  
 - 
  
 name 
 : 
  
 aerospike 
 - 
 prometheus 
 - 
 exporter 
 + 
  
 image 
 : 
  
 aerospike 
 / 
 aerospike 
 - 
 prometheus 
 - 
 exporter 
 : 
 1.8 
 . 
 0 
 + 
  
 ports 
 : 
 + 
  
 - 
  
 containerPort 
 : 
  
 9145 
 + 
  
 name 
 : 
  
 prometheus 
 + 
  
 env 
 : 
 + 
  
 - 
  
 name 
 : 
  
 AS_HOST 
 + 
  
 value 
 : 
  
 localhost 
 + 
  
 - 
  
 name 
 : 
  
 AS_PORT 
 + 
  
 value 
 : 
  
 "3000"

    You must add any lines preceded by the + symbol to your configuration.

    These instructions assume you already have a working Aerospike installation and want to modify it to include an exporter. For information about setting up Aerospike, see the Aerospike operator documentation .

    To apply configuration changes from a local file, run the following command:

    kubectl apply -n NAMESPACE_NAME 
-f FILE_NAME

    You can also use Terraform to manage your configurations.

    Define a PodMonitoring resource

    For target discovery, the Managed Service for Prometheus Operator requires a PodMonitoring resource that corresponds to the Aerospike exporter in the same namespace.

    You can use the following PodMonitoring configuration:

      # Copyright 2022 Google LLC 
 # 
 # Licensed under the Apache License, Version 2.0 (the "License"); 
 # you may not use this file except in compliance with the License. 
 # You may obtain a copy of the License at 
 # 
 #     https://www.apache.org/licenses/LICENSE-2.0 
 # 
 # Unless required by applicable law or agreed to in writing, software 
 # distributed under the License is distributed on an "AS IS" BASIS, 
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 
 # See the License for the specific language governing permissions and 
 # limitations under the License. 
 apiVersion 
 : 
  
 monitoring.googleapis.com/v1 
 kind 
 : 
  
 PodMonitoring 
 metadata 
 : 
  
 name 
 : 
  
 aerospike 
  
 labels 
 : 
  
 app.kubernetes.io/name 
 : 
  
 aerospike 
  
 app.kubernetes.io/part-of 
 : 
  
 google-cloud-managed-prometheus 
 spec 
 : 
  
 endpoints 
 : 
  
 - 
  
 port 
 : 
  
 prometheus 
  
 interval 
 : 
  
 30s 
  
 selector 
 : 
  
 matchLabels 
 : 
  
 app.kubernetes.io/name 
 : 
  
 aerospike

    Ensure that the label selectors and the port match the selectors and port used in Install the Aerospike exporter .

    To apply configuration changes from a local file, run the following command:

    kubectl apply -n NAMESPACE_NAME 
-f FILE_NAME

    You can also use Terraform to manage your configurations.

    Define rules and alerts

    You can use the following Rules configuration to define alerts on your Aerospike metrics:

      # Copyright 2023 Google LLC 
 # 
 # Licensed under the Apache License, Version 2.0 (the "License"); 
 # you may not use this file except in compliance with the License. 
 # You may obtain a copy of the License at 
 # 
 #     https://www.apache.org/licenses/LICENSE-2.0 
 # 
 # Unless required by applicable law or agreed to in writing, software 
 # distributed under the License is distributed on an "AS IS" BASIS, 
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 
 # See the License for the specific language governing permissions and 
 # limitations under the License. 
 apiVersion 
 : 
  
 monitoring.googleapis.com/v1 
 kind 
 : 
  
 Rules 
 metadata 
 : 
  
 name 
 : 
  
 aerospike-rules 
  
 labels 
 : 
  
 app.kubernetes.io/component 
 : 
  
 rules 
  
 app.kubernetes.io/name 
 : 
  
 aerospike-rules 
  
 app.kubernetes.io/part-of 
 : 
  
 google-cloud-managed-prometheus 
 spec 
 : 
  
 groups 
 : 
  
 - 
  
 name 
 : 
  
 aerospike 
  
 interval 
 : 
  
 30s 
  
 rules 
 : 
  
 - 
  
 alert 
 : 
  
 AerospikeHighMemoryUtilization 
  
 annotations 
 : 
  
 description 
 : 
  
 |- 
  
 Aerospike high memory utilization 
  
 VALUE = {{ $value }} 
  
 LABELS: {{ $labels }} 
  
 summary 
 : 
  
 Aerospike high memory utilization (instance {{ $labels.instance }}) 
  
 expr 
 : 
  
 aerospike_node_stats_system_free_mem_pct < 5 
  
 for 
 : 
  
 5m 
  
 labels 
 : 
  
 severity 
 : 
  
 critical 
  
 - 
  
 alert 
 : 
  
 AerospikeHighNamespaceDiskUtilization 
  
 annotations 
 : 
  
 description 
 : 
  
 |- 
  
 Aerospike high namespace disk utilization 
  
 VALUE = {{ $value }} 
  
 LABELS: {{ $labels }} 
  
 summary 
 : 
  
 Aerospike high namespace disk utilization (instance {{ $labels.instance }}) 
  
 expr 
 : 
  
 aerospike_namespace_device_available_pct < 5 
  
 for 
 : 
  
 5m 
  
 labels 
 : 
  
 severity 
 : 
  
 warning 
  
 - 
  
 alert 
 : 
  
 AerospikeHighNamespaceMemoryUtilization 
  
 annotations 
 : 
  
 description 
 : 
  
 |- 
  
 Aerospike high namespace memory utilization 
  
 VALUE = {{ $value }} 
  
 LABELS: {{ $labels }} 
  
 summary 
 : 
  
 Aerospike high namespace memory utilization (instance {{ $labels.instance }}) 
  
 expr 
 : 
  
 aerospike_namespace_memory_free_pct < 5 
  
 for 
 : 
  
 5m 
  
 labels 
 : 
  
 severity 
 : 
  
 warning

    To apply configuration changes from a local file, run the following command:

    kubectl apply -n NAMESPACE_NAME 
-f FILE_NAME

    You can also use Terraform to manage your configurations.

    For more information about applying rules to your cluster, see Managed rule evaluation and alerting .

    You can adjust the alert thresholds to suit your application.

    Verify the configuration

    You can use Metrics Explorer to verify that you correctly configured the Aerospike exporter. It might take one or two minutes for Cloud Monitoring to ingest your metrics.

    To verify the metrics are ingested, do the following:

    1. In the Google Cloud console, go to the Metrics explorer page:

      Go to Metrics explorer

      If you use the search bar to find this page, then select the result whose subheading is Monitoring .

    2. In the toolbar of the query-builder pane, select the button whose name is either MQL or PromQL .
    3. Verify that PromQL is selected in the Language toggle. The language toggle is in the same toolbar that lets you format your query.
    4. Enter and run the following query:
      up{job="aerospike", cluster=" CLUSTER_NAME 
", namespace=" NAMESPACE_NAME 
"}

    View dashboards

    The Cloud Monitoring integration includes the Aerospike Prometheus Overview dashboard. Dashboards are automatically installed when you configure the integration. You can also view static previews of dashboards without installing the integration.

    To view an installed dashboard, do the following:

    1. In the Google Cloud console, go to the Dashboards page:

      Go to Dashboards

      If you use the search bar to find this page, then select the result whose subheading is Monitoring .

    2. Select the Dashboard List tab.
    3. Choose the Integrations category.
    4. Click the name of the dashboard, for example, Aerospike Prometheus Overview .

    To view a static preview of the dashboard, do the following:

    1. In the Google Cloud console, go to the Integrations page:

      Go to Integrations

      If you use the search bar to find this page, then select the result whose subheading is Monitoring .

    2. Click the Kubernetes Engine deployment-platform filter.
    3. Locate the Aerospike integration and click View Details .
    4. Select the Dashboards tab.

    Troubleshooting

    For information about troubleshooting metric ingestion problems, see Problems with collection from exporters in Troubleshooting ingestion-side problems .
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: