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

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

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

Elasticsearch Logstash でCData JDBC Driver for Xero を使用

• CData JDBC Driver for Xero をLogstash が稼働するマシンにインストールします。
• 以下のパスにJDBC Driver がインストールされます。後ほどこのパスを使います。この.jar ファイルと製品版の場合は.lic ファイルをLogstash に配置して使います。
  C:\Program Files\CData\CData JDBC Driver for Xero 2019J\lib\cdata.jdbc.xero.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 データを送る

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

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

接続には、認証用の値に加えてSchema 接続プロパティを設定してください。Xero はプライベートアプリケーション、 パブリックアプリケーション、パートナーアプリケーションに認証を提供します。設定したアプリケーションに応じて、XeroAppAuthentication プロパティを PUBLIC、PRIVATE、またはPARTNER に設定する必要があります。プライベートアプリケーションから接続するには、追加でOAuthAccessToken、OAuthClientId、 OAuthClientSecret、CertificateStoreType、CertificateStore、およびCertificateStorePassword を設定してください。

パブリックまたはパートナーアプリケーションから接続する場合は、埋め込みOAuthClientId、OAuthClientSecret、 およびCallbackURL を指定するか、アプリを登録してOAuth の値を入手できます。

Xero への認証については、ヘルプドキュメントの「はじめに」を参照してください。

            
                input {
                    jdbc {
                      jdbc_driver_library => "../logstash-core/lib/jars/cdata.jdbc.xero.jar"
                      jdbc_driver_class => "Java::cdata.jdbc.xero.XeroDriver"
                      jdbc_connection_string => "jdbc:xero:InitiateOAuth=REFRESH"
                      jdbc_user => ""
                      jdbc_password => ""
                      schedule => "*/30 * * * * *"
                      statement => "SELECT Name, SUM(QuantityOnHand) FROM Items GROUP BY Name"
                    }
                  }
                  
                 
                  output {
                    Elasticsearch {
                        index => "xero_Items"
                        document_id => "xxxx"
                    }
                  }
            
        

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

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

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

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

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

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

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