How to load Freshdesk data into Elasticsearch via Logstash



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

Using CData JDBC Driver for Freshdesk with Elasticsearch Logstash

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

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

  • Write the process to retrieve Freshdesk 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 Freshdesk in the form of a JDBC URL. The JDBC URL allows detailed configuration, so please refer to the product documentation for more specifics.
  • FreshDesk makes use of basic authentication. To connect to data, set the following connection properties:

    • Domain: Set this to the domain associated with your FreshDesk account. For example, in your URL: https://my_domain.freshdesk.com.
    • APIKey: Set this to the API key associated with your FreshDesk account. To retrieve your API key, Log into your support Portal -> Click on profile picture in the top right corner -> profile settings page. The API key will be available below the change password section to the right.

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

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

    GET freshdesk_table/_search
    {
        "query": {
            "match_all": {}
        }
    }
Querying the Freshdesk data loaded into Elasticsearch

We have confirmed that the data is stored in Elasticsearch.

Confirming the Freshdesk data loaded into Elasticsearch

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

 Download Now

Learn more:

Freshdesk Icon Freshdesk JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with Freshdesk.