How to load Mocean data into Elasticsearch via Logstash

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

Using CData JDBC Driver for Mocean with Elasticsearch Logstash

  • Install the CData JDBC Driver for Mocean 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 Mocean data to Elasticsearch with Logstash

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

  • Write the process to retrieve Mocean 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 Mocean 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

    Mocean uses API key authentication to control access to the API. To obtain an API Key:

    1. Log in to your Mocean account at https://dashboard.moceanapi.com
    2. Navigate to your account settings or API credentials section
    3. Copy your API Key

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

    • AuthScheme: Set this to APIKey.
    Set the following in the ProfileSettings connection property:
    • APIKey: Set this to your Mocean API Key. This is transmitted as a Bearer token in the Authorization header.

    Example Connection String

    Profile=C:\profiles\Mocean.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_api_key';
    

    Connecting to Mocean

    Once the authentication is configured, you can connect to Mocean and query data from any of the available tables such as AccountBalance, AccountPricing, MessageStatus, and NumberLookup.

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 Mocean 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 Mocean data loaded into Elasticsearch

We have confirmed that the data is stored in Elasticsearch.

Confirming the Mocean data loaded into Elasticsearch

By using the CData JDBC Driver for Mocean with Logstash, it functions as a Mocean 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 Mocean with the API Driver

Connect to Mocean