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

加藤龍彦
加藤龍彦
デジタルマーケティング
全文検索サービスElasticsearch のETL モジュール「Logstash」とCData JDBC ドライバを使って、Clio のデータを簡単にロードする方法をご紹介。

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

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

Elasticsearch Logstash でCData JDBC Driver for API を使用

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

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

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

    • まず、Profile 接続プロパティをディスク上のClio プロファイルの場所に設定します（例：C:\profiles\Clio.apip）。次に、ProfileSettings 接続プロパティをClio の接続文字列に設定します（以下を参照）。

    Clio API プロファイル設定

    Clio はOAuth ベースの認証を使用します。

    まず、Clio でOAuth アプリケーションを登録します。Developer アカウントにログインし、Add ボタンをクリックして登録できます。ここでアプリケーションの詳細とスコープを入力します。これらの詳細は、Clio ユーザーがアプリケーションの認可を求められたときに表示されます。OAuth アプリケーションにはclient id（キー）とclient secret（シークレット）が割り当てられます。また、ProfileSettings 接続プロパティでRegion を設定します。

    以下の接続プロパティを設定すると、接続できるようになります。

    • AuthScheme：OAuth に設定します。
    • InitiateOAuth：GETANDREFRESH に設定します。InitiateOAuth を使用して、OAuthAccessToken を取得するプロセスを管理できます。
    • OAuthClientId：アプリ設定で指定されたclient_id に設定します。
    • OAuthClientSecret：アプリ設定で指定されたclient_secret に設定します。
    • CallbackURL：アプリ設定で指定されたRedirect URI に設定します。
    • Region：ProfileSettings でClio の地理的リージョンに設定します。デフォルトはapp.clio.com です。 
                input {
                jdbc {
                    jdbc_driver_library => "../logstash-core/lib/jars/cdata.jdbc.api.jar"
                    jdbc_driver_class => "Java::cdata.jdbc.api.APIDriver"
                    jdbc_connection_string => "jdbc:api:Profile=C:\profiles\Clio.apip;ProfileSettings='Region=your_region';Authscheme=OAuth;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;"
                    jdbc_user => ""
                    jdbc_password => ""
                    schedule => "*/30 * * * * *"
                    statement => "SELECT Id, Total FROM Bills WHERE State = 'awaiting_payment'"
                }
            }


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

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

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

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

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

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

        GET api_Bills/_search
        {
            "query": {
                "match_all": {}
            }
        }
Elasticsearch にロードされたClio のデータをクエリ

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

Elasticsearch にロードされたClio のデータを確認

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

はじめる準備はできましたか？

API Driver で Clio のライブデータに接続

Clio に接続 お問い合わせ

この記事の内容

関連記事