Discover how a bimodal integration strategy can address the major data management challenges facing your organization today.
Get the Report →How to load Confluence data into Elasticsearch via Logstash
Introducing a simple method to load Confluence 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 Confluence to load data from Confluence into Elasticsearch via Logstash.
Using CData JDBC Driver for Confluence with Elasticsearch Logstash
- Install the CData JDBC Driver for Confluence 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 Confluence 20XX\lib\cdata.jdbc.confluence.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 Confluence data to Elasticsearch with Logstash
Now, let's create a configuration file for Logstash to transfer Confluence data to Elasticsearch.
- Write the process to retrieve Confluence 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 Confluence in the form of a JDBC URL. The JDBC URL allows detailed configuration, so please refer to the product documentation for more specifics.
- User: The user which will be used to authenticate with the Confluence server.
- APIToken: The API Token associated with the currently authenticated user.
- Url: The URL associated with your JIRA endpoint. For example, https://yoursitename.atlassian.net.
- User: The user which will be used to authenticate with the Confluence instance.
- Password: The password which will be used to authenticate with the Confluence server.
- Url: The URL associated with your JIRA endpoint. For example, https://yoursitename.atlassian.net.
Obtaining an API Token
An API token is necessary for account authentication. To generate one, login to your Atlassian account and navigate to API tokens > Create API token. The generated token will be displayed.
Connect Using a Confluence Cloud Account
To connect to a Cloud account, provide the following (Note: Password has been deprecated for connecting to a Cloud Account and is now used only to connect to a Server Instance.):
Connect Using a Confluence Server Instance
To connect to a Server instance, provide the following:
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 Confluence data has been loaded into Elasticsearch.
For example, let's view the data transferred to Elasticsearch in Kibana.
GET confluence_table/_search { "query": { "match_all": {} } }
We have confirmed that the data is stored in Elasticsearch.
By using the CData JDBC Driver for Confluence with Logstash, it functions as a Confluence connector, making it easy to load data into Elasticsearch. Please try the 30-day free trial.