com.increff.commons.es.ESClient Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of commons-gelf-springboot Show documentation
This library is useful for logging HTTP requests and responses using the GELF protocol to Graylog and to ELK for monitoring.
The newest version!
/*
 * Copyright (c) 2021. Increff
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
 * in compliance with the License. You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software distributed under the License
 * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
 * or implied. See the License for the specific language governing permissions and limitations under
 * the License.
 */

package com.increff.commons.es;

import co.elastic.clients.elasticsearch.ElasticsearchAsyncClient;
import co.elastic.clients.elasticsearch.core.IndexRequest;
import co.elastic.clients.json.jackson.JacksonJsonpMapper;
import co.elastic.clients.transport.rest_client.RestClientTransport;
import lombok.extern.log4j.Log4j2;
import org.apache.http.Header;
import org.apache.http.HttpHost;
import org.apache.http.message.BasicHeader;
import org.elasticsearch.client.*;

import java.io.IOException;
import java.io.PrintWriter;
import java.io.StringReader;
import java.io.StringWriter;
import java.time.LocalDate;
import java.util.Base64;

/**
 * This class represents an Elasticsearch client with asynchronous capabilities.
 * It is responsible for sending requests to Elasticsearch and handling the responses.
 * It also maintains metrics related to the requests and responses.
 */
@Log4j2
public class ESClient {

	/**
	 * The Elasticsearch client used to interact with the Elasticsearch server.
	 */
	private ElasticsearchAsyncClient client;

	/**
	 * The metrics object used to keep track of the number of requests processed, successful, and dropped.
	 */
	private ESMetrics metrics;


	/**
	 * Constructor of EsClient
	 * @param baseUrl URL of server
	 * @param port Port exposed of server
	 * @param user username
	 * @param password password
	 */
	public ESClient(String baseUrl, int port, String user, String password) {

		HttpHost httpHost = new HttpHost(baseUrl, port, "http");
		RestClient httpClient = RestClient.builder(httpHost)
				.setDefaultHeaders(new Header[]{new BasicHeader("Authorization", getBasicAuth(user, password))})
				.build();
		this.metrics = new ESMetrics();
		RestClientTransport transport = new RestClientTransport(httpClient, new JacksonJsonpMapper());
		this.client = new ElasticsearchAsyncClient(transport);
	}

	private String getBasicAuth(String username, String password) {
		String encodedAuth = Base64.getEncoder().encodeToString(String.format("%s:%s", username, password).getBytes());
		return String.format("Basic %s", encodedAuth);
	}

	/**
	 * Sends an asynchronous request to Elasticsearch.
	 * This method first encodes the given ESRequest into a JSON string.
	 * If an exception occurs during encoding, it is caught and logged.
	 * The JSON string is then used to create an IndexRequest, which is sent to Elasticsearch.
	 * If an exception occurs during the request, it is caught, logged, and the metrics are updated accordingly.
	 * If the request is successful, the metrics are updated to reflect the success.
	 *
	 * @param req The ESRequest to be sent to Elasticsearch.
	 */
	public void send(ESRequest req) {
		String json = null;
		try {
			json = ESEncoder.getJson(req);
		} catch (Exception e) {
			String errorStackTrace = getErrorStackTraceString(e);
			log.info("EsClient:IOException: Json Encoding Failed\n" + errorStackTrace);
		}
		StringReader jsonStringReader = new StringReader(json);
		client.index(i -> {
			IndexRequest.Builder