Apache Nutch インデクサ プラグインをデプロイする

ユーザーにウェブ コンテンツを配信するように Google Cloud Search をセットアップするには、 Apache Nutch(オープンソースのウェブクローラ)用の Google Cloud Search インデクサ プラグインをデプロイします。

ウェブクロールを開始すると、Apache Nutch はウェブをクロールし、インデクサ プラグインを使用して元のバイナリ(またはテキスト)バージョンのドキュメント コンテンツを Google Cloud Search Indexing API にアップロードします。Indexing API は、コンテンツをインデックスに登録し、ユーザーに検索結果を提供します。

重要な考慮事項

システム要件

システム要件
OS Linux のみ:
  • Ubuntu
  • Red Hat Enterprise Linux 5.0
  • SUSE Enterprise Linux 10(64 ビット)
ソフトウェア
  • Apache Nutch バージョン 1.15。インデクサ プラグイン ソフトウェアには、このバージョンの Nutch が含まれています。
  • インデクサ プラグインを実行するコンピュータに Java JRE 1.8 がインストールされている。
Apache Tika ドキュメント タイプ Apache Tika 1.18 でサポートされているドキュメント形式

インデクサ プラグインをデプロイする

次の手順では、インデクサ プラグインをインストールして、指定した URL をクロールして結果を Cloud Search に返すようにコンポーネントを設定する方法について説明します。

前提条件

Cloud Search Apache Nutch インデクサ プラグインをデプロイする前に、Google Cloud Search とデータソースの接続に必要な情報を収集します。

ステップ 1: プラグイン ソフトウェアと Apache Nutch をビルドしてインストールする

  1. GitHub からインデクサ プラグイン リポジトリのクローンを作成します。

    $ git clone https://github.com/google-cloudsearch/apache-nutch-indexer-plugin.git
    $ cd apache-nutch-indexer-plugin
  2. 必要なバージョンのインデクサ プラグインを確認します。

    $ git checkout tags/v1-0.0.5
  3. インデクサ プラグインをビルドします。

    $ mvn package

    インデクサ プラグインをビルドするときにテストをスキップするには、mvn package -DskipTests を使用します。

  4. ダウンロード Apache Nutch 1.15の手順に沿って、Apache Nutch のインストール手順

  5. 手順 2 で作成した target/google-cloudsearch-apache-nutch-indexer-plugin-v1.0.0.5.zip をフォルダに展開します。plugins/indexer-google-cloudsearch フォルダを Apache Nutch インストール プラグイン フォルダ(apache-nutch-1.15/plugins)にコピーします。

ステップ 2: インデクサ プラグインを構成する

Apache Nutch インデックス ツール プラグインを構成するには、plugin-configuration.properties というファイルを作成します。

構成ファイルでは、Google Cloud Search データソースにアクセスするために必要な次のパラメータを指定する必要があります。

設定 パラメータ
データソースの ID api.sourceId = 1234567890abcdef
必須。Google Workspace 管理者がインデクサ プラグインに対して設定した Google Cloud Search ソース ID。
サービス アカウント api.serviceAccountPrivateKeyFile = ./PrivateKey.json
必須。Google Workspace 管理者がインデクサ プラグインのユーザー補助機能用に作成した Google Cloud Search サービス アカウントのキーファイル。

次の例は、必須パラメータを含む構成ファイルの例です。

#
# data source access
api.sourceId=1234567890abcdef
api.serviceAccountPrivateKeyFile=./PrivateKey.json
#

構成ファイルには、インデクサ プラグインの動作を制御する他のパラメータを含めることもできます。プラグインを Cloud Search API にデータを push する方法(defaultAcl.*batch.*)を構成できます。インデクサ プラグインがメタデータと構造化データを自動入力する方法を構成することもできます。

これらのパラメータの説明については、Google 提供のコネクタ パラメータをご覧ください。

ステップ 3: Apache Nutch を構成する

  1. conf/nutch-site.xml を開き、次のパラメータを追加します。

    設定 パラメータ
    プラグインに含まれるもの plugin.includes = text

    必須。使用するプラグインのリスト。少なくとも次の情報が含まれている必要があります。

    • index-basic
    • index-more
    • indexer-google-cloudsearch
    conf/nutch-default.xml にはこのプロパティのデフォルト値を指定しますが、これに indexer-google-cloudsearch を手動で追加する必要があります。
    メタタグ名 metatags.names = text

    省略可。対応するデータソースのスキーマ内のプロパティにマッピングされるタグのカンマ区切りのリスト。メタタグに Apache Nutch を設定する方法について詳しくは、Nutch-parse メタタグをご覧ください。

    次の例は、nutch-site.xml に必要な変更を示しています。

    <property>
      <name>plugin.includes</name>
      <value>protocol-(http|httpclient)|urlfilter-regex|index-(basic|more| metadata)|query-(basic|site|url|lang)|indexer-google-cloudsearch|nutch-extensionpoints|parse-(text|html|msexcel|msword|mspowerpoint|pdf|metatags)|summary-basic|scoring-opic|urlnormalizer-(pass|regex|basic)|parse-(html|tika|metatags)|index-(basic|anchor|more|metadata)</value>
    </property>
    
  2. conf/index-writers.xml を開き、次のセクションを追加します。

    <writer id="indexer_google_cloud_search_1" class="org.apache.nutch.indexwriter.gcs.GoogleCloudSearchIndexWriter">
      <parameters>
        <param name="gcs.config.file" value="path/to/sdk-configuration.properties"/>
      </parameters>
      <mapping>
        <copy />
        <rename />
        <remove />
      </mapping>
    </writer>
    

    <writer> セクションには、次のパラメータが含まれています。

    設定 パラメータ
    Google Cloud Search 構成ファイルのパス gcs.config.file = path

    必須。Google Cloud Search 構成ファイルのフル(絶対)パス。

    アップロード形式 gcs.uploadFormat = text

    省略可。インデクサ プラグインがドキュメント コンテンツを Google Cloud Search インデクサ API に push する形式。指定できる値は次のとおりです。

    • raw: インデクサ プラグインは、変換されていない元のドキュメントのコンテンツを push します。
    • text: インデクサ プラグインは、抽出されたテキスト コンテンツを push します。デフォルト値は raw です。

