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

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

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

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

Elasticsearch Logstash でCData JDBC Driver for SugarCRM を使用

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

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

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

CData 製品をSugarCRM に認証するには、以下を有効なSugarCRM ユーザー資格情報に設定する必要があります。User：SugarCRM アカウントのユーザー。Password：SugarCRM アカウントのパスワード。

OAuth consumer key とconsumer secret は、Admin -> OAuth Keys で生成することができます。OAuthClientId にOAuth consumer key を、OAuthClientSecret にconsumer secret　を設定します。

さらに、SugarCRM への接続を確立するには以下を指定します。URL：'http://{sugar crm instance}.com' の形式で、SugarCRM アカウントに紐付いているURL に設定。Platform：認証中にログインの競合が発生した場合は、SugarCRM UI で作成したプラットフォームのいずれかに設定。

SugarCRM メタデータの取得は高負荷になる可能性があることに注意してください。メタデータのキャッシュ で説明しているように、メタデータをローカルに格納することをお勧めします。

            input {
                jdbc {
                    jdbc_driver_library => "../logstash-core/lib/jars/cdata.jdbc.sugarcrm.jar"
                    jdbc_driver_class => "Java::cdata.jdbc.sugarcrm.SugarCRMDriver"
                    jdbc_connection_string => "jdbc:sugarcrm:User=MyUser;Password=MyPassword;URL=MySugarCRMAccountURL;CacheMetadata=True;"
                    jdbc_user => ""
                    jdbc_password => ""
                    schedule => "*/30 * * * * *"
                    statement => "SELECT Name, AnnualRevenue FROM Accounts"
                }
            }
                
                
            output {
                Elasticsearch {
                    index => "sugarcrm_Accounts"
                    document_id => "xxxx"
                }
            }
        

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

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

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

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

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

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

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