DiagnosticComponent

public interface DiagnosticComponent

Data component that can be attached to an Entity to provide diagnostic information, in the form of metrics and healthchecks.

Method Summary

Modifier and Type

Method

Description

SortedMap<String,IdentifiedHealthCheckResult>

getHealthChecks()

SortedMap<String,IdentifiedMetric>

getMetrics()

default List<String>

getOverviewMetrics()

Method Details
- getOverviewMetrics
  
  default List<String> getOverviewMetrics()
  
  Returns:
  
  An ordered list of the top metrics that are relevant this entity. If this entity's NavigationComponent indicates that is a part of a navigation section, then the first (up to) four metrics in this list will be displayed in the navigation section's card.
- getMetrics
  
  SortedMap<String,IdentifiedMetric> getMetrics()
- getHealthChecks
  
  SortedMap<String,IdentifiedHealthCheckResult> getHealthChecks()