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

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

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

Elasticsearch Logstash でCData JDBC Driver for SurveyMonkey を使用

• CData JDBC Driver for SurveyMonkey をLogstash が稼働するマシンにインストールします。
• 以下のパスにJDBC Driver がインストールされます（2022J の部分はご利用される製品バージョンによって異なります）。後ほどこのパスを使います。この.jar ファイル（製品版の場合は.lic ファイルも）をLogstash に配置します。
  C:\Program Files\CData\CData JDBC Driver for SurveyMonkey 2022J\lib\cdata.jdbc.surveymonkey.jar
  
• 次に、Logstash とCData JDBC Driver をつなぐ、JDBC Input Plugin をインストールします。JDBC Plugin は最新のLogstash だとデフォルトでついてきますが、バージョンによっては追加する必要があります。
  https://www.elastic.co/guide/en/logstash/5.4/plugins-inputs-jdbc.html
• CData JDBC Driver の.jar ファイルと.lic ファイルを、Logstashの「/logstash-core/lib/jars/」に移動します。

Logstash でElasticsearch にSurveyMonkey データを送る

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

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

SurveyMonkey はOAuth 2 認証標準を利用しています。SurveyMonkey がアンケートの回答を読むためにこれを必要とすることを考えると、アンケートを読むアカウントには有料プランのサブスクリプションが必要です。

SurveyMonkey への接続に使用できる認証方法は2つあります。

• プライベートoauth アプリケーションを登録するときに、パーソナルアクセストークンを使用します。
• パブリックoauth アプリケーションを登録するときに、OAuth を使用します。

パーソナルアクセストークンの使用

個人用トークンを使用して、自分のデータをテストし、アクセスします。個人用トークンを取得するには、ヘルプの「Creating a Custom OAuth App」の手順に従って、次の接続プロパティを設定します。

• OAuthAccessToken：アプリケーション設定で生成されたAccessToken に設定。
• InitiateOAuth：OFF に設定。

OAuth の使用

本製品はすでにSurveyMonkey にOAuth アプリケーションとして登録されています。そのため、デフォルトでは、自動的に埋め込みクレデンシャルを使用して接続します。

独自のカスタムOAuth アプリを使用したい場合は、ヘルプのCustom Credentials を参照してください。

            input {
                jdbc {
                    jdbc_driver_library => "../logstash-core/lib/jars/cdata.jdbc.surveymonkey.jar"
                    jdbc_driver_class => "Java::cdata.jdbc.surveymonkey.SurveyMonkeyDriver"
                    jdbc_connection_string => "jdbc:surveymonkey:OAuthClientId=MyOAuthClientId;OAuthClientSecret=MyOAuthClientSecret;CallbackURL=http://localhost:portNumber;InitiateOAuth=REFRESH"
                    jdbc_user => ""
                    jdbc_password => ""
                    schedule => "*/30 * * * * *"
                    statement => "SELECT RespondentId, ChoiceId FROM MySurvey_Responses"
                }
            }
                
                
            output {
                Elasticsearch {
                    index => "surveymonkey_MySurvey_Responses"
                    document_id => "xxxx"
                }
            }
        

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

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

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

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

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

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

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