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

加藤龍彦
デジタルマーケティング

全文検索サービスElasticsearch のETL モジュール「Logstash」とCData JDBC ドライバを使って、Typeform のデータを簡単にロードする方法をご紹介。

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

この記事では、CData Driver for API を使って、Typeform のデータを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 にTypeform のデータを送る

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

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

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

TypeForm API プロファイル設定

TypeForm への認証にはOAuth 標準を使用します。

TypeForm に認証するには、まずTypeForm でOAuth アプリケーションを登録および設定する必要があります：https://admin.typeform.com/account#/section/tokens。アプリにはclient ID とclient secret が割り当てられ、接続文字列で設定できます。OAuth アプリケーションの設定の詳細については、https://developer.typeform.com/get-started/ をご参照ください。

使用シナリオによって異なるリダイレクトURI が必要です：

CData デスクトップアプリケーション：CData デスクトップアプリケーション（Sync、API Server、ArcESB）は/src/oauthCallback.rst でOAuth トークンを受け入れます。ホストとポートはアプリケーションが使用するデフォルトポートと同じです。例えば、http://localhost:8019/ でCData Sync にアクセスする場合、リダイレクトURI はhttp://localhost:8019/src/oauthCallback.rst になります。
CData クラウドアプリケーション：CData クラウドアプリケーションはデスクトップ版と同様です。https://1.2.3.4/ でConnect AI にアクセスする場合、リダイレクトはhttps://1.2.3.4/src/oauthCallback.rst を使用します。
デスクトップアプリケーション：デスクトップアプリケーションを使用する場合、URI はhttps://localhost:33333 を推奨します。
Web アプリケーション：ドライバーを使用してWeb アプリケーションを開発する場合、https://my-website.com/oauth のような独自のURI を使用します。

以下の接続プロパティを設定すると、接続の準備が整います：

AuthScheme：OAuth に設定します。
InitiateOAuth：GETANDREFRESH に設定します。InitiateOAuth を使用してOAuthAccessToken を取得するプロセスを管理できます。
OAuthClientId：アプリ設定で指定されているClient Id を設定します。
OAuthClientSecret：アプリ設定で指定されているClient Secret を設定します。
CallbackURL：アプリ設定で指定したRedirect URI を設定します。

            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\TypeForm.apip;Authscheme=OAuth;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;InitiateOAuth=REFRESH"
                    jdbc_user => ""
                    jdbc_password => ""
                    schedule => "*/30 * * * * *"
                    statement => "SELECT Id, Title FROM Tags WHERE SettingsIsPublic = 'true'"
                }
            }


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

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

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

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

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

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

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

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

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

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

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

Typeform に接続お問い合わせ