Package io.jenkins.plugins.opentelemetry.backend

Class ElasticBackend

java.lang.Object

io.jenkins.plugins.opentelemetry.backend.ObservabilityBackend

io.jenkins.plugins.opentelemetry.backend.ElasticBackend

All Implemented Interfaces:

ExtensionPoint, Describable<ObservabilityBackend>, TemplateBindingsProvider

public class ElasticBackend
extends ObservabilityBackend

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ElasticBackend.DescriptorImpl
static interface	ElasticBackend.TemplateBindings	List the attribute keys of the template bindings exposed by ObservabilityBackend.getBindings()

Nested classes/interfaces inherited from class io.jenkins.plugins.opentelemetry.backend.ObservabilityBackend

ObservabilityBackend.ObservabilityBackendDescriptor

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_BACKEND_NAME
static final String	DEFAULT_KIBANA_DASHBOARD_QUERY_PARAMETERS
static final String	DEFAULT_KIBANA_DASHBOARD_TITLE
static final String	DEFAULT_KIBANA_SPACE_IDENTIFIER
static final String	OTEL_ELASTIC_URL

Fields inherited from class io.jenkins.plugins.opentelemetry.backend.ObservabilityBackend

ERROR_TEMPLATE, ICONS_PREFIX

Constructor Summary

Constructors

Constructor	Description
ElasticBackend()

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
static Optional<ElasticBackend>	get()
Map<String,Object>	getBindings()
String	getDefaultName()
String	getEffectiveKibanaURL()	Returns the effective Kibana URL, including the space identifier if it is set.
ElasticLogsBackend	getElasticLogsBackend()
String	getEnvVariableName()
String	getIconPath()
String	getKibanaBaseUrl()
String	getKibanaDashboardTitle()
String	getKibanaDashboardUrlParameters()
String	getKibanaSpaceIdentifier()
String	getMetricsVisualizationUrlTemplate()
Map<String,String>	getOtelConfigurationProperties()	Extension point for Observability backends to contribute to the configuration properties used to instantiate the OpenTelemetry SDK.
String	getTraceVisualisationUrlTemplate()
int	hashCode()
boolean	isDisplayKibanaDashboardLink()
boolean	isEnableEDOT()
Map<String,Object>	mergeBindings(Map<String,Object> bindings)	For extensions
LogStorageRetriever	newLogStorageRetriever(TemplateBindingsProvider templateBindingsProvider)
void	setDisplayKibanaDashboardLink(boolean displayKibanaDashboardLink)
void	setElasticLogsBackend(ElasticLogsBackend elasticLogsBackend)
void	setEnableEDOT(boolean enableEDOT)
void	setKibanaBaseUrl(String kibanaBaseUrl)
void	setKibanaDashboardTitle(String kibanaDashboardTitle)
void	setKibanaDashboardUrlParameters(String kibanaDashboardUrlParameters)
void	setKibanaSpaceIdentifier(String kibanaSpaceIdentifier)

Methods inherited from class io.jenkins.plugins.opentelemetry.backend.ObservabilityBackend

allDescriptors, getDescriptor, getMetricsVisualizationUrl, getName, getTraceVisualisationUrl, setName

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Details

OTEL_ELASTIC_URL

public static final String OTEL_ELASTIC_URL

See Also:

• Constant Field Values

DEFAULT_BACKEND_NAME

public static final String DEFAULT_BACKEND_NAME

See Also:

• Constant Field Values

DEFAULT_KIBANA_DASHBOARD_TITLE

public static final String DEFAULT_KIBANA_DASHBOARD_TITLE

See Also:

• Constant Field Values

DEFAULT_KIBANA_SPACE_IDENTIFIER

public static final String DEFAULT_KIBANA_SPACE_IDENTIFIER

See Also:

• Constant Field Values

DEFAULT_KIBANA_DASHBOARD_QUERY_PARAMETERS

public static final String DEFAULT_KIBANA_DASHBOARD_QUERY_PARAMETERS

See Also:

• Constant Field Values

Constructor Details

ElasticBackend

@DataBoundConstructor
public ElasticBackend()

Method Details

mergeBindings

public Map<String,Object> mergeBindings(Map<String,Object> bindings)

Description copied from class: ObservabilityBackend

For extensions

Specified by:

mergeBindings in class ObservabilityBackend

getBindings

public Map<String,Object> getBindings()

Specified by:

getBindings in interface TemplateBindingsProvider

Specified by:

getBindings in class ObservabilityBackend

getTraceVisualisationUrlTemplate

@CheckForNull
public String getTraceVisualisationUrlTemplate()

Specified by:

getTraceVisualisationUrlTemplate in class ObservabilityBackend

getKibanaBaseUrl

@CheckForNull
public String getKibanaBaseUrl()

setKibanaBaseUrl

@DataBoundSetter
public void setKibanaBaseUrl(String kibanaBaseUrl)

getIconPath

@CheckForNull
public String getIconPath()

Specified by:

getIconPath in class ObservabilityBackend

getEnvVariableName

@CheckForNull
public String getEnvVariableName()

Specified by:

getEnvVariableName in class ObservabilityBackend

getDefaultName

@CheckForNull
public String getDefaultName()

Specified by:

getDefaultName in class ObservabilityBackend

getMetricsVisualizationUrlTemplate

@CheckForNull
public String getMetricsVisualizationUrlTemplate()

Specified by:

getMetricsVisualizationUrlTemplate in class ObservabilityBackend

getElasticLogsBackend

public ElasticLogsBackend getElasticLogsBackend()

setElasticLogsBackend

@DataBoundSetter
public void setElasticLogsBackend(ElasticLogsBackend elasticLogsBackend)

newLogStorageRetriever

@Nullable
@MustBeClosed
public LogStorageRetriever newLogStorageRetriever(TemplateBindingsProvider templateBindingsProvider)

Overrides:

newLogStorageRetriever in class ObservabilityBackend

Returns:

the LogStorageRetriever of this backend if the backend is configured to retrieve logs. null otherwise.

getOtelConfigurationProperties

@NonNull
public Map<String,String> getOtelConfigurationProperties()

Description copied from class: ObservabilityBackend

Extension point for Observability backends to contribute to the configuration properties used to instantiate the OpenTelemetry SDK.

Overrides:

getOtelConfigurationProperties in class ObservabilityBackend

getKibanaSpaceIdentifier

@NonNull
public String getKibanaSpaceIdentifier()

setKibanaSpaceIdentifier

@DataBoundSetter
public void setKibanaSpaceIdentifier(String kibanaSpaceIdentifier)

getKibanaDashboardTitle

@NonNull
public String getKibanaDashboardTitle()

setKibanaDashboardTitle

@DataBoundSetter
public void setKibanaDashboardTitle(String kibanaDashboardTitle)

getKibanaDashboardUrlParameters

public String getKibanaDashboardUrlParameters()

setKibanaDashboardUrlParameters

@DataBoundSetter
public void setKibanaDashboardUrlParameters(String kibanaDashboardUrlParameters)

isDisplayKibanaDashboardLink

public boolean isDisplayKibanaDashboardLink()

setDisplayKibanaDashboardLink

@DataBoundSetter
public void setDisplayKibanaDashboardLink(boolean displayKibanaDashboardLink)

isEnableEDOT

public boolean isEnableEDOT()

setEnableEDOT

@DataBoundSetter
public void setEnableEDOT(boolean enableEDOT)

getEffectiveKibanaURL

@NonNull
public String getEffectiveKibanaURL()

Returns the effective Kibana URL, including the space identifier if it is set.

Returns:

the effective Kibana URL

equals

public boolean equals(Object o)

Specified by:

equals in class ObservabilityBackend

hashCode

public int hashCode()

Specified by:

hashCode in class ObservabilityBackend

get

public static Optional<ElasticBackend> get()