How to load MySQL data into Elasticsearch via Logstash

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 MySQL to load data from MySQL into Elasticsearch via Logstash.

Using CData JDBC Driver for MySQL with Elasticsearch Logstash

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

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

• Write the process to retrieve MySQL 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 MySQL in the form of a JDBC URL. The JDBC URL allows detailed configuration, so please refer to the product documentation for more specifics.

The CData Provider supports connecting to on-premises and cloud-hosted versions of MySQL such as Amazon RDS for MySQL, Google Cloud SQL for MySQL, Azure Database for MySQL, or Oracle MySQL HeatWave. The Server and Port properties must be set to a MySQL server. If IntegratedSecurity is set to false, then User and Password must be set to valid user credentials. Optionally, Database can be set to connect to a specific database. If not set, tables from all databases will be returned.

SSH Connectivity for MySQL

You can use SSH (Secure Shell) to authenticate with MySQL, whether the instance is hosted on-premises or in supported cloud environments. SSH authentication ensures that access is encrypted (as compared to direct network connections).

SSH Connections to MySQL in Password Auth Mode

To connect to MySQL via SSH in Password Auth mode, set the following connection properties:

• User: MySQL User name
• Password: MySQL Password
• Database: MySQL database name
• Server: MySQL Server name
• Port: MySQL port number like 3306
• UserSSH: "true"
• SSHAuthMode: "Password"
• SSHPort: SSH Port number
• SSHServer: SSH Server name
• SSHUser: SSH User name
• SSHPassword: SSH Password

SSH Connections to MySQL in Public Key Auth Mode

To connect to MySQL via SSH in Password Auth mode, set the following connection properties:

• User: MySQL User name
• Password: MySQL Password
• Database: MySQL database name
• Server: MySQL Server name
• Port: MySQL port number like 3306
• UserSSH: "true"
• SSHAuthMode: "Public_Key"
• SSHPort: SSH Port number
• SSHServer: SSH Server name
• SSHUser: SSH User name
• SSHClientCret: the path for the public key certificate file

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

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

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

We have confirmed that the data is stored in Elasticsearch.

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