Class ElasticBackend
java.lang.Object
io.jenkins.plugins.opentelemetry.backend.ObservabilityBackend
io.jenkins.plugins.opentelemetry.backend.ElasticBackend
- All Implemented Interfaces:
ExtensionPoint
,Describable<ObservabilityBackend>
,TemplateBindingsProvider
-
Nested Class Summary
Modifier 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
Modifier and TypeFieldDescriptionstatic final String
static final String
static final String
static final String
static final String
Fields inherited from class io.jenkins.plugins.opentelemetry.backend.ObservabilityBackend
ERROR_TEMPLATE, ICONS_PREFIX
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionboolean
static Optional<ElasticBackend>
get()
Extension point for Observability backends to contribute to the configuration properties used to instantiate the OpenTelemetry SDK.int
hashCode()
boolean
mergeBindings
(Map<String, Object> bindings) For extensionsnewLogStorageRetriever
(TemplateBindingsProvider templateBindingsProvider) void
setDisplayKibanaDashboardLink
(boolean displayKibanaDashboardLink) void
setElasticLogsBackend
(ElasticLogsBackend elasticLogsBackend) void
setKibanaBaseUrl
(String kibanaBaseUrl) void
setKibanaDashboardTitle
(String kibanaDashboardTitle) void
setKibanaDashboardUrlParameters
(String kibanaDashboardUrlParameters) void
setKibanaSpaceIdentifier
(String kibanaSpaceIdentifier) Methods inherited from class io.jenkins.plugins.opentelemetry.backend.ObservabilityBackend
allDescriptors, getDescriptor, getMetricsVisualizationUrl, getName, getTraceVisualisationUrl, setName
-
Field Details
-
OTEL_ELASTIC_URL
- See Also:
-
DEFAULT_BACKEND_NAME
- See Also:
-
DEFAULT_KIBANA_DASHBOARD_TITLE
- See Also:
-
DEFAULT_KIBANA_SPACE_IDENTIFIER
- See Also:
-
DEFAULT_KIBANA_DASHBOARD_QUERY_PARAMETERS
- See Also:
-
-
Constructor Details
-
ElasticBackend
@DataBoundConstructor public ElasticBackend()
-
-
Method Details
-
mergeBindings
Description copied from class:ObservabilityBackend
For extensions- Specified by:
mergeBindings
in classObservabilityBackend
-
getBindings
- Specified by:
getBindings
in interfaceTemplateBindingsProvider
- Specified by:
getBindings
in classObservabilityBackend
-
getTraceVisualisationUrlTemplate
- Specified by:
getTraceVisualisationUrlTemplate
in classObservabilityBackend
-
getKibanaBaseUrl
-
setKibanaBaseUrl
-
getIconPath
- Specified by:
getIconPath
in classObservabilityBackend
-
getEnvVariableName
- Specified by:
getEnvVariableName
in classObservabilityBackend
-
getDefaultName
- Specified by:
getDefaultName
in classObservabilityBackend
-
getMetricsVisualizationUrlTemplate
- Specified by:
getMetricsVisualizationUrlTemplate
in classObservabilityBackend
-
getElasticLogsBackend
-
setElasticLogsBackend
-
newLogStorageRetriever
@Nullable @MustBeClosed 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.
-
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
-
getKibanaSpaceIdentifier
-
setKibanaSpaceIdentifier
-
getKibanaDashboardTitle
-
setKibanaDashboardTitle
-
getKibanaDashboardUrlParameters
-
setKibanaDashboardUrlParameters
-
isDisplayKibanaDashboardLink
public boolean isDisplayKibanaDashboardLink() -
setDisplayKibanaDashboardLink
@DataBoundSetter public void setDisplayKibanaDashboardLink(boolean displayKibanaDashboardLink) -
equals
- Specified by:
equals
in classObservabilityBackend
-
hashCode
public int hashCode()- Specified by:
hashCode
in classObservabilityBackend
-
get
-