org.apache.solr.core

Interface SolrInfoBean

All Known Subinterfaces:

SolrCache<K,V>, SolrEncoder, SolrFormatter, SolrFragListBuilder, SolrFragmenter, SolrRequestHandler

All Known Implementing Classes:

AnalysisRequestHandlerBase, AuthenticationPlugin, AutoScalingHandler, AutoscalingHistoryHandler, BasicAuthPlugin, BlobHandler, BlockJoinChildQParserPlugin, BlockJoinDocSetFacetComponent, BlockJoinFacetComponent, BlockJoinParentQParserPlugin, BoolQParserPlugin, BoostQParserPlugin, BreakIteratorBoundaryScanner, CdcrRequestHandler, CollapsingQParserPlugin, CollectionsHandler, ComplexPhraseQParserPlugin, ConfigSetsHandler, ConfigurableInternodeAuthHadoopPlugin, ContentStreamHandlerBase, CoreAdminHandler, DebugComponent, DefaultEncoder, DirectUpdateHandler2, DisMaxQParserPlugin, DocumentAnalysisRequestHandler, DumpRequestHandler, ExpandComponent, ExportHandler, ExportQParserPlugin, ExtendedDismaxQParserPlugin, FacetComponent, FacetModule, FastLRUCache, FieldAnalysisRequestHandler, FieldQParserPlugin, FileFloatSource.ReloadCacheRequestHandler, FiltersQParserPlugin, FunctionQParserPlugin, FunctionRangeQParserPlugin, GapFragmenter, GraphHandler, GraphQParserPlugin, GraphTermsQParserPlugin, HadoopAuthPlugin, HashQParserPlugin, HdfsLocalityReporter, HealthCheckHandler, HighlightComponent, HighlightingPluginBase, HtmlEncoder, HtmlFormatter, IGainTermsQParserPlugin, InfoHandler, JoinQParserPlugin, KerberosPlugin, LFUCache, LoggingHandler, LRUCache, LuceneQParserPlugin, LukeRequestHandler, MaxScoreQParserPlugin, Metrics, MetricsCollectorHandler, MetricsHandler, MetricsHistoryHandler, MinHashQParserPlugin, MLTQParserPlugin, MoreLikeThisComponent, MoreLikeThisHandler, NestedQParserPlugin, NotFoundRequestHandler, PayloadCheckQParserPlugin, PayloadScoreQParserPlugin, PhrasesIdentificationComponent, PingRequestHandler, PKIAuthenticationPlugin, PluginInfoHandler, PrefixQParserPlugin, PropertiesRequestHandler, PublicKeyHandler, QParserPlugin, QueryComponent, QueryElevationComponent, RawQParserPlugin, RealTimeGetComponent, RealTimeGetHandler, RegexFragmenter, ReplicationHandler, RequestHandlerBase, ReRankQParserPlugin, ResponseLogComponent, SchemaHandler, ScoreJoinQParserPlugin, ScoreOrderFragmentsBuilder, SearchComponent, SearchHandler, SecurityConfHandler, SecurityConfHandlerLocal, SecurityConfHandlerZk, SegmentsInfoRequestHandler, ShowFileRequestHandler, SignificantTermsQParserPlugin, SimpleBoundaryScanner, SimpleFragListBuilder, SimpleFragmentsBuilder, SimpleQParserPlugin, SingleFragListBuilder, SolrBoundaryScanner, SolrConfigHandler, SolrCore, SolrFieldCacheBean, SolrFragmentsBuilder, SolrIndexSearcher, SolrInfoMBeanHandler, SpatialBoxQParserPlugin, SpatialFilterQParserPlugin, SpellCheckComponent, SQLHandler, StandardRequestHandler, StatsComponent, StreamHandler, SuggestComponent, SurroundQParserPlugin, SwitchQParserPlugin, SystemInfoHandler, TaggerRequestHandler, TermQParserPlugin, TermsComponent, TermsQParserPlugin, TermVectorComponent, TextLogisticRegressionQParserPlugin, ThreadDumpHandler, UpdateHandler, UpdateRequestHandler, UpdateRequestHandlerApi, UpdateShardHandler, WeightedFragListBuilder, XmlQParserPlugin, ZookeeperInfoHandler, ZookeeperStatusHandler

public interface SolrInfoBean

Interface for getting various ui friendly strings for use by objects which are 'pluggable' to make server administration easier.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	SolrInfoBean.Category Category of Solr component.
static class	SolrInfoBean.Group Top-level group of beans or metrics for a subsystem.

Method Summary

Modifier and Type	Method and Description
SolrInfoBean.Category	getCategory() Category of this component
String	getDescription() Simple one or two line description
default Set<String>	getMetricNames() Modifiable set of metric names that this component reports (default is null, which means none).
default com.codahale.metrics.MetricRegistry	getMetricRegistry() An instance of MetricRegistry that this component uses for metrics reporting (default is null, which means no registry).
default Map<String,Object>	getMetricsSnapshot() Optionally return a snapshot of metrics that this component reports, or null.
String	getName() Simple common usage name, e.g.
default void	registerMetricName(String name) Register a metric name that this component reports.

Method Detail

getName

String getName()

Simple common usage name, e.g. BasicQueryHandler, or fully qualified class name.

getDescription

String getDescription()

Simple one or two line description

getCategory

SolrInfoBean.Category getCategory()

Category of this component

getMetricsSnapshot

default Map<String,Object> getMetricsSnapshot()

Optionally return a snapshot of metrics that this component reports, or null. Default implementation requires that both getMetricNames() and getMetricRegistry() return non-null values.

getMetricNames

default Set<String> getMetricNames()

Modifiable set of metric names that this component reports (default is null, which means none). If not null then this set is used by registerMetricName(String) to capture what metrics names are reported from this component.

NOTE: this set has to allow iteration under modifications.

getMetricRegistry

default com.codahale.metrics.MetricRegistry getMetricRegistry()

An instance of MetricRegistry that this component uses for metrics reporting (default is null, which means no registry).

registerMetricName

default void registerMetricName(String name)

Register a metric name that this component reports. This method is called by various metric registration methods in SolrMetricManager in order to capture what metric names are reported from this component (which in turn is called from SolrMetricProducer.initializeMetrics(SolrMetricManager, String, String, String)).

Default implementation registers all metrics added by a component. Implementations may override this to avoid reporting some or all metrics returned by getMetricsSnapshot()