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

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

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

Elasticsearch Logstash でCData JDBC Driver for PayPal を使用

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

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

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

それでは、PayPal への接続について説明していきましょう。CData製品では、2つのPayPal API のテーブルに対応しています。これらのAPI は、それぞれ異なる認証方法を使用します。

• REST API はOAuth 標準を使用します。REST API で認証するには、AuthScheme をOAuth に設定し、OAuthClientId およびOAuthClientSecret プロパティを設定してください
• 非推奨：SOAP API は廃止予定です。より優れたリソースアクセスのため、REST API のご利用をお勧めします

必要なAPI 資格情報の取得方法については、ヘルプドキュメントの「はじめに」をご確認ください。

使用するAPI を選択するには、Schema プロパティをREST またはSOAP に設定します。

テスト目的では、UseSandbox をtrue に設定してSandbox 資格情報をご利用いただけます。

            input {
                jdbc {
                    jdbc_driver_library => "../logstash-core/lib/jars/cdata.jdbc.paypal.jar"
                    jdbc_driver_class => "Java::cdata.jdbc.paypal.PayPalDriver"
                    jdbc_connection_string => "jdbc:paypal:Schema=SOAP;Username=sandbox-facilitator_api1.test.com;Password=xyz123;Signature=zx2127;InitiateOAuth=REFRESH"
                    jdbc_user => ""
                    jdbc_password => ""
                    schedule => "*/30 * * * * *"
                    statement => "SELECT Date, GrossAmount FROM Transactions"
                }
            }


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

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

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

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

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

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

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

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

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