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

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

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

Elasticsearch Logstash でCData JDBC Driver for Anaplan を使用

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

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

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

Anaplan への認証

ドライバーはBasic、証明書、またはOAuth による認証をサポートしています。いずれの場合も、Region をAnaplan アカウントデータがホストされているリージョン（例：US1、これがデフォルト）に設定してください。

Basic 認証の使用

AuthScheme をBasic に設定し、Anaplan のUser とPassword を入力します。ワークスペースがシングルサインオン（SSO）を使用している場合は、Basic 認証を使用するために Exception User として割り当てられている必要があります。

証明書認証の使用

AuthScheme をCertificate に設定し、Certificate、CertificateType、PrivateKey プロパティを入力します（どちらかが暗号化されている場合はCertificatePassword / PrivateKeyPassword も設定してください）。証明書は、Anaplan テナント管理者に登録されたCA 発行のX.509 証明書である必要があります。

OAuth 認証の使用

Anaplan でカスタムOAuth アプリケーションを登録し、以下のプロパティを設定します：

• OAuthClientId：カスタムOAuth アプリケーションの登録時に割り当てられたクライアントId。
• OAuthClientSecret：カスタムOAuth アプリケーションの登録時に割り当てられたクライアントシークレット。
• CallbackURL：アプリケーションの登録時に定義したリダイレクトURI。
• InitiateOAuth：GETANDREFRESH に設定すると、ドライバーがOAuth トークンの交換と更新を自動的に管理します。

カスタムOAuth アプリの作成方法とOAuth の使用方法については、ヘルプドキュメントの「はじめに」の章を参照してください。

            input {
                jdbc {
                    jdbc_driver_library => "../logstash-core/lib/jars/cdata.jdbc.anaplan.jar"
                    jdbc_driver_class => "Java::cdata.jdbc.anaplan.AnaplanDriver"
                    jdbc_connection_string => "jdbc:anaplan:OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackURL=your_callback_url;Region=US1;InitiateOAuth=GETANDREFRESH;InitiateOAuth=REFRESH"
                    jdbc_user => ""
                    jdbc_password => ""
                    schedule => "*/30 * * * * *"
                    statement => "SELECT Region, Product FROM [Workspace].[Model].[Sales] WHERE Value = \'100\'"
                }
            }


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

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

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

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

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

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

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

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

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