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

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

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

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

Elasticsearch Logstash でCData JDBC Driver for ShipStation を使用

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

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

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

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

ShipStation への接続には、BASIC 認証標準を使います。

1. ShipStation アカウントにログインします。
2. 右上隅にある［設定］アイコンをクリックします。左側にカラムメニューが表示されます。
3. ［アカウント］->［API 設定］をクリックします。
4. ［API 設定］ページで、API Key とAPI Secret を書き留めます。

ShipStation への認証

• APIKey：［API 設定］ページのAPI Key に設定します。
• APISecret：［API 設定］ページのSecret key に設定します。

            input {
                jdbc {
                    jdbc_driver_library => "../logstash-core/lib/jars/cdata.jdbc.shipstation.jar"
                    jdbc_driver_class => "Java::cdata.jdbc.shipstation.ShipStationDriver"
                    jdbc_connection_string => "jdbc:shipstation:APIKey='YourAPIKey';APISecret='YourAPISecret'"
                    jdbc_user => ""
                    jdbc_password => ""
                    schedule => "*/30 * * * * *"
                    statement => "SELECT Id, Color FROM Tags WHERE CustomerId = '1368175'"
                }
            }


            output {
                Elasticsearch {
                    index => "shipstation_Tags"
                    document_id => "xxxx"
                }
            }
        

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

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

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

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

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

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

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