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

こんにちは！ウェブ担当の加藤です。マーケ関連のデータ分析や整備もやっています。

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

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

Elasticsearch Logstash でCData JDBC Driver for ADP を使用

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

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

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

ADP 接続プロパティの取得・設定方法

接続を確立する前に、ADP に連絡してOAuth アプリとそれに関連するクレデンシャルを提供してもらう必要があります。 これらのクレデンシャルはADP からのみ取得が可能で、直接取得することはできません。

ADP への接続

次のプロパティを指定してADP に接続します。

• OAuthClientId：ADP より提供されたアプリのクライアントId に設定。
• OAuthClientSecret：ADP より提供されたアプリのクライアントシークレットに設定。
• SSLClientCert：ADP より提供された証明書に設定。
• SSLClientCertPassword：証明書のパスワードに設定。
• UseUAT：CData 製品はデフォルトで、本番環境にリクエストを行います。開発者アカウントを使用している場合は、UseUAT をtrue に設定します。
• RowScanDepth：テーブルで利用可能なカスタムフィールドカラムをスキャンする行数の最大値。デフォルト値は100に設定されています。大きい値を設定すると、パフォーマンスが低下する場合があります。

            input {
                jdbc {
                    jdbc_driver_library => "../logstash-core/lib/jars/cdata.jdbc.adp.jar"
                    jdbc_driver_class => "Java::cdata.jdbc.adp.ADPDriver"
                    jdbc_connection_string => "jdbc:adp:OAuthClientId=YourClientId;OAuthClientSecret=YourClientSecret;SSLClientCert='c:\cert.pfx';SSLClientCertPassword='admin@123'InitiateOAuth=REFRESH"
                    jdbc_user => ""
                    jdbc_password => ""
                    schedule => "*/30 * * * * *"
                    statement => "SELECT AssociateOID, WorkerID FROM Workers WHERE AssociateOID = 'G3349PZGBADQY8H8'"
                }
            }
                
                
            output {
                Elasticsearch {
                    index => "adp_Workers"
                    document_id => "xxxx"
                }
            }
        

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

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

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

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

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

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

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