Package io.jenkins.plugins.opentelemetry.backend.grafana

Class GrafanaLogsBackend

java.lang.Object

hudson.model.AbstractDescribableImpl<GrafanaLogsBackend>

io.jenkins.plugins.opentelemetry.backend.grafana.GrafanaLogsBackend

All Implemented Interfaces:

ExtensionPoint, Describable<GrafanaLogsBackend>

Direct Known Subclasses:

GrafanaLogsBackendBackendWithLogMirroringInJenkins, GrafanaLogsBackendWithJenkinsVisualization, GrafanaLogsBackendWithoutJenkinsVisualization, NoGrafanaLogsBackend

public abstract class GrafanaLogsBackend
extends AbstractDescribableImpl<GrafanaLogsBackend>
implements ExtensionPoint

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GrafanaLogsBackend.DescriptorImpl
static enum	GrafanaLogsBackend.LokiOTelLogFormat

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields

Modifier and Type	Field	Description
protected GrafanaLogsBackend.LokiOTelLogFormat	lokiOTelLogFormat

Constructor Summary

Constructors

Constructor	Description
GrafanaLogsBackend()

Method Summary

Modifier and Type	Method	Description
static DescriptorExtensionList<GrafanaLogsBackend,Descriptor<GrafanaLogsBackend>>	all()	Returns all the registered GrafanaLogsBackend descriptors.
groovy.text.Template	getBuildLogsVisualizationMessageTemplate()
groovy.text.Template	getBuildLogsVisualizationUrlTemplate()
GrafanaLogsBackend.DescriptorImpl	getDescriptor()
String	getLokiOTelLogFormat()
Map<String,String>	getOtelConfigurationProperties()
abstract LogStorageRetriever	newLogStorageRetriever(TemplateBindingsProvider templateBindingsProvider)	Returns null if the backend is not capable of retrieving logs(ie the NoGrafanaLogsBackend
void	setLokiOTelLogFormat(String lokiOTelLogFormat)

Methods inherited from class java.lang.Object

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

Field Details

lokiOTelLogFormat

protected GrafanaLogsBackend.LokiOTelLogFormat lokiOTelLogFormat

Constructor Details

GrafanaLogsBackend

public GrafanaLogsBackend()

Method Details

newLogStorageRetriever

@CheckForNull
@MustBeClosed
public abstract LogStorageRetriever newLogStorageRetriever(TemplateBindingsProvider templateBindingsProvider)

Returns null if the backend is not capable of retrieving logs(ie the NoGrafanaLogsBackend

getBuildLogsVisualizationMessageTemplate

@NonNull
public groovy.text.Template getBuildLogsVisualizationMessageTemplate()

getBuildLogsVisualizationUrlTemplate

@NonNull
public groovy.text.Template getBuildLogsVisualizationUrlTemplate()

getOtelConfigurationProperties

public Map<String,String> getOtelConfigurationProperties()

getDescriptor

public GrafanaLogsBackend.DescriptorImpl getDescriptor()

Specified by:

getDescriptor in interface Describable<GrafanaLogsBackend>

Overrides:

getDescriptor in class AbstractDescribableImpl<GrafanaLogsBackend>

getLokiOTelLogFormat

@NonNull
public String getLokiOTelLogFormat()

setLokiOTelLogFormat

@DataBoundSetter
public void setLokiOTelLogFormat(String lokiOTelLogFormat)

all

public static DescriptorExtensionList<GrafanaLogsBackend,Descriptor<GrafanaLogsBackend>> all()

Returns all the registered GrafanaLogsBackend descriptors.