Elasticsearch へLogstash 経由でNuclia のデータをロードする方法

加藤龍彦
加藤龍彦
デジタルマーケティング
全文検索サービスElasticsearch のETL モジュール「Logstash」とCData JDBC ドライバを使って、Nuclia のデータを簡単にロードする方法をご紹介。



Elasticsearch は、人気の分散型全文検索エンジンです。データを一元的に格納することで、超高速検索や、関連性の細かな調整、パワフルな分析が大規模に、手軽に実行可能になります。Elasticsearch にはデータのローディングを行うパイプラインツール「Logstash」があります。CData Drivers を利用することができるので、30日の無償評価版をダウンロードしてあらゆるデータソースを簡単にElasticsearch に取り込んで検索・分析を行うことができます。

この記事では、CData Driver for API を使って、Nuclia のデータをLogstash 経由でElasticsearch にロードする手順を説明します。

Elasticsearch Logstash でCData JDBC Driver for API を使用

  • CData JDBC Driver for API をLogstash が稼働するマシンにインストールします。
  • 以下のパスにJDBC Driver がインストールされます(2022J の部分はご利用される製品バージョンによって異なります)。後ほどこのパスを使います。この.jar ファイル(製品版の場合は.lic ファイルも)をLogstash に配置します。
    C:\Program Files\CData\CData JDBC Driver for API 2022J\lib\cdata.jdbc.api.jar
  • 次に、Logstash とCData JDBC ドライバをつなぐ、JDBC Input Plugin をインストールします。JDBC Plugin は最新のLogstash だとデフォルトでついてきますが、バージョンによっては追加する必要があります。
    https://www.elastic.co/guide/en/logstash/5.4/plugins-inputs-jdbc.html
  • CData JDBC ドライバの.jar ファイルと.lic ファイルを、Logstashの「/logstash-core/lib/jars/」に移動します。

Logstash でElasticsearch にNuclia のデータを送る

それでは、Logstash でElasticsearch にNuclia のデータの転送を行うための設定ファイルを作成していきます。

  • Logstash のデータ処理定義であるlogstash.conf ファイルにNuclia のデータを取得する処理を書きます。Input はJDBC、Output はElasticsearch にします。データローディングジョブの起動間隔は30秒に設定しています。
  • CData JDBC ドライバの.jar をjdbc driver ライブラリにして、クラス名を設定、Nuclia への接続プロパティをJDBC URL の形でせっていします。JDBC URL ではほかにも詳細な設定を行うことができるので、細かくは製品ドキュメントをご覧ください。
  • API キー認証の設定

    Nuclia は、Knowledge Box のデータにアクセスするために API キー認証を使用します。API キーを取得するには、以下のステップで進めます:

    1. https://nuclia.cloud で Nuclia Cloud Dashboard にログインします
    2. Knowledge Box の設定に移動します
    3. Service Accounts セクションに移動します
    4. 新しいサービスアカウントを作成するか、既存の API キーをコピーします

    API キーを取得したら、以下の接続プロパティを設定します:

    • AuthScheme:APIKey に設定します。
    • APIKey:Nuclia サービスアカウントの API キーに設定します。
    • KbId:Knowledge Box の UUID に設定します。
    • Zone:Nuclia のデプロイゾーンに設定します(例:aws-us-east-2-1)。

    接続文字列の例

    Profile=C:\profiles\Nuclia.apip;AuthScheme=APIKey;APIKey=your_service_account_key;KbId=your_kb_uuid;Zone=aws-us-east-2-1;
    

    Nuclia への接続

    認証を設定すると、Nuclia に接続して、Resources、KnowledgeBox、LabelSets、ProcessingStatus などの利用可能なテーブルからデータをクエリできます。

                input {
                    jdbc {
                        jdbc_driver_library => "../logstash-core/lib/jars/cdata.jdbc.api.jar"
                        jdbc_driver_class => "Java::cdata.jdbc.api.APIDriver"
                        jdbc_connection_string => "jdbc:api:Profile=C:\profiles\Nuclia.apip;AuthScheme=APIKey;APIKey=your_service_account_key;KbId=your_kb_uuid;Zone=aws-us-east-2-1;"
                        jdbc_user => ""
                        jdbc_password => ""
                        schedule => "*/30 * * * * *"
                        statement => "SELECT ,  FROM KnowledgeBox WHERE  = ''"
                    }
                }
    
    
                output {
                    Elasticsearch {
                        index => "api_KnowledgeBox"
                        document_id => "xxxx"
                    }
                }
            

Logstash でNuclia のローディングを実行

それでは作成した「logstash.conf」ファイルを元にLogstash を実行してみます。

        > logstash-7.8.0\bin\logstash -f logstash.conf
    

成功した旨のログが出ます。これでNuclia のデータがElasticsearch にロードされました。

例えばKibana で実際にElasticsearch に転送されたデータを見てみます。

        GET api_KnowledgeBox/_search
        {
            "query": {
                "match_all": {}
            }
        }
    
Elasticsearch にロードされたNuclia のデータをクエリ

データがElasticsearch に格納されていることが確認できました。

Elasticsearch にロードされたNuclia のデータを確認

CData JDBC Driver for API をLogstash で使うことで、Nuclia コネクタとして機能し、簡単にデータをElasticsearch にロードすることができました。ぜひ、30日の無償評価版をお試しください。

はじめる準備はできましたか?

API Driver で Nuclia のライブデータに接続

Nuclia に接続