Apache Solr

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

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

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

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

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

前提条件

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

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

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

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

Solr は JMX をサポートしており、環境変数 ENABLE_REMOTE_JMX_OPTS を true、RMI_PORT をリモート JMX 接続の対象ポートに設定して構成できます。

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

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

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

# 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: v1
kind: ConfigMap
metadata:
  name: solr-exporter
data:
  config.yml: |
    hostPort: 127.0.0.1:9999
---
apiVersion: apps/v1
kind: Deployment
metadata:
  name: solr
spec:
  selector:
    matchLabels:
+     app.kubernetes.io/name: solr
  template:
    metadata:
      labels:
+       app.kubernetes.io/name: solr
    spec:
      containers:
      - name: solr
        image: solr:8.8.2
+       ports:
+       - containerPort: 9999
+         name: jmx
+       env:
+       - name: ENABLE_REMOTE_JMX_OPTS
+         value: "true"
+       - name: RMI_PORT
+         value: "9999"
+     - name: exporter
+       image: bitnami/jmx-exporter:0.17.0
+       ports:
+       - containerPort: 9000
+         name: prometheus
+       command:
+         - java
+         - -jar
+         - jmx_prometheus_httpserver.jar
+       args:
+         - "9000"
+         - /opt/jmx_exporter/config.yml
+       volumeMounts:
+       - mountPath: /opt/jmx_exporter/config.yml
+         subPath: config.yml
+         name: solr-exporter
+     volumes:
+     - name: solr-exporter
+       configMap:
+         name: solr-exporter
+         items:
+         - key: config.yml
+           path: config.yml

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

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

kubectl apply -n NAMESPACE_NAME -f FILE_NAME

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

PodMonitoring リソースを定義する

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

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

# 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: PodMonitoring
metadata:
  name: solr
  labels:
    app.kubernetes.io/name: solr
    app.kubernetes.io/part-of: google-cloud-managed-prometheus
spec:
  endpoints:
  - port: prometheus
    scheme: http
    interval: 30s
    path: /metrics
  selector:
    matchLabels:
      app.kubernetes.io/name: solr

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

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

kubectl apply -n NAMESPACE_NAME -f FILE_NAME

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

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

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

# 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: solr-rules
  labels:
    app.kubernetes.io/component: rules
    app.kubernetes.io/name: solr-rules
    app.kubernetes.io/part-of: google-cloud-managed-prometheus
spec:
  groups:
  - name: solr
    interval: 30s
    rules:
    - alert: SolrHighCacheEvictions
      annotations:
        description: |-
          Solr high cache evictions
            VALUE = {{ $value }}
            LABELS: {{ $labels }}
        summary: Solr high cache evictions (instance {{ $labels.instance }})
      expr: solr_core_evictions > 0
      for: 5m
      labels:
        severity: warning
    - alert: SolrHighRequestCount
      annotations:
        description: |-
          Solr high request count
            VALUE = {{ $value }}
            LABELS: {{ $labels }}
        summary: Solr high request count (instance {{ $labels.instance }})
      expr: solr_core_Count{name="requests"} > 10
      for: 5m
      labels:
        severity: warning
    - alert: SolrHighRequestErrors
      annotations:
        description: |-
          Solr high request errors
            VALUE = {{ $value }}
            LABELS: {{ $labels }}
        summary: Solr high request errors (instance {{ $labels.instance }})
      expr: solr_core_Count{name="errors"} > 0
      for: 5m
      labels:
        severity: warning

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

kubectl apply -n NAMESPACE_NAME -f FILE_NAME

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

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

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

構成を確認する

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

指標が取り込まれていることを確認します。

1. Google Cloud コンソールで、[Metrics Explorer] ページに移動します。

   Metrics Explorer に移動

   検索バーを使用してこのページを検索する場合は、小見出しが [Monitoring] の結果を選択します。

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

   up{job="solr", cluster="CLUSTER_NAME", namespace="NAMESPACE_NAME"}

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

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

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

1. Google Cloud コンソールで [ダッシュボード] ページに移動します。

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

   検索バーを使用してこのページを検索する場合は、小見出しが [Monitoring] の結果を選択します。

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

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

1. Google Cloud コンソールで [インテグレーション] ページに移動します。

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

   検索バーを使用してこのページを検索する場合は、小見出しが [Monitoring] の結果を選択します。

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

トラブルシューティング

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