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

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

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

Elasticsearch Logstash でCData JDBC Driver for Suadeo を使用

• CData JDBC Driver for Suadeo をLogstash が稼働するマシンにインストールします。
• 以下のパスにJDBC Driver がインストールされます（2022J の部分はご利用される製品バージョンによって異なります）。後ほどこのパスを使います。この.jar ファイル（製品版の場合は.lic ファイルも）をLogstash に配置します。
  C:\Program Files\CData\CData JDBC Driver for Suadeo 2022J\lib\cdata.jdbc.suadeo.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 にSuadeo のデータを送る

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

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

ドライバーはOAuth 2.0 のリソースオーナーパスワードクレデンシャル（ROPC）グラントを使用してSuadeo に認証します。認証は直接資格情報を使用して行われます。ブラウザーベースの認証フローやリフレッシュトークンはありません。

以下の接続プロパティを設定します：

• URL：Suadeo インスタンスのベースURL。
• User：Suadeo のユーザー名。
• Password：Suadeo のパスワード。
• AuthenticationName：Suadeo インスタンスの認証設定の名前識別子。異なる環境やユースケースに対して異なる認証名を設定できます。

接続すると、ドライバーは資格情報をSuadeo のOAuth トークンエンドポイントに送信してアクセストークンを受け取り、以降のすべてのリクエストに使用します。セッション中に必要に応じて新しいアクセストークンが自動的に取得されます。

            input {
                jdbc {
                    jdbc_driver_library => "../logstash-core/lib/jars/cdata.jdbc.suadeo.jar"
                    jdbc_driver_class => "Java::cdata.jdbc.suadeo.SuadeoDriver"
                    jdbc_connection_string => "jdbc:suadeo:URL=https://mysuadeoinstance;User=username;Password=password;AuthenticationName=your_auth_name;"
                    jdbc_user => ""
                    jdbc_password => ""
                    schedule => "*/30 * * * * *"
                    statement => "SELECT Id, Name FROM Customers WHERE Status = 'Active'"
                }
            }


            output {
                Elasticsearch {
                    index => "suadeo_Customers"
                    document_id => "xxxx"
                }
            }
        

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

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

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

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

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

        GET suadeo_Customers/_search
        {
            "query": {
                "match_all": {}
            }
        }
    

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

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