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

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

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

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

Elasticsearch Logstash でCData JDBC Driver for SalesforceDataCloud を使用

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

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

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

Salesforce Data Cloud は、OAuth 標準による認証をサポートしています。

OAuth

AuthScheme をOAuth に設定します。

デスクトップアプリケーション

CData は、デスクトップでの認証を簡略化する埋め込みOAuth アプリケーションを提供します。

また、Salesforce Data Cloud コンソールで設定および登録するカスタムOAuth アプリケーションを介してデスクトップから認証することもできます。詳しくは、ヘルプドキュメントのカスタムOAuth アプリの作成を参照してください。

接続する前に、次のプロパティを設定します。

• InitiateOAuth：GETANDREFRESH。InitiateOAuth を使えば、繰り返しOAuth の交換を行ったり、手動でOAuthAccessToken を設定する必要はなくなります。
• OAuthClientId （カスタムアプリケーションのみ）：カスタムOAuth アプリケーションの登録時に割り当てられたクライアントID。
• OAuthClientSecret （カスタムアプリケーションのみ）：カスタムOAuth アプリケーションの登録時に割り当てられたクライアントシークレット。

接続すると、本製品 はデフォルトブラウザでSalesforce Data Cloud のOAuth エンドポイントを開きます。ログインして、アプリケーションにアクセス許可を与えます。

以下のようにドライバーがOAuth プロセスを完了します。

• コールバックURL からアクセストークンを取得します。
• 古いトークンの期限が切れたときは、新しいアクセストークンを取得します。
• OAuthSettingsLocation にOAuth 値を保存し、接続間で永続化します。

Web アプリケーションやヘッドレスマシンを含むその他のOAuth メソッドについては、ヘルプドキュメントを参照してください。

            input {
                jdbc {
                    jdbc_driver_library => "../logstash-core/lib/jars/cdata.jdbc.salesforcedatacloud.jar"
                    jdbc_driver_class => "Java::cdata.jdbc.salesforcedatacloud.SalesforceDataCloudDriver"
                    jdbc_connection_string => "jdbc:salesforcedatacloud:InitiateOAuth=REFRESH"
                    jdbc_user => ""
                    jdbc_password => ""
                    schedule => "*/30 * * * * *"
                    statement => "SELECT [Account ID], [Account Name] FROM Account WHERE EmployeeCount > 250"
                }
            }


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

Logstash でSalesforce Data Cloud のローディングを実行

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

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

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

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

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



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



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