How to load WooCommerce data into Elasticsearch via Logstash



Introducing a simple method to load WooCommerce data using the ETL module Logstash of the full-text search service Elasticsearch and the CData JDBC driver.

Elasticsearch is a popular distributed full-text search engine. By centrally storing data, you can perform ultra-fast searches, fine-tuning relevance, and powerful analytics with ease. Elasticsearch has a pipeline tool for loading data called "Logstash". You can use CData JDBC Drivers to easily import data from any data source into Elasticsearch for search and analysis.

This article explains how to use the CData JDBC Driver for WooCommerce to load data from WooCommerce into Elasticsearch via Logstash.

Using CData JDBC Driver for WooCommerce with Elasticsearch Logstash

  • Install the CData JDBC Driver for WooCommerce on the machine where Logstash is running.
  • The JDBC Driver will be installed at the following path (the year part, e.g. 20XX, will vary depending on the product version you are using). You will use this path later. Place this .jar file (and the .lic file if it's a licensed version) in Logstash.
    C:\Program Files\CData\CData JDBC Driver for WooCommerce 20XX\lib\cdata.jdbc.woocommerce.jar
  • Next, install the JDBC Input Plugin, which connects Logstash to the CData JDBC driver. The JDBC Plugin comes by default with the latest version of Logstash, but depending on the version, you may need to add it.
    https://www.elastic.co/guide/en/logstash/5.4/plugins-inputs-jdbc.html
  • Move the CData JDBC Driver’s .jar file and .lic file to Logstash's "/logstash-core/lib/jars/".

Sending WooCommerce data to Elasticsearch with Logstash

Now, let's create a configuration file for Logstash to transfer WooCommerce data to Elasticsearch.

  • Write the process to retrieve WooCommerce data in the logstash.conf file, which defines data processing in Logstash. The input will be JDBC, and the output will be Elasticsearch. The data loading job is set to run at 30-second intervals.
  • Set the CData JDBC Driver's .jar file as the JDBC driver library, configure the class name, and set the connection properties to WooCommerce in the form of a JDBC URL. The JDBC URL allows detailed configuration, so please refer to the product documentation for more specifics.
  • 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.

Executing data movement with Logstash

Now let's run Logstash using the created "logstash.conf" file.

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

A log indicating success will appear. This means the WooCommerce data has been loaded into Elasticsearch.

For example, let's view the data transferred to Elasticsearch in Kibana.

    GET woocommerce_table/_search
    {
        "query": {
            "match_all": {}
        }
    }
Querying the WooCommerce data loaded into Elasticsearch

We have confirmed that the data is stored in Elasticsearch.

Confirming the WooCommerce data loaded into Elasticsearch

By using the CData JDBC Driver for WooCommerce with Logstash, it functions as a WooCommerce connector, making it easy to load data into Elasticsearch. Please try the 30-day free trial.

Ready to get started?

Download a free trial of the WooCommerce Driver to get started:

 Download Now

Learn more:

WooCommerce Icon WooCommerce JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with WooCommerce Ecommerce Software