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

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

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

最終更新日:2022-07-22

この記事で実現できるCouchDB 連携のシナリオ

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

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

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

Elasticsearch Logstash でCData JDBC Driver for ApacheCouchDB を使用

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

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

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

    Url 接続プロパティをApache CouchDB インスタンスのURL に設定します。例:http://localhost:5984

    ユーザー(またはJWT)が特定のデータベースだけにアクセスできるようにしたい場合は、Apache CouchDB インスタンスで"admin_only_all_dbs" オプションを設定し、テーブルをリストするために本製品が必要とする"/_all_dbs" エンドポイントへのアクセス権をすべてのユーザーに付与する必要があります。

    Apache CouchDB への認証

    3種類の認証をサポートします。
    • Basic:基本的なユーザー名 / パスワード認証。
    • JWT:JWT 認証。
    • None:パブリックなデータベースへの匿名アクセス。

    Basic 認証

    データに接続するには以下を設定します。

    • AuthSchemeBasic
    • User:認証に使用されるApache CouchDB ユーザーアカウント。
    • Password:認証するユーザーに関連付けられたApache CouchDB パスワード。

    その他の認証方法は、ヘルプドキュメント の「接続の確立」セクションを参照してください。

                input {
                    jdbc {
                        jdbc_driver_library => "../logstash-core/lib/jars/cdata.jdbc.apachecouchdb.jar"
                        jdbc_driver_class => "Java::cdata.jdbc.apachecouchdb.ApacheCouchDBDriver"
                        jdbc_connection_string => "jdbc:apachecouchdb:Url=http://localhost:5984;User=abc123;Password=abcdef;"
                        jdbc_user => ""
                        jdbc_password => ""
                        schedule => "*/30 * * * * *"
                        statement => "SELECT MovieRuntime, MovieRating FROM Movies WHERE MovieRating = 'R'"
                    }
                }
    
    
                output {
                    Elasticsearch {
                        index => "apachecouchdb_Movies"
                        document_id => "xxxx"
                    }
                }
            

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

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

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

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

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

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

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

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

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

関連コンテンツ

トライアル・お問い合わせ

30日間無償トライアルで、CData のリアルタイムデータ連携をフルにお試しいただけます。記事や製品についてのご質問があればお気軽にお問い合わせください。