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

詳細情報をご希望ですか?

製品の詳細情報:

UPS 連携ソリューション


全文検索のElasticsearch のETL/ELT モジュールのLogstash とJDBC Driver を使い、UPS データを簡単にロードする方法。

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

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

Elasticsearch Logstash でCData JDBC Driver for UPS を使用

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

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

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

    • Server:リクエストが送信されるURL を制御します。テスト用によく使われるURL としては、 https://wwwcie.ups.com/ups.app/xmlhttps://wwwcie.ups.com/webservices があります。
    • AccessKey:UPR サーバーへの接続に必要となる識別子。この値は、UPS への登録後提供されます。
    • UserId:UPS へのログインに使用される値。この値は、UPS にサービスを登録する際のログイン時に選択する値です。
    • Password:UPS へのログインに使用される値。この値は、UPS にサービスを登録する際のログイン時に選択する値です。
    • AccountNumber:6桁または10桁のUPS アカウント番号。
    • PrintLabelLocation:このプロパティは、GenerateLabels、またはGenerateReturnLabels ストアドプロシージャを使用する際には必須です。生成されたラベルを格納するフォルダの場所に設定してください。
                
                    input {
                        jdbc {
                          jdbc_driver_library => "../logstash-core/lib/jars/cdata.jdbc.ups.jar"
                          jdbc_driver_class => "Java::cdata.jdbc.ups.UPSDriver"
                          jdbc_connection_string => "jdbc:ups:Server=https://wwwcie.ups.com/ups.app/xml;AccessKey=myAccessKey;Password=myPassword;AccountNumber=myAccountNumber;UserId=myUserIdInitiateOAuth=REFRESH"
                          jdbc_user => ""
                          jdbc_password => ""
                          schedule => "*/30 * * * * *"
                          statement => "SELECT FirstName, Phone FROM Senders WHERE SenderID = '25'"
                        }
                      }
                      
                     
                      output {
                        Elasticsearch {
                            index => "ups_Senders"
                            document_id => "xxxx"
                        }
                      }
                
            

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

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

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

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

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

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

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

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