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

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

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

Elasticsearch Logstash でCData JDBC Driver for Magento を使用

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

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

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

Magento はOAuth 1 認証標準を使用します。Magento REST API に接続するには、Magento システムにアプリを登録してOAuthClientId、OAuthClientSecret、およびCallbackURL 接続プロパティの値を取得する必要があります。 OAuth 値を取得して接続するには、ヘルプドキュメントの「はじめに」を参照してください。

また、Magento システムへのURL を提供する必要があります。URL は、Magento REST API を顧客として使用しているか管理者として使用しているかによって異なります。

• Customer: Magento を顧客として使用するには、事前にMagento のホームページで顧客アカウントを作成します。これを行うには、［アカウント］->［登録］をクリックします。それからURL 接続プロパティをMagento システムのエンドポイントに設定します。

• Administrator: Magento を管理者として使用するには、代わりにCustomAdminPath を設定します。この値は、［Admin］メニューの［Advanced］設定で取得できます。［System］->［Configuration］->［Advanced］->［Admin］->［Admin Base URL］を選択することでアクセスできます。

  このページ上の［Use Custom Admin Path］設定がYES に設定されている場合、値は［Custom Admin Path］テキストボックス内にあります。それ以外の場合は、CustomAdminPath 接続プロパティをデフォルト値の"admin" に設定します。

            
                input {
                    jdbc {
                      jdbc_driver_library => "../logstash-core/lib/jars/cdata.jdbc.magento.jar"
                      jdbc_driver_class => "Java::cdata.jdbc.magento.MagentoDriver"
                      jdbc_connection_string => "jdbc:magento:OAuthClientId=MyConsumerKey;OAuthClientSecret=MyConsumerSecret;CallbackURL=http://127.0.0.1:33333;Url=https://mymagentohost.com;InitiateOAuth=REFRESH"
                      jdbc_user => ""
                      jdbc_password => ""
                      schedule => "*/30 * * * * *"
                      statement => "SELECT Name, Price FROM Products"
                    }
                  }
                  
                 
                  output {
                    Elasticsearch {
                        index => "magento_Products"
                        document_id => "xxxx"
                    }
                  }
            
        

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

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

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

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

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

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

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

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