Class GrafanaBackend
java.lang.Object
io.jenkins.plugins.opentelemetry.backend.ObservabilityBackend
io.jenkins.plugins.opentelemetry.backend.GrafanaBackend
- All Implemented Interfaces:
ExtensionPoint
,Describable<ObservabilityBackend>
,TemplateBindingsProvider
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic class
static interface
List the attribute keys of the template bindings exposed byObservabilityBackend.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
FieldsFields inherited from class io.jenkins.plugins.opentelemetry.backend.ObservabilityBackend
ERROR_TEMPLATE, ICONS_PREFIX
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionboolean
Not yet instrumentedExtension point for Observability backends to contribute to the configuration properties used to instantiate the OpenTelemetry SDK.int
hashCode()
mergeBindings
(Map<String, Object> bindings) For extensionsnewLogStorageRetriever
(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
-
Field Details
-
DEFAULT_BACKEND_NAME
- See Also:
-
OTEL_GRAFANA_URL
- See Also:
-
DEFAULT_LOKI_DATA_SOURCE_IDENTIFIER
- See Also:
-
-
Constructor Details
-
GrafanaBackend
@DataBoundConstructor public GrafanaBackend()
-
-
Method Details
-
getTraceVisualisationUrlTemplate
- Specified by:
getTraceVisualisationUrlTemplate
in classObservabilityBackend
-
getMetricsVisualizationUrlTemplate
Not yet instrumented- Specified by:
getMetricsVisualizationUrlTemplate
in classObservabilityBackend
-
getIconPath
- Specified by:
getIconPath
in classObservabilityBackend
-
getEnvVariableName
- Specified by:
getEnvVariableName
in classObservabilityBackend
-
getDefaultName
- Specified by:
getDefaultName
in classObservabilityBackend
-
equals
- Specified by:
equals
in classObservabilityBackend
-
hashCode
public int hashCode()- Specified by:
hashCode
in classObservabilityBackend
-
mergeBindings
Description copied from class:ObservabilityBackend
For extensions- Specified by:
mergeBindings
in classObservabilityBackend
-
getBindings
- Specified by:
getBindings
in interfaceTemplateBindingsProvider
- Specified by:
getBindings
in classObservabilityBackend
-
newLogStorageRetriever
@CheckForNull public LogStorageRetriever newLogStorageRetriever(TemplateBindingsProvider templateBindingsProvider) - Overrides:
newLogStorageRetriever
in classObservabilityBackend
- Returns:
- the
LogStorageRetriever
of this backend if the backend is configured to retrieve logs.null
otherwise.
-
getGrafanaBaseUrl
-
setGrafanaBaseUrl
-
getTempoDataSourceIdentifier
-
setTempoDataSourceIdentifier
-
setGrafanaMetricsDashboard
-
getGrafanaOrgId
-
setGrafanaOrgId
-
getTempoQueryType
-
setTempoQueryType
-
getGrafanaLogsBackend
-
setGrafanaLogsBackend
-
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 classObservabilityBackend
-