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 Classes Modifier and Type Class Description static class
ObservabilityBackend.ObservabilityBackendDescriptor
static interface
ObservabilityBackend.TemplateBindings
List the attribute keys of the template bindings exposed bygetBindings()
-
Nested classes/interfaces inherited from interface hudson.ExtensionPoint
ExtensionPoint.LegacyInstancesAreScopedToHudson
-
-
Field Summary
Fields Modifier and Type Field Description static groovy.text.Template
ERROR_TEMPLATE
static String
ICONS_PREFIX
-
Constructor Summary
Constructors Constructor Description ObservabilityBackend()
-
Method Summary
-
-
-
Field Detail
-
ICONS_PREFIX
public static final String ICONS_PREFIX
- See Also:
- Constant Field Values
-
ERROR_TEMPLATE
public static final groovy.text.Template ERROR_TEMPLATE
-
-
Method Detail
-
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()
-
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. Notnull
or empty.
-
setName
@DataBoundSetter public void setName(String name)
-
getTraceVisualisationUrl
@CheckForNull public String getTraceVisualisationUrl(Map<String,Object> bindings)
- Returns:
null
if nogetTraceVisualisationUrlTemplate()
has been defined or if thegetMetricsVisualizationUrlTemplate()
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 interfaceTemplateBindingsProvider
-
getDescriptor
public Descriptor<ObservabilityBackend> getDescriptor()
- Specified by:
getDescriptor
in interfaceDescribable<ObservabilityBackend>
-
allDescriptors
public static DescriptorExtensionList<ObservabilityBackend,ObservabilityBackend.ObservabilityBackendDescriptor> allDescriptors()
Returns all the registeredObservabilityBackend
descriptors. Used by the GUI
-
-