Class ObservabilityBackend
java.lang.Object
io.jenkins.plugins.opentelemetry.backend.ObservabilityBackend
- All Implemented Interfaces:
ExtensionPoint
,Describable<ObservabilityBackend>
,TemplateBindingsProvider
- Direct Known Subclasses:
CustomObservabilityBackend
,DynatraceBackend
,ElasticBackend
,GrafanaBackend
,JaegerBackend
,ZipkinBackend
public abstract class ObservabilityBackend
extends Object
implements Describable<ObservabilityBackend>, ExtensionPoint, TemplateBindingsProvider
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic class
static interface
List the attribute keys of the template bindings exposed bygetBindings()
Nested classes/interfaces inherited from interface hudson.ExtensionPoint
ExtensionPoint.LegacyInstancesAreScopedToHudson
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic DescriptorExtensionList<ObservabilityBackend,
ObservabilityBackend.ObservabilityBackendDescriptor> Returns all the registeredObservabilityBackend
descriptors.abstract boolean
abstract String
abstract String
abstract String
getMetricsVisualizationUrl
(io.opentelemetry.sdk.resources.Resource resource) abstract String
getName()
Returns the specified backend name or the default name.Extension point for Observability backends to contribute to the configuration properties used to instantiate the OpenTelemetry SDK.getTraceVisualisationUrl
(Map<String, Object> bindings) abstract String
abstract int
hashCode()
mergeBindings
(Map<String, Object> bindings) For extensionsnewLogStorageRetriever
(TemplateBindingsProvider templateBindingsProvider) void
-
Field Details
-
ICONS_PREFIX
- See Also:
-
ERROR_TEMPLATE
public static final groovy.text.Template ERROR_TEMPLATE
-
-
Constructor Details
-
ObservabilityBackend
public ObservabilityBackend()
-
-
Method Details
-
getTraceVisualisationUrlTemplate
-
getMetricsVisualizationUrlTemplate
-
getIconPath
-
getEnvVariableName
-
getDefaultName
-
equals
-
hashCode
public abstract int hashCode() -
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
For extensions -
getName
Returns the specified backend name or the default name. Notnull
or empty. -
setName
-
getTraceVisualisationUrl
- Returns:
null
if nogetTraceVisualisationUrlTemplate()
has been defined or if thegetMetricsVisualizationUrlTemplate()
has a syntax error
-
getMetricsVisualizationUrl
-
getBindings
- Specified by:
getBindings
in interfaceTemplateBindingsProvider
-
getDescriptor
- Specified by:
getDescriptor
in interfaceDescribable<ObservabilityBackend>
-
allDescriptors
public static DescriptorExtensionList<ObservabilityBackend,ObservabilityBackend.ObservabilityBackendDescriptor> allDescriptors()Returns all the registeredObservabilityBackend
descriptors. Used by the GUI -
getOtelConfigurationProperties
Extension point for Observability backends to contribute to the configuration properties used to instantiate the OpenTelemetry SDK.
-