ステップ 4: ウェブクロールを設定する

ウェブクロールを開始する前に、組織が検索結果で利用できるようにしたい情報のみを含むようにクロールを設定します。このセクションでは、概要について説明します。ウェブクロールの設定方法について詳しくは、Nutch のチュートリアルをご覧ください。

  1. 開始 URL を設定します。

    開始 URL では、Apache Nutch ウェブクローラがコンテンツのクロールを開始する場所を制御します。ウェブクローラがリンクをたどって、特定のクロールに含めるすべてのコンテンツにウェブクローラがアクセスできるようにする必要があります。開始 URL は必須です。

    開始 URL を設定するには:

    1. 作業ディレクトリを nutch インストール ディレクトリに移動します。

      $ cd ~/nutch/apache-nutch-X.Y/
    2. URL のディレクトリを作成します。

      $ mkdir urls
    3. seed.txt という名前のファイルを作成し、ファイル内の URL を 1 行に 1 つずつ入力します。

  2. フォロー ルールと禁止ルールを設定する。

    「対象にする URL」ルールでは、クロールして Google Cloud Search インデックスに登録する URL を制御します。ウェブクローラは、次の URL ルールに照らして URL をチェックします。これらのルールに適合した URL のみがクロールされて、インデックスに登録されます。

    「除外する」ルールでは、クロールと Google Cloud Search インデックスへの登録から URL を除外します。クロールしないパターンが URL に含まれている場合、ウェブクローラはその URL をクロールしません。

    「対象にする URL」ルールと「除外する URL」ルールを設定するには:

    1. 作業ディレクトリを nutch インストール ディレクトリに移動します。

      $ cd ~/nutch/apache-nutch-X.Y/
    2. conf/regex-urlfilter.txt を編集して、フォロー/フォローしないルールを変更できます。\

      $ nano conf/regex-urlfilter.txt
    3. 次の例に示すように、URL パターンと拡張子を指定するには、「+」または「-」で始まる正規表現を入力します。自由形式の式を使用できます。

      # skip file extensions
      -\.(gif|GIF|jpg|JPG|png|PNG|ico)
      
      # skip protocols (file: ftp: and mailto:)
          -^(file|ftp|mailto):
      
      # allow urls starting with https://support.google.com/gsa/
      +^https://support.google.com/gsa/
      
      # accept anything else
      # (commented out due to the single url-prefix allowed above)
      #+.
      
  3. クロール スクリプトを編集します。

    gcs.uploadFormat パラメータが存在しないか「raw」に設定されている場合は、-addBinaryContent -base64 コマンドを追加して nutch index コマンドに渡す必要があります。これらの引数は、インデクサ プラグインを呼び出すときに Base64 でバイナリ コンテンツを含めるように Nutch Indexer モジュールに指示します。デフォルトでは、./bin/crawl スクリプトにこれらの引数はありません。

    1. apache-nutch-1.15/bincrawl スクリプトを開きます。
    2. 次の例のように、スクリプトに -addBinaryContent -base64 オプションを追加します。

            if $INDEXFLAG; then
                echo "Indexing $SEGMENT to index"
                __bin_nutch index $JAVA_PROPERTIES "$CRAWL_PATH"/crawldb -addBinaryContent -base64 -linkdb "$CRAWL_PATH"/linkdb "$CRAWL_PATH"/segments/$SEGMENT
      
                echo "Cleaning up index if possible"
                __bin_nutch clean $JAVA_PROPERTIES "$CRAWL_PATH"/crawldb
            else
                echo "Skipping indexing ..."
      

ステップ 5: ウェブクロールとコンテンツ アップロードを開始する

インデクサ プラグインをインストールして設定すると、ローカルモードで単独で実行できます。./bin のスクリプトを使用して、クロールジョブや個々の Nutch コマンドを実行します。

次の例では、必要なコンポーネントがローカル ディレクトリにあることを前提としています。apache-nutch-1.15 ディレクトリで次のコマンドを使用して Nutch を実行します。

$ bin/crawl -i -s urls/ crawl-test/ 5

クロールログは、標準出力(ターミナル)または logs/ ディレクトリで確認できます。ロギング出力を送信する場合や、より詳細なロギングを行う場合は、conf/log4j.properties を編集します。