How to load Kintone data into Elasticsearch via Logstash



Introducing a simple method to load Kintone 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 Kintone to load data from Kintone into Elasticsearch via Logstash.

Using CData JDBC Driver for Kintone with Elasticsearch Logstash

  • Install the CData JDBC Driver for Kintone 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 Kintone 20XX\lib\cdata.jdbc.kintone.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 Kintone data to Elasticsearch with Logstash

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

  • Write the process to retrieve Kintone 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 Kintone in the form of a JDBC URL. The JDBC URL allows detailed configuration, so please refer to the product documentation for more specifics.
  • In addition to the authentication values, set the following parameters to connect to and retrieve data from Kintone:

    • Url: The URL of your account.
    • GuestSpaceId: Optional. Set this when using a guest space.

    Authenticating with Kintone

    Kintone supports the following authentication methods.

    Using Password Authentication

    You must set the following to authenticate:

    • User: The username of your account.
    • Password: The password of your account.

    Using Basic Authentication

    If the basic authentication security feature is set on the domain, supply the additional login credentials with BasicAuthUser and BasicAuthPassword. Basic authentication requires these credentials in addition to User and Password.

    Using Client SSL

    Instead of basic authentication, you can specify a client certificate to authenticate. Set SSLClientCert, SSLClientCertType, SSLClientCertSubject, and SSLClientCertPassword. Additionally, set User and Password to your login credentials.

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 Kintone data has been loaded into Elasticsearch.

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

    GET kintone_table/_search
    {
        "query": {
            "match_all": {}
        }
    }
Querying the Kintone data loaded into Elasticsearch

We have confirmed that the data is stored in Elasticsearch.

Confirming the Kintone data loaded into Elasticsearch

By using the CData JDBC Driver for Kintone with Logstash, it functions as a Kintone 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 Kintone Driver to get started:

 Download Now

Learn more:

Kintone  Icon Kintone JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with Kintone applications and databases.