Package org.opensearch.index.engine

Class SegmentsStats

java.lang.Object

org.opensearch.index.engine.SegmentsStats

All Implemented Interfaces:

Writeable, org.opensearch.common.xcontent.ToXContent, org.opensearch.common.xcontent.ToXContentFragment

public class SegmentsStats
extends java.lang.Object
implements Writeable, org.opensearch.common.xcontent.ToXContentFragment

Nested Class Summary

Nested classes/interfaces inherited from interface org.opensearch.common.xcontent.ToXContent

org.opensearch.common.xcontent.ToXContent.DelegatingMapParams, org.opensearch.common.xcontent.ToXContent.MapParams, org.opensearch.common.xcontent.ToXContent.Params

Nested classes/interfaces inherited from interface org.opensearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields inherited from interface org.opensearch.common.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
SegmentsStats()
SegmentsStats(StreamInput in)

Method Summary

Modifier and Type	Method	Description
void	add(long count, long memoryInBytes)
void	add(SegmentsStats mergeStats)
void	addBitsetMemoryInBytes(long bitsetMemoryInBytes)
void	addDocValuesMemoryInBytes(long docValuesMemoryInBytes)
void	addFileSizes(ImmutableOpenMap<java.lang.String,java.lang.Long> fileSizes)
void	addIndexWriterMemoryInBytes(long indexWriterMemoryInBytes)
void	addNormsMemoryInBytes(long normsMemoryInBytes)
void	addPointsMemoryInBytes(long pointsMemoryInBytes)
void	addStoredFieldsMemoryInBytes(long storedFieldsMemoryInBytes)
void	addTermsMemoryInBytes(long termsMemoryInBytes)
void	addTermVectorsMemoryInBytes(long termVectorsMemoryInBytes)
void	addVersionMapMemoryInBytes(long versionMapMemoryInBytes)
void	clearFileSizes()
ByteSizeValue	getBitsetMemory()
long	getBitsetMemoryInBytes()	Estimation of how much the cached bit sets are taking.
long	getCount()	The number of segments.
long	getDocValuesMemoryInBytes()	Estimation of the doc values memory usage by a segment.
ImmutableOpenMap<java.lang.String,java.lang.Long>	getFileSizes()
ByteSizeValue	getIndexWriterMemory()
long	getIndexWriterMemoryInBytes()	Estimation of the memory usage by index writer
long	getMaxUnsafeAutoIdTimestamp()	Returns the max timestamp that is used to de-optimize documents with auto-generated IDs in the engine.
ByteSizeValue	getMemory()
long	getMemoryInBytes()	Estimation of the memory usage used by a segment.
long	getNormsMemoryInBytes()	Estimation of the norms memory usage by a segment.
long	getPointsMemoryInBytes()	Estimation of the points memory usage by a segment.
long	getStoredFieldsMemoryInBytes()	Estimation of the stored fields memory usage by a segment.
long	getTermsMemoryInBytes()	Estimation of the terms dictionary memory usage by a segment.
long	getTermVectorsMemoryInBytes()	Estimation of the term vectors memory usage by a segment.
ByteSizeValue	getVersionMapMemory()
long	getVersionMapMemoryInBytes()	Estimation of the memory usage by version map
org.opensearch.common.xcontent.XContentBuilder	toXContent(org.opensearch.common.xcontent.XContentBuilder builder, org.opensearch.common.xcontent.ToXContent.Params params)
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.common.xcontent.ToXContentFragment

isFragment

Constructor Details

SegmentsStats

public SegmentsStats()

SegmentsStats

public SegmentsStats(StreamInput in) throws java.io.IOException

Throws:

java.io.IOException

Method Details

add

public void add(long count, long memoryInBytes)

addTermsMemoryInBytes

public void addTermsMemoryInBytes(long termsMemoryInBytes)

addStoredFieldsMemoryInBytes

public void addStoredFieldsMemoryInBytes(long storedFieldsMemoryInBytes)

addTermVectorsMemoryInBytes

public void addTermVectorsMemoryInBytes(long termVectorsMemoryInBytes)

addNormsMemoryInBytes

public void addNormsMemoryInBytes(long normsMemoryInBytes)

addPointsMemoryInBytes

public void addPointsMemoryInBytes(long pointsMemoryInBytes)

addDocValuesMemoryInBytes

public void addDocValuesMemoryInBytes(long docValuesMemoryInBytes)

addIndexWriterMemoryInBytes

public void addIndexWriterMemoryInBytes(long indexWriterMemoryInBytes)

addVersionMapMemoryInBytes

public void addVersionMapMemoryInBytes(long versionMapMemoryInBytes)

addBitsetMemoryInBytes

public void addBitsetMemoryInBytes(long bitsetMemoryInBytes)

addFileSizes

public void addFileSizes(ImmutableOpenMap<java.lang.String,java.lang.Long> fileSizes)

add

public void add(SegmentsStats mergeStats)

getCount

public long getCount()

The number of segments.

getMemoryInBytes

public long getMemoryInBytes()

Estimation of the memory usage used by a segment.

getMemory

public ByteSizeValue getMemory()

getTermsMemoryInBytes

public long getTermsMemoryInBytes()

Estimation of the terms dictionary memory usage by a segment.

getStoredFieldsMemoryInBytes

public long getStoredFieldsMemoryInBytes()

Estimation of the stored fields memory usage by a segment.

getTermVectorsMemoryInBytes

public long getTermVectorsMemoryInBytes()

Estimation of the term vectors memory usage by a segment.

getNormsMemoryInBytes

public long getNormsMemoryInBytes()

Estimation of the norms memory usage by a segment.

getPointsMemoryInBytes

public long getPointsMemoryInBytes()

Estimation of the points memory usage by a segment.

getDocValuesMemoryInBytes

public long getDocValuesMemoryInBytes()

Estimation of the doc values memory usage by a segment.

getIndexWriterMemoryInBytes

public long getIndexWriterMemoryInBytes()

Estimation of the memory usage by index writer

getIndexWriterMemory

public ByteSizeValue getIndexWriterMemory()

getVersionMapMemoryInBytes

public long getVersionMapMemoryInBytes()

Estimation of the memory usage by version map

getVersionMapMemory

public ByteSizeValue getVersionMapMemory()

getBitsetMemoryInBytes

public long getBitsetMemoryInBytes()

Estimation of how much the cached bit sets are taking. (which nested and p/c rely on)

getBitsetMemory

public ByteSizeValue getBitsetMemory()

getFileSizes

public ImmutableOpenMap<java.lang.String,java.lang.Long> getFileSizes()

getMaxUnsafeAutoIdTimestamp

public long getMaxUnsafeAutoIdTimestamp()

Returns the max timestamp that is used to de-optimize documents with auto-generated IDs in the engine. This is used to ensure we don't add duplicate documents when we assume an append only case based on auto-generated IDs

toXContent

public org.opensearch.common.xcontent.XContentBuilder toXContent(org.opensearch.common.xcontent.XContentBuilder builder, org.opensearch.common.xcontent.ToXContent.Params params) throws java.io.IOException

Specified by:

toXContent in interface org.opensearch.common.xcontent.ToXContent

Throws:

java.io.IOException

writeTo

public void writeTo(StreamOutput out) throws java.io.IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Throws:

java.io.IOException

clearFileSizes

public void clearFileSizes()