Package io.jenkins.plugins.opentelemetry.backend

Class GrafanaBackend

java.lang.Object

io.jenkins.plugins.opentelemetry.backend.ObservabilityBackend

io.jenkins.plugins.opentelemetry.backend.GrafanaBackend

All Implemented Interfaces:

ExtensionPoint, Describable<ObservabilityBackend>, TemplateBindingsProvider

public class GrafanaBackend
extends ObservabilityBackend

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GrafanaBackend.DescriptorImpl
static interface	GrafanaBackend.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 String	DEFAULT_BACKEND_NAME
static String	DEFAULT_LOKI_DATA_SOURCE_IDENTIFIER
static String	OTEL_GRAFANA_URL

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

ERROR_TEMPLATE, ICONS_PREFIX

Constructor Summary

Constructors

Constructor	Description
GrafanaBackend()

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
Map<String,Object>	getBindings()
String	getDefaultName()
String	getEnvVariableName()
String	getGrafanaBaseUrl()
GrafanaLogsBackend	getGrafanaLogsBackend()
String	getGrafanaOrgId()
String	getIconPath()
String	getMetricsVisualizationUrlTemplate()	Not yet instrumented
Map<String,String>	getOtelConfigurationProperties()	Extension point for Observability backends to contribute to the configuration properties used to instantiate the OpenTelemetry SDK.
String	getTempoDataSourceIdentifier()
String	getTempoQueryType()
String	getTraceVisualisationUrlTemplate()
int	hashCode()
Map<String,Object>	mergeBindings(Map<String,Object> bindings)	For extensions
LogStorageRetriever	newLogStorageRetriever(TemplateBindingsProvider templateBindingsProvider)
void	setGrafanaBaseUrl(String grafanaBaseUrl)
void	setGrafanaLogsBackend(GrafanaLogsBackend grafanaLogsBackend)
void	setGrafanaMetricsDashboard(String grafanaMetricsDashboard)
void	setGrafanaOrgId(String grafanaOrgId)
void	setTempoDataSourceIdentifier(String tempoDataSourceIdentifier)
void	setTempoQueryType(String tempoQueryType)

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 Detail

DEFAULT_BACKEND_NAME

public static final String DEFAULT_BACKEND_NAME

See Also:

Constant Field Values

OTEL_GRAFANA_URL

public static final String OTEL_GRAFANA_URL

See Also:

Constant Field Values

DEFAULT_LOKI_DATA_SOURCE_IDENTIFIER

public static final String DEFAULT_LOKI_DATA_SOURCE_IDENTIFIER

See Also:

Constant Field Values

Constructor Detail

GrafanaBackend

@DataBoundConstructor
public GrafanaBackend()

Method Detail

getTraceVisualisationUrlTemplate

@Nullable
public String getTraceVisualisationUrlTemplate()

Specified by:

getTraceVisualisationUrlTemplate in class ObservabilityBackend

getMetricsVisualizationUrlTemplate

@Nullable
public String getMetricsVisualizationUrlTemplate()

Not yet instrumented

Specified by:

getMetricsVisualizationUrlTemplate in class ObservabilityBackend

getIconPath

@Nullable
public String getIconPath()

Specified by:

getIconPath in class ObservabilityBackend

getEnvVariableName

@Nullable
public String getEnvVariableName()

Specified by:

getEnvVariableName in class ObservabilityBackend

getDefaultName

@Nullable
public String getDefaultName()

Specified by:

getDefaultName in class ObservabilityBackend

equals

public boolean equals(Object o)

Specified by:

equals in class ObservabilityBackend

hashCode

public int hashCode()

Specified by:

hashCode in class ObservabilityBackend

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

newLogStorageRetriever

@CheckForNull
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.

getGrafanaBaseUrl

public String getGrafanaBaseUrl()

setGrafanaBaseUrl

@DataBoundSetter
public void setGrafanaBaseUrl(String grafanaBaseUrl)

getTempoDataSourceIdentifier

@DataBoundSetter
public String getTempoDataSourceIdentifier()

setTempoDataSourceIdentifier

@DataBoundSetter
public void setTempoDataSourceIdentifier(String tempoDataSourceIdentifier)

setGrafanaMetricsDashboard

@DataBoundSetter
public void setGrafanaMetricsDashboard(String grafanaMetricsDashboard)

getGrafanaOrgId

public String getGrafanaOrgId()

setGrafanaOrgId

@DataBoundSetter
public void setGrafanaOrgId(String grafanaOrgId)

getTempoQueryType

@DataBoundSetter
public String getTempoQueryType()

setTempoQueryType

@DataBoundSetter
public void setTempoQueryType(String tempoQueryType)

getGrafanaLogsBackend

@CheckForNull
public GrafanaLogsBackend getGrafanaLogsBackend()

setGrafanaLogsBackend

@DataBoundSetter
public void setGrafanaLogsBackend(GrafanaLogsBackend grafanaLogsBackend)

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