How to load Nuclia data into Elasticsearch via Logstash

Mohsin Turki
Mohsin Turki
Technical Marketing Engineer
Introducing a simple method to load Nuclia 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 Nuclia to load data from Nuclia into Elasticsearch via Logstash.

Using CData JDBC Driver for Nuclia with Elasticsearch Logstash

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

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

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

    Nuclia uses API key authentication for accessing Knowledge Box data. To obtain an API key:

    1. Log in to the Nuclia Cloud Dashboard at https://nuclia.cloud
    2. Navigate to your Knowledge Box settings
    3. Go to the Service Accounts section
    4. Create a new service account or copy an existing API key

    After obtaining your API key, set the following connection properties:

    • AuthScheme: Set this to APIKey.
    • APIKey: Set this to your Nuclia service account API key.
    • KbId: Set this to your Knowledge Box UUID.
    • Zone: Set this to your Nuclia deployment zone (e.g., aws-us-east-2-1).

    Example Connection String

    Profile=C:\profiles\Nuclia.apip;AuthScheme=APIKey;APIKey=your_service_account_key;KbId=your_kb_uuid;Zone=aws-us-east-2-1;
    

    Connecting to Nuclia

    Once the authentication is configured, you can connect to Nuclia and query data from any of the available tables such as Resources, KnowledgeBox, LabelSets, and ProcessingStatus.

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

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

    GET api_table/_search
    {
        "query": {
            "match_all": {}
        }
    }
Querying the Nuclia data loaded into Elasticsearch

We have confirmed that the data is stored in Elasticsearch.

Confirming the Nuclia data loaded into Elasticsearch

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

Ready to get started?

Connect to live data from Nuclia with the API Driver

Connect to Nuclia