Aerospike

このドキュメントでは、Google Cloud Managed Service for Prometheus を使用して Aerospike から指標を収集できるように、Google Kubernetes Engine の Deployment を構成する方法について説明します。このドキュメントでは、次の方法について説明します。

  • Aerospike のエクスポータを設定して、指標を報告する。
  • エクスポートされた指標を収集するために、Managed Service for Prometheus の PodMonitoring リソースを構成する。
  • Cloud Monitoring のダッシュボードにアクセスして指標を表示する。
  • 指標をモニタリングするようにアラートルールを構成する。

以下の手順は、Managed Service for Prometheus でマネージド コレクションを使用している場合にのみ適用されます。セルフデプロイ コレクションを使用している場合は、Aerospike エクスポータのソース リポジトリでインストール情報をご覧ください。

以下の手順は一例であり、ほとんどの Kubernetes 環境で機能します。セキュリティ ポリシーや組織のポリシーの制限により、アプリケーションやエクスポータのインストールに問題がある場合は、オープンソース ドキュメントでサポートを確認することをおすすめします。

Aerospike の詳細については、Aerospike をご覧ください。

前提条件

Managed Service for Prometheus とマネージド コレクションを使用して Aerospike から指標を収集するには、デプロイが次の要件を満たしている必要があります。

  • クラスタで Google Kubernetes Engine バージョン 1.21.4-gke.300 以降を実行している必要があります。
  • マネージド コレクションを有効にして、Managed Service for Prometheus を実行する必要があります。詳細については、マネージド コレクションを使ってみるをご覧ください。

  • Aerospike とのインテグレーションに Cloud Monitoring で利用可能なダッシュボードを使用するには、aerospike-prometheus-exporter バージョン 1.8.0 以降を使用する必要があります。

    利用可能なダッシュボードの詳細については、ダッシュボードを表示するをご覧ください。

Aerospike エクスポータをインストールする

Aerospike エクスポータ aerospike-prometheus-exporter をサイドカーとして Aerospike ワークロードにインストールすることをおすすめします。サイドカーの使用方法については、マルチコンテナ Pod を使用した Kubernetes での拡張アプリケーションをご覧ください。

aerospike-prometheus-exporter をサイドカーとして Aerospike にインストールするには、次の例に示すように Aerospike 構成を変更します。

# 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"

+ 記号で始まるすべての行を構成に追加する必要があります。

以下の手順では、稼働している Aerospike がすでに存在し、それをエクスポータを含むように変更することを前提としています。Aerospike の設定については、Aerospike オペレーターのドキュメントをご覧ください。

構成の変更をローカル ファイルから適用するには、次のコマンドを実行します。

kubectl apply -n NAMESPACE_NAME -f FILE_NAME

Terraform を使用して構成を管理することもできます。

PodMonitoring リソースを定義する

ターゲット ディスカバリの場合、Managed Service for Prometheus Operator には、同じ Namespace 内の Aerospike エクスポータに対応する PodMonitoring リソースが必要です。

次の PodMonitoring 構成を使用できます。

# 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

ラベルセレクタとポートが、Aerospike エクスポータをインストールするで使用されているセレクタとポートと一致していることを確認します。

構成の変更をローカル ファイルから適用するには、次のコマンドを実行します。

kubectl apply -n NAMESPACE_NAME -f FILE_NAME

Terraform を使用して構成を管理することもできます。

ルールとアラートを定義する

次の Rules 構成を使用して、Aerospike 指標に関するアラートを定義できます。

# 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

構成の変更をローカル ファイルから適用するには、次のコマンドを実行します。

kubectl apply -n NAMESPACE_NAME -f FILE_NAME

Terraform を使用して構成を管理することもできます。

ルールをクラスタに適用する方法については、マネージド ルールの評価とアラートをご覧ください。

アラートのしきい値は、アプリケーションに合わせて調整できます。

構成を確認する

Metrics Explorer を使用すると、Aerospike エクスポータが正しく構成されていることを確認できます。Cloud Monitoring が指標を取り込むまでに 1~2 分かかる場合があります。

指標が取り込まれていることを確認する手順は次のとおりです。

  1. Google Cloud コンソールのナビゲーション パネルで [Monitoring] を選択し、次に [ Metrics Explorer] を選択します。

    Metrics Explorer に移動

  2. クエリビルダー ペインのツールバーで、[MQL] または [PROMQL] という名前のボタンを選択します。
  3. [言語] で [PromQL] が選択されていることを確認します。言語切り替えボタンは、クエリの書式設定と同じツールバーにあります。
  4. 次のクエリを入力して実行します。
    up{job="aerospike", cluster="CLUSTER_NAME", namespace="NAMESPACE_NAME"}

ダッシュボードを表示する

Cloud Monitoring インテグレーションには、Aerospike Prometheus の概要ダッシュボードが含まれています。ダッシュボードは、インテグレーションを構成すると自動的にインストールされます。インテグレーションをインストールすることなく、ダッシュボードの静的プレビューを表示することもできます。

インストールされているダッシュボードを表示する手順は次のとおりです。

  1. Google Cloud コンソールのナビゲーション パネルで、[Monitoring] を選択してから、[ダッシュボード] を選択します。

    [ダッシュボード] に移動

  2. [ダッシュボード リスト] タブを選択します。
  3. [統合] カテゴリを選択します。
  4. ダッシュボードの名前(Aerospike Prometheus Overview など)をクリックします。

ダッシュボードの静的プレビューを表示する手順は次のとおりです。

  1. Google Cloud コンソールのナビゲーション パネルで、[Monitoring] を選択してから、[インテグレーション] を選択します。

    [インテグレーション] に移動

  2. [デプロイメント プラットフォーム] フィルタの [Kubernetes Engine] をクリックします。
  3. Aerospike インテグレーションを見つけ、[詳細を表示] をクリックします。
  4. [ダッシュボード] タブを選択します。

トラブルシューティング

指標の取り込みに関する問題のトラブルシューティングについては、取り込み側の問題のトラブルシューティングエクスポータからの収集に関する問題をご覧ください。