Package io.jenkins.plugins.opentelemetry.backend

Class ObservabilityBackend

java.lang.Object

io.jenkins.plugins.opentelemetry.backend.ObservabilityBackend

All Implemented Interfaces:

ExtensionPoint, Describable<ObservabilityBackend>, TemplateBindingsProvider

Direct Known Subclasses:

CustomObservabilityBackend, DynatraceBackend, DynatraceGrailBackend, ElasticBackend, GrafanaBackend, JaegerBackend, ZipkinBackend

public abstract class ObservabilityBackend
extends Object
implements Describable<ObservabilityBackend>, ExtensionPoint, TemplateBindingsProvider

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields

Modifier and Type	Field	Description
static final groovy.text.Template	ERROR_TEMPLATE
static final String	ICONS_PREFIX

Constructor Summary

Constructors

Constructor	Description
ObservabilityBackend()

Method Summary

Modifier and Type	Method	Description
static DescriptorExtensionList<ObservabilityBackend,ObservabilityBackend.ObservabilityBackendDescriptor>	allDescriptors()	Returns all the registered ObservabilityBackend descriptors.
abstract boolean	equals(Object obj)
abstract Map<String,Object>	getBindings()
abstract String	getDefaultName()
Descriptor<ObservabilityBackend>	getDescriptor()
abstract String	getEnvVariableName()
abstract String	getIconPath()
String	getMetricsVisualizationUrl(io.opentelemetry.sdk.resources.Resource resource)
abstract String	getMetricsVisualizationUrlTemplate()
String	getName()	Returns the specified backend name or the default name.
Map<String,String>	getOtelConfigurationProperties()	Extension point for Observability backends to contribute to the configuration properties used to instantiate the OpenTelemetry SDK.
String	getTraceVisualisationUrl(Map<String,Object> bindings)
abstract String	getTraceVisualisationUrlTemplate()
abstract int	hashCode()
abstract Map<String,Object>	mergeBindings(Map<String,Object> bindings)	For extensions
LogStorageRetriever	newLogStorageRetriever(TemplateBindingsProvider templateBindingsProvider)
void	setName(String name)

Methods inherited from class java.lang.Object

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

Field Details

ICONS_PREFIX

public static final String ICONS_PREFIX

See Also:

• Constant Field Values

ERROR_TEMPLATE

public static final groovy.text.Template ERROR_TEMPLATE

Constructor Details

ObservabilityBackend

public ObservabilityBackend()

Method Details

getTraceVisualisationUrlTemplate

@CheckForNull
public abstract String getTraceVisualisationUrlTemplate()

getMetricsVisualizationUrlTemplate

@CheckForNull
public abstract String getMetricsVisualizationUrlTemplate()

getIconPath

@CheckForNull
public abstract String getIconPath()

getEnvVariableName

@CheckForNull
public abstract String getEnvVariableName()

getDefaultName

@CheckForNull
public abstract String getDefaultName()

equals

public abstract boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public abstract int hashCode()

Overrides:

hashCode in class Object

newLogStorageRetriever

@CheckForNull
@MustBeClosed
public LogStorageRetriever newLogStorageRetriever(TemplateBindingsProvider templateBindingsProvider)

Returns:

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

mergeBindings

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

For extensions

getName

public String getName()

Returns the specified backend name or the default name. Not null or empty.

setName

@DataBoundSetter
public void setName(String name)

getTraceVisualisationUrl

@CheckForNull
public String getTraceVisualisationUrl(Map<String,Object> bindings)

Returns:

null if no getTraceVisualisationUrlTemplate() has been defined or if the getMetricsVisualizationUrlTemplate() has a syntax error

getMetricsVisualizationUrl

public String getMetricsVisualizationUrl(io.opentelemetry.sdk.resources.Resource resource)

getBindings

public abstract Map<String,Object> getBindings()

Specified by:

getBindings in interface TemplateBindingsProvider

getDescriptor

public Descriptor<ObservabilityBackend> getDescriptor()

Specified by:

getDescriptor in interface Describable<ObservabilityBackend>

allDescriptors

public static DescriptorExtensionList<ObservabilityBackend,ObservabilityBackend.ObservabilityBackendDescriptor> allDescriptors()

Returns all the registered ObservabilityBackend descriptors. Used by the GUI

getOtelConfigurationProperties

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

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