TUTORIAL チュートリアル
07. KandaSearchの運用機能
このページの項目
KandaSearchでは、検索エンジンの運用を支援するための便利な機能をご用意しています。
バックアップとリストア
インデックスや各種ファイルを手動または自動でバックアップできます。また、バックアップしたデータからのリストアも可能です。
バックアップで利用可能なストレージ容量はご利用プランにより異なります。詳しくは各プランの仕様をご確認ください。
最初はバックアップについての説明です。
手動でバックアップを行うには、プロジェクトビューの左サイドから「バックアップ」を選択し、バックアップ画面の「今すぐバックアップを取る」をクリックします。
バックアップ名を指定し、インスタンスを選択します。
バックアップの種類で「インデックスバックアップ」を選択したときは、バックアップ対象のコレクションを選択します。
「ファイルバックアップ」を選択したときは「含まれるファイル」「（含まれるファイルから）除外されたファイル」でそれぞれの対象ファイル名を指定後、必ず「プレビュー更新」をクリックしてください。
対象を絞り込むことでストレージの使用量を節約できます。
それぞれの指定が完了したら「バックアップを作成する」をクリックします。
定期的にバックアップを取りたい場合は「定期バックアップのスケジュールを追加する」をクリックします。前述の手動バックアップ時に指定する項目に加え、バックアップスケジュールとバックアップ保存数を指定します。
それぞれの指定が完了したら「定期バックアップを作成する」をクリックします。
定期バックアップの設定内容は、「定期バックアップ」タブをクリックし、表示された一覧の対象行の編集（鉛筆マーク）アイコンから変更できます。また、削除（ごみ箱マーク）アイコンから削除できます。
重要
バックアップに使用するストレージ容量がご利用プランの上限を超えた場合は、超えた分が従量課金としてご請求金額に加算されますのでご注意ください。
次はリストア（復元）についての説明です。
リストアを行う場合は、リストアに使用するバックアップデータをバックアップ一覧から探し出して、その行の右端の「アクション」をクリックし「復元」を選択します。復元が始まります。
復元の準備作業が開始されると取り消しはできません。
また、復元時は、復元先の指定を間違えないようにご注意ください。
次に、プロジェクトビューの左サイドから「復元」を選択し、状況を確認します。「状態」が「復元完了」と表示されていれば復元が完了しています。
不要になったバックアップを削除すると、ストレージの使用量を削減できます。
バックアップを削除する場合は、「バックアップ」画面のバックアップ一覧から不要になったバックアップを探し出して、その行の右端の「アクション」をクリックし「削除」を選択します。
重要
Apache Solrインスタンスを削除するとバックアップデータも削除されますので、必要に応じてダウンロードを行ってください。
ヘルスチェック
KandaSearchは、Apache SolrのPING機能を使ってインスタンスを監視し、障害が発生した時に、ユーザーが指定した方法で通知を行います。
ヘルスチェックの設定を行うには、インスタンスビューの左サイドから「ヘルスチェック」を選択します。
「監視設定」が定義されていないときは、チェック間隔、再通知間隔、チェック方式を指定後、「設定を保存する」をクリックします。設定した条件で監視が始まり、「ステータス」欄にステータスと更新日時が表示されます。「今すぐチェック」をクリックすると直ちにステータスチェックが行われ表示内容が更新されます。
監視を止める場合は、「モニタリング OFF/ON」でスイッチを左側にスライドさせます。
監視条件を変更する場合は、チェック間隔などの各項目を変更後、「設定を保存する」をクリックしてください。
続いて、通知設定を行います。
「＋ 通知方法を追加する」をクリックします。
通知方式として、「eメール」と「slackなどのWebhook」を利用（両方同時に利用可能）できます。
eメールによる通知を行う場合は、「EMAIL」タブにて、プロジェクトメンバーやメールアドレス（eメールアドレスは入力後、「＋」アイコンを必ずクリックしてください）、メールの件名、メール本文を指定して、「確認」をクリックします。
件名や本文欄はプレースホルダー式となっていて、任意の位置にアイテムをドラッグ＆ドロップすることでカスタマイズができるようになっています。
「現在のユーザーにテストメールを送信する」をクリックするとテストメールを送信できます。
Webhookによる通知を行う場合は、「WEBHOOK」タブにて、Webhook URLを入力後、Webhookメッセージを指定して、「確認」をクリックします。
Webhookメッセージ欄は、eメール方式と同様にプレースホルダー式となっていて、任意の位置にアイテムをドラッグ＆ドロップすることでカスタマイズができるようになっています。
「テスト WEBHOOK メッセージを送信する」をクリックするとテストWebhookを送信できます。
通知設定は、各方式で複数の作成が可能です。 通知設定の一覧中の対象行で、編集（鉛筆マーク）アイコンから変更が、削除（ごみ箱マーク）アイコンから削除ができます。
モニタリング
「モニタリング」機能とは、サーバーのリソース状況をKandaSearchシステムが保持することで、KandaSearchの管理画面からサーバーのリソース状況をいつでも確認できる機能です。
モニタリングは、インスタンスの作成時に自動的に開始されます。
モニタリングを利用するには、インスタンスビューの左サイドメニューから「モニタリング」を選択します。
モニタリング対象は、CPU使用率（％）、メモリ使用量（％）、ディスクの使用状況（％）です。
モニタリング画面内では、以下の指定が可能です。
- 表示データの「期間」「終了日時」を指定できます。例えば、「終了日時」に「2023/10/13 15:00」、「期間」に「1時間」を指定すると、2023/10/13 14:00から2023/10/13 15:00までの15秒間隔のデータが表示されます。
- 表示形式は「グラフ」、「データ」のいずれかを指定できます。各表示形式のボタンをクリックして指定してください。
- 「リフレッシュレート」で間隔時間を指定すると、指定間隔で表示が自動更新されます。
- 「データのダウンロード」をクリックすると、表示データのダウンロードができます。
- グラフ上部の「CPU」「RAM」「ディスクの使用状況」をクリックすると、グラフ内の当該ラインの非表示/表示をコントロールできます。
ウイルスチェック
KandaSearchでは、インスタンスビューの左サイドの「設定」において「ウイルススキャン」をONにすることで、インスタンスのSolrディレクトリ配下のファイルに対しウイルスチェックを行いウイルスを駆除する機能を有しています。ご利用いただくためには、ウイルススキャンが利用可能なプランのインスタンスをご契約いただく必要があります。
ウイルスチェックを実施することで、より安全にKandaSearchをご利用いただけます。
昨今では、企業が求めるITセキュリティのレベルが上がり、あらゆるサーバー上のセキュリティ対策の実施を要件とするシステム開発も多く見られるようになりました。そのような仕様に合致させる必要がある場合には、このウイルスチェック機能のご利用をご検討ください。
IPアドレス許可設定
インターネット側からKandaSearchのインスタンスにアクセスするには、接続元サーバー、パソコンなどのIPアドレスを、事前に登録しておく必要があります。
これにより、検索エンジンへの第三者からのアクセスをブロックし、安心してKandaSearchをご利用いただけるようになっています。
IPアドレスの許可設定を行うには、インスタンスビューの左サイドの「設定」を選択し、「許可されたIPアドレス範囲」の「＋ IPアドレス範囲を追加する」をクリックし、IPアドレスを登録します。
IPアドレスはCIDR表記で指定します。IPアドレスはIPv4に対応しています。
なお、登録可能な範囲セットは最大4つです。
なお、現在操作しているパソコンのIPアドレスを登録する場合は、「IPアドレス範囲の追加」画面で「IPアドレスを検出する」をクリックし、IPアドレスが表示されるのを待ってから「保存」をクリックします。
前の画面に戻ったら「更新」をクリックします。更新が反映されるまで数分程度かかる場合があります。
登録が完了したら、パソコンの場合は、ブラウザからSolr Admin URLにアクセスできることを確認します。
サーバーの場合は、curlコマンドを使って検索APIなどを実行し正常レスポンスが返ってくることを確認します。数分経過後も ”302 Found” が返ってくる場合は、IPアドレスが間違っている可能性があります。
スタンドアロンとSolrCloud
KandaSearchで利用可能なApache Solrの構成には、スタンドアロン構成とSolrCloud構成の2種類があります。
1つの検索システムについて、スタンドアロン構成では、Apache Solrがサーバーマシン1台から構成されているのに対し、SolrCloud構成では複数台のサーバーから構成されます。
最もシンプルなSolrCloudの使い方として、4台のノード（サーバー）が利用できるときに、インデックスを4つのシャード（Shard：1つのインデックスを担当するSorコアのこと）に分けるといった例が考えられます。そうすることで検索処理による1ノードごとのサーバーの負荷を小さくし、検索速度を向上させることができます。 さらには、サーバー間でインデックスを多重化すれば高可用性が実現されます。サーバーが1台ダウンしたときにも検索システム全体における正常動作を保ったり、サーバーを１台止めてメンテナンスを行ったりすることが可能になるのです。 企業でApache Solrを導入する場合は、このSolrCloud構成を採用するがよく行われます。
このように高機能・高性能なSolrCloudですが、SolrCloudを自前の環境に構築する場合、サーバーOSのインストール、セキュリティ設定、ネットワーク設定から始まり、Apache SolrやZooKeeperを必要台数分インストールし、コレクションを作成するなどの数多くの作業を行う必要があり、SolrCloud構築作業は難易度の高い手間のかかる作業となります。
しかしながら、KandaSearchを利用すれば、このSolrCloud構成のApache Solrを簡単に構築することができます。
KandaSearchにおける、SolrCloudの構築の流れは次の通りです。
１．SolrCloud用にプロジェクトを作成する
SolrCloud用に新しいプロジェクトを作成します。既存のプロジェクトに追加する場合はプロジェクトの作成は不要です。
２．SolrCloudのインスタンスを作成する
１で作成したプロジェクトに、SolrCloudのインスタンスを作成します。
インスタンス作成時のポイントは次の通りです。
- インスタンスタイプで「SolrCloudタイプ」を選択する。
- インスタンスノード数は2以上とする。 なお、SolrCloudのインスタンス作成にかかる時間は、スタンドアロンの場合に比べて長くなりますので、インスタンスの作成が完了するまでお待ちください。作成状況はインスタンスビューのオーバービューで確認できます。
３．SolrCloudのコレクションを追加する
２で作成したインスタンスに、SolrCloudのコレクションを追加します。
コレクション追加時のポイントは次の通りです。
- シャード数（インデックスの分割数）
- レプリケーションファクター（複製分を含めたシャード数） インスタンスノードが2の時に、シャード数=2、レプリケーションファクター=2と指定してコレクションを追加した場合、検索処理が2台のノードに負荷分散されると同時に、1台のインスタンスが停止しても検索を正しく行えるシステムを構築できます。
上記の指定で構築されるSolrCloudは次のようになります。
それでは、片方のインスタンスノードを停止した場合でも、正常に検索できるか試してみます。
インスタンスビューの「オーバービュー」画面で、「停止」ボタンをクリックし、片方のインスタンスを停止します。
インスタンスビューの左サイドの「検索」をクリックし、検索を行ってみます。
正常に検索結果が返ってきました。
