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

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

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

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

Elasticsearch Logstash でCData JDBC Driver for Pipedrive を使用

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

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

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

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

Pipedrive への接続に使用できる認証方法は、Basic およびOAuth です。

Basic

API トークンの取得から始めます。
1. PipeDrive の右上にあるアカウント名をクリックします。
2. 会社設定をクリックし、続いてPersonal Preferences -> API -> Generate Token をクリックします。
3. API トークンを控えておきます。
4. CompanyDomain を控えておきます。これは、PipeDrive ホームページのURL に表示されます。

以下を設定してPipedrive へ認証します。

• APIToken：控えておいたAPI トークンに設定。
• CompanyDomain：控えておいた開発者サンドボックスURL の会社ドメインに設定。
• AuthScheme：Basic に設定。

API トークンは、PipeDrive の右上にあるアカウント名 -> 会社設定 -> Personal preferences -> API に移動して確認できます。

OAuth

ユーザー名やパスワードへのアクセスを保有していない場合や、それらを使いたくない場合にはOAuth ユーザー同意フローを使用します。認証方法については、ヘルプドキュメントの「OAuth」セクションを参照してください。

            input {
                jdbc {
                    jdbc_driver_library => "../logstash-core/lib/jars/cdata.jdbc.pipedrive.jar"
                    jdbc_driver_class => "Java::cdata.jdbc.pipedrive.PipedriveDriver"
                    jdbc_connection_string => "jdbc:pipedrive:AuthScheme=Basic;CompanyDomain=MyCompanyDomain;APIToken=MyAPIToken;"
                    jdbc_user => ""
                    jdbc_password => ""
                    schedule => "*/30 * * * * *"
                    statement => "SELECT PersonName, UserEmail FROM Deals WHERE Value > 50000"
                }
            }
                
                
            output {
                Elasticsearch {
                    index => "pipedrive_Deals"
                    document_id => "xxxx"
                }
            }
        

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

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

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

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

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

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

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