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

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

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

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

Elasticsearch Logstash でCData JDBC Driver for Kintone を使用

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

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

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

Kintone 接続プロパティの取得・設定方法

Kintone に接続するには、以下の接続プロパティを設定してください。

• Url：Kintone へのアクセスURL。例えば、https://yoursitename.cybozu.com またはhttps://yoursitename.kintone.com
• User：アカウントのユーザー名
• Password：アカウントのパスワード

Basic 認証を利用する

ご利用のKintone ドメインでBasic 認証の機能を設定している場合は、接続プロパティの「詳細」設定からBasicAuthUser およびBasicAuthPassword を追加で指定してください。

クライアントSSL を利用する

Basic 認証の代わりにクライアント証明書を使った認証を利用する場合は、SSLClientCert、SSLClientCertType、SSLClientCertSubject、 およびSSLClientCertPassword を指定ください。

            input {
                jdbc {
                    jdbc_driver_library => "../logstash-core/lib/jars/cdata.jdbc.kintone.jar"
                    jdbc_driver_class => "Java::cdata.jdbc.kintone.KintoneDriver"
                    jdbc_connection_string => "jdbc:kintone:User=myuseraccount;Password=mypassword;URL=http://subdomain.domain.com;"
                    jdbc_user => ""
                    jdbc_password => ""
                    schedule => "*/30 * * * * *"
                    statement => "SELECT Name, Description FROM Apps"
                }
            }
                
                
            output {
                Elasticsearch {
                    index => "kintone_Apps"
                    document_id => "xxxx"
                }
            }
        

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

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

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

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

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

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

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