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

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

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

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

Elasticsearch Logstash でCData JDBC Driver for FreshDesk を使用

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

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

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

FreshDesk はbasic 認証を使用します。データへの接続には、次の接続プロパティを設定してください。

• Domain：この値を、FreshDesk アカウントに紐づけられたドメインに設定します。例えば、 https://my_domain.freshdesk.comです。
• APIKey：この値を、FreshDesk アカウントに紐づけられたAPI キーに設定します。API キーを取得するには、 サポートPortal にログインして、-> 右上端のプロファイル写真をクリック、-> プロファイル設定ページに移動します。API キーは、 右のchange password セクションの下から生成できます。

            input {
                jdbc {
                    jdbc_driver_library => "../logstash-core/lib/jars/cdata.jdbc.freshdesk.jar"
                    jdbc_driver_class => "Java::cdata.jdbc.freshdesk.FreshDeskDriver"
                    jdbc_connection_string => "jdbc:freshdesk:Domain=MyDomain;APIKey=myAPIKey;"
                    jdbc_user => ""
                    jdbc_password => ""
                    schedule => "*/30 * * * * *"
                    statement => "SELECT Id, Name FROM Tickets WHERE Status = '2'"
                }
            }


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

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

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

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

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

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

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

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