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

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

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

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

Elasticsearch Logstash でCData JDBC Driver for WooCommerce を使用

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

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

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

WooCommerce は、one-legged OAuth1.0 認証と通常のOAuth2.0 認証をサポートします。

one-legged OAuth 1.0 認証を使って接続する

次のプロパティを指定してください（NOTE：次の資格情報はWooCommerce の設定ページで生成されるもので、WordPress OAuth2.0 プラグインで生成されるものとは異なります）。

• ConsumerKey
• ConsumerSecret

WordPress OAuth 2.0 認証を使って接続する

プラグインを設定した後、 次の接続プロパティを指定することでWooCommerce に接続できます。

• OAuthClientId
• OAuthClientSecret
• CallbackURL
• InitiateOAuth - GETANDREFRESH または REFRESH のどちらかに設定してください

どちらの場合方法でも、Url プロパティをWooCommerce インスタンスのURL に設定する必要があります。

            input {
                jdbc {
                    jdbc_driver_library => "../logstash-core/lib/jars/cdata.jdbc.woocommerce.jar"
                    jdbc_driver_class => "Java::cdata.jdbc.woocommerce.WooCommerceDriver"
                    jdbc_connection_string => "jdbc:woocommerce:Url=https://example.com/; ConsumerKey=ck_ec52c76185c088ecaa3145287c8acba55a6f59ad; ConsumerSecret=cs_9fde14bf57126156701a7563fc87575713c355e5; InitiateOAuth=REFRESH"
                    jdbc_user => ""
                    jdbc_password => ""
                    schedule => "*/30 * * * * *"
                    statement => "SELECT ParentId, Total FROM Orders WHERE ParentId = '3'"
                }
            }
                
                
            output {
                Elasticsearch {
                    index => "woocommerce_Orders"
                    document_id => "xxxx"
                }
            }
        

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

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

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

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

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

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

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