Package org.elasticsearch.index.search.stats

Class ShardFieldUsageTracker

java.lang.Object

org.elasticsearch.index.search.stats.ShardFieldUsageTracker

public class ShardFieldUsageTracker
extends Object

Records and provides field usage stats

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	ShardFieldUsageTracker.FieldUsageStatsTrackingSession

Constructor Summary

Constructors

Constructor	Description
ShardFieldUsageTracker()

Method Summary

Modifier and Type	Method	Description
ShardFieldUsageTracker.FieldUsageStatsTrackingSession	createSession()	Returns a new session which can be passed to a FieldUsageTrackingDirectoryReader to track field usage of a shard.
FieldUsageStats	stats(String... fields)	Returns field usage stats for the given fields.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ShardFieldUsageTracker

public ShardFieldUsageTracker()

Method Details

createSession

public ShardFieldUsageTracker.FieldUsageStatsTrackingSession createSession()

Returns a new session which can be passed to a FieldUsageTrackingDirectoryReader to track field usage of a shard. Fields tracked as part of a session are only counted as a single use. The stats are then recorded for this shard when the corresponding session is closed.

stats

public FieldUsageStats stats(String... fields)

Returns field usage stats for the given fields. If no subset of fields is specified, returns information for all fields.