Package org.apache.storm.metricstore
Interface MetricStore
- All Superinterfaces:
- AutoCloseable
- All Known Implementing Classes:
- NoOpMetricStore,- RocksDbStore
- 
Nested Class SummaryNested ClassesModifier and TypeInterfaceDescriptionstatic interfaceInterface used to callback metrics results from a scan.
- 
Method SummaryModifier and TypeMethodDescriptionvoidclose()Close the metric store.voidStores a metric in the store.booleanpopulateValue(Metric metric) Fill out the numeric values for a metric.voidprepare(Map<String, Object> config, StormMetricsRegistry metricsRegistry) Create metric store instance using the configurations provided via the config map.voidscan(FilterOptions filter, MetricStore.ScanCallback scanCallback) Scans all metrics in the store and returns the ones matching the specified filtering options.
- 
Method Details- 
preparevoid prepare(Map<String, Object> config, StormMetricsRegistry metricsRegistry) throws MetricExceptionCreate metric store instance using the configurations provided via the config map.- Parameters:
- config- Storm config map
- metricsRegistry- The Nimbus daemon metrics registry
- Throws:
- MetricException- on preparation error
 
- 
insertStores a metric in the store.- Parameters:
- metric- Metric to store
- Throws:
- MetricException- on error
 
- 
populateValueFill out the numeric values for a metric.- Parameters:
- metric- Metric to populate
- Returns:
- true if the metric was populated, false otherwise
- Throws:
- MetricException- on error
 
- 
closevoid close()Close the metric store.- Specified by:
- closein interface- AutoCloseable
 
- 
scanScans all metrics in the store and returns the ones matching the specified filtering options.- Parameters:
- filter- options to filter by
- scanCallback- callback for each Metric found
- Throws:
- MetricException- on error
 
 
-