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

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

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

Elasticsearch Logstash でCData JDBC Driver for SageX3Cloud を使用

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

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

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

Sage X3 Cloud では OAuth 2.0 の Client Credentials フローを使用し、API へのアクセスには X-API-Key も必要です。AuthScheme を OAuth に設定し、以下の接続プロパティを指定します。

• URL：Sage X3 Cloud インスタンスのベース URL。
• OAuthAccessTokenUrl：OAuth トークンエンドポイント（例：https://your-auth-domain/oauth/token）。
• OAuthClientId：OAuth アプリケーションのクライアント ID。
• OAuthClientSecret：OAuth アプリケーションのクライアントシークレット。
• Audience：トークンリクエストで使用する API の Audience 値。
• XAPIKey：Sage X3 Cloud の管理者から提供された X-API-Key。
• Folder：Sage X3 のフォルダ名（例：SEED）。このフォルダがデフォルトのスキーマとして使用されます。
• Folders（オプション）：Sage X3 フォルダのカンマ区切りリスト（例：SEED,PERF）。各フォルダが個別のスキーマとして公開されるため、Schema.Table 構文でフォルダをまたいだクエリを実行できます。

ドライバーは Client Credentials フローでアクセストークンを取得し、すべての API リクエストで X-API-Key とあわせて送信します。InitiateOAuth を GETANDREFRESH（デフォルト）に設定しておけば、トークンの取得と更新は自動で行われます。

            input {
                jdbc {
                    jdbc_driver_library => "../logstash-core/lib/jars/cdata.jdbc.sagex3cloud.jar"
                    jdbc_driver_class => "Java::cdata.jdbc.sagex3cloud.SageX3CloudDriver"
                    jdbc_connection_string => "jdbc:sagex3cloud:AuthScheme=OAuth;URL=https://x3server/;OAuthAccessTokenUrl=https://auth-domain/oauth/token;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;Audience=https://api-audience;XAPIKey=your_api_key;Folder=SEED;InitiateOAuth=REFRESH"
                    jdbc_user => ""
                    jdbc_password => ""
                    schedule => "*/30 * * * * *"
                    statement => "SELECT BPCNUM, BPCNAM FROM BPCUSTOMER WHERE BPCNUM = 'MARTIN'"
                }
            }


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

Logstash でSage X3 Cloud のローディングを実行

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

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

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

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

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

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

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