Skip to main content
Version: 8.4 / 3.12.0

Elasticsearch header

Before implementing the plugin, make sure that you have set up your environment.

This feature allows you to register your own hook into the Optimize Elasticsearch client, allowing you to add custom headers to all requests made to Elasticsearch. The plugin is invoked before every request to Elasticsearch is made, allowing different headers and values to be added per request. This plugin is also loaded during the update and reimport.

For that, the Optimize plugin system provides the following interface:

public interface ElasticsearchCustomHeaderSupplier {

CustomHeader getElasticsearchCustomHeader();

Implement this interface and return the custom header you would like to be added to Elasticsearch requests. The CustomHeader class has a single Constructor taking two arguments, as follows:

public CustomHeader(String headerName, String headerValue)

The following example returns a header that will be added:

package com.example.optimize.elasticsearch.headers;

import org.camunda.optimize.plugin.elasticsearch.CustomHeader;
import org.camunda.optimize.plugin.elasticsearch.ElasticsearchCustomHeaderSupplier;

public class AddAuthorizationHeaderPlugin implements ElasticsearchCustomHeaderSupplier {

private String currentToken;

public CustomHeader getElasticsearchCustomHeader() {
if (currentToken == null || currentTokenExpiresWithinFifteenMinutes()) {
currentToken = fetchNewToken();
return new CustomHeader("Authorization", currentToken);

Similar to the other plugins' setup, you have to package your plugin in a jar, add it to Optimize's plugin folder, and make Optimize find it by adding the following configuration to environment-config.yaml:

# Look in the given base package list for Elasticsearch custom header fetching plugins.
# If empty, ES requests are not influenced.
basePackages: ["com.example.optimize.elasticsearch.headers"]

For more information and example implementations, have a look at the Optimize Examples Repository.