Class ElasticBackend
- java.lang.Object
-
- io.jenkins.plugins.opentelemetry.backend.ObservabilityBackend
-
- io.jenkins.plugins.opentelemetry.backend.ElasticBackend
-
- All Implemented Interfaces:
ExtensionPoint
,Describable<ObservabilityBackend>
,TemplateBindingsProvider
public class ElasticBackend extends ObservabilityBackend
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
ElasticBackend.DescriptorImpl
static interface
ElasticBackend.TemplateBindings
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
Fields Modifier and Type Field Description static String
DEFAULT_BACKEND_NAME
static String
DEFAULT_KIBANA_DASHBOARD_QUERY_PARAMETERS
static String
DEFAULT_KIBANA_DASHBOARD_TITLE
static String
DEFAULT_KIBANA_SPACE_IDENTIFIER
static String
OTEL_ELASTIC_URL
-
Fields inherited from class io.jenkins.plugins.opentelemetry.backend.ObservabilityBackend
ERROR_TEMPLATE, ICONS_PREFIX
-
-
Constructor Summary
Constructors Constructor Description ElasticBackend()
-
Method Summary
-
Methods inherited from class io.jenkins.plugins.opentelemetry.backend.ObservabilityBackend
allDescriptors, getDescriptor, getMetricsVisualizationUrl, getName, getTraceVisualisationUrl, setName
-
-
-
-
Field Detail
-
OTEL_ELASTIC_URL
public static final String OTEL_ELASTIC_URL
- See Also:
- Constant Field Values
-
DEFAULT_BACKEND_NAME
public static final String DEFAULT_BACKEND_NAME
- See Also:
- Constant Field Values
-
DEFAULT_KIBANA_DASHBOARD_TITLE
public static final String DEFAULT_KIBANA_DASHBOARD_TITLE
- See Also:
- Constant Field Values
-
DEFAULT_KIBANA_SPACE_IDENTIFIER
public static final String DEFAULT_KIBANA_SPACE_IDENTIFIER
- See Also:
- Constant Field Values
-
DEFAULT_KIBANA_DASHBOARD_QUERY_PARAMETERS
public static final String DEFAULT_KIBANA_DASHBOARD_QUERY_PARAMETERS
- See Also:
- Constant Field Values
-
-
Method Detail
-
mergeBindings
public Map<String,Object> mergeBindings(Map<String,Object> bindings)
Description copied from class:ObservabilityBackend
For extensions- Specified by:
mergeBindings
in classObservabilityBackend
-
getBindings
public Map<String,Object> getBindings()
- Specified by:
getBindings
in interfaceTemplateBindingsProvider
- Specified by:
getBindings
in classObservabilityBackend
-
getTraceVisualisationUrlTemplate
@CheckForNull public String getTraceVisualisationUrlTemplate()
- Specified by:
getTraceVisualisationUrlTemplate
in classObservabilityBackend
-
getKibanaBaseUrl
@CheckForNull public String getKibanaBaseUrl()
-
setKibanaBaseUrl
@DataBoundSetter public void setKibanaBaseUrl(String kibanaBaseUrl)
-
getIconPath
@CheckForNull public String getIconPath()
- Specified by:
getIconPath
in classObservabilityBackend
-
getEnvVariableName
@CheckForNull public String getEnvVariableName()
- Specified by:
getEnvVariableName
in classObservabilityBackend
-
getDefaultName
@CheckForNull public String getDefaultName()
- Specified by:
getDefaultName
in classObservabilityBackend
-
getMetricsVisualizationUrlTemplate
@CheckForNull public String getMetricsVisualizationUrlTemplate()
- Specified by:
getMetricsVisualizationUrlTemplate
in classObservabilityBackend
-
getElasticLogsBackend
public ElasticLogsBackend getElasticLogsBackend()
-
setElasticLogsBackend
@DataBoundSetter public void setElasticLogsBackend(ElasticLogsBackend elasticLogsBackend)
-
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
@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 classObservabilityBackend
-
getKibanaSpaceIdentifier
@NonNull public String getKibanaSpaceIdentifier()
-
setKibanaSpaceIdentifier
@DataBoundSetter public void setKibanaSpaceIdentifier(String kibanaSpaceIdentifier)
-
getKibanaDashboardTitle
@NonNull public String getKibanaDashboardTitle()
-
setKibanaDashboardTitle
@DataBoundSetter public void setKibanaDashboardTitle(String kibanaDashboardTitle)
-
getKibanaDashboardUrlParameters
public String getKibanaDashboardUrlParameters()
-
setKibanaDashboardUrlParameters
@DataBoundSetter public void setKibanaDashboardUrlParameters(String kibanaDashboardUrlParameters)
-
isDisplayKibanaDashboardLink
public boolean isDisplayKibanaDashboardLink()
-
setDisplayKibanaDashboardLink
@DataBoundSetter public void setDisplayKibanaDashboardLink(boolean displayKibanaDashboardLink)
-
equals
public boolean equals(Object o)
- Specified by:
equals
in classObservabilityBackend
-
hashCode
public int hashCode()
- Specified by:
hashCode
in classObservabilityBackend
-
get
public static Optional<ElasticBackend> get()
-
-