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

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

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

Elasticsearch Logstash でCData JDBC Driver for Xero WorkflowMax を使用

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

Logstash でElasticsearch にXero WorkflowMax データを送る

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

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

To connect to the WorkflowMax API, obtain an APIKey and AccountKey from Xero. This can only be done by contacting Xero support (https://www.workflowmax.com/contact-us).

After obtaining an API Key and Account Key, set the values in the APIKey and AccountKey connection properties. Once these are set, you are ready to connect.

            
                input {
                    jdbc {
                      jdbc_driver_library => "../logstash-core/lib/jars/cdata.jdbc.xeroworkflowmax.jar"
                      jdbc_driver_class => "Java::cdata.jdbc.xeroworkflowmax.XeroWorkflowMaxDriver"
                      jdbc_connection_string => "jdbc:xeroworkflowmax:APIKey=myApiKey;AccountKey=myAccountKey;"
                      jdbc_user => ""
                      jdbc_password => ""
                      schedule => "*/30 * * * * *"
                      statement => "SELECT Id, Name FROM Clients WHERE Name = 'Cynthia'"
                    }
                  }
                  
                 
                  output {
                    Elasticsearch {
                        index => "xeroworkflowmax_Clients"
                        document_id => "xxxx"
                    }
                  }
            
        

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

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

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

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

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

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

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

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