製品情報をご覧ください

製品情報や無償評価版を製品ページにてご確認いただけます。

製品ページへ

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

全文検索のElasticsearch のETL/ELT モジュールのLogstash とJDBC Driver を使い、WooCommerce データを簡単にロードする方法。

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

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

Elasticsearch Logstash でCData JDBC Driver for WooCommerce を使用

  • CData JDBC Driver for WooCommerce をLogstash が稼働するマシンにインストールします。
  • 以下のパスにJDBC Driver がインストールされます。後ほどこのパスを使います。この.jar ファイルと製品版の場合は.lic ファイルをLogstash に配置して使います。
    C:\Program Files\CData\CData JDBC Driver for WooCommerce 2019J\lib\cdata.jdbc.woocommerce.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 にWooCommerce データを送る

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

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

    Connecting using one-legged OAuth 1.0 Authentication

    Specify the following properties (NOTE: the below credentials are generated from WooCommerce settings page and should not be confused with the credentials generated by using WordPress OAuth2.0 plugin):

    • ConsumerKey
    • ConsumerSecret

    Connecting using WordPress OAuth 2.0 Authentication

    After having configured the plugin, you may connect to WooCommerce by providing the following connection properties:

    • OAuthClientId
    • OAuthClientSecret
    • CallbackURL
    • InitiateOAuth - Set this to either GETANDREFRESH or REFRESH

    In either case, you will need to set the Url property to the URL of the WooCommerce instance.

                
                    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 を実行してみます。

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

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

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

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

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

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

 
 
ダウンロード