Module org.elasticsearch.server

Package org.elasticsearch.action.admin.cluster.stats

Class CCSTelemetrySnapshot

java.lang.Object

org.elasticsearch.action.admin.cluster.stats.CCSTelemetrySnapshot

All Implemented Interfaces:

Writeable, ToXContent, ToXContentFragment

public final class CCSTelemetrySnapshot
extends Object
implements Writeable, ToXContentFragment

Holds a snapshot of the CCS telemetry statistics from CCSUsageTelemetry. Used to hold the stats for a single node that's part of a ClusterStatsNodeResponse, as well as to accumulate stats for the entire cluster and return them as part of the ClusterStatsResponse.
Theory of operation: - The snapshot is created on each particular node with the stats for the node, and is sent to the coordinating node - Coordinating node creates an empty snapshot and merges all the node snapshots into it using add()
The snapshot contains LongMetric.LongMetricValues for latencies, which currently contain full histograms (since you can't produce p90 from a set of node p90s, you need the full histogram for that). To avoid excessive copying (histogram weighs several KB), the snapshot is designed to be mutable, so that you can add multiple snapshots to it without copying the histograms all the time. It is not the intent to mutate the snapshot objects otherwise.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CCSTelemetrySnapshot.PerClusterCCSTelemetry

Nested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

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

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

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CCS_TELEMETRY_FIELD_NAME

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
CCSTelemetrySnapshot()	Creates a new empty stats instance, that will get additional stats added through add(CCSTelemetrySnapshot)
CCSTelemetrySnapshot(long totalCount, long successCount, Map<String,Long> failureReasons, LongMetric.LongMetricValue took, LongMetric.LongMetricValue tookMrtTrue, LongMetric.LongMetricValue tookMrtFalse, long remotesPerSearchMax, double remotesPerSearchAvg, long skippedRemotes, Map<String,Long> featureCounts, Map<String,Long> clientCounts, Map<String,CCSTelemetrySnapshot.PerClusterCCSTelemetry> byRemoteCluster)	Creates a new stats instance with the provided info.
CCSTelemetrySnapshot(StreamInput in)

Method Summary

Modifier and Type	Method	Description
void	add(CCSTelemetrySnapshot stats)	Add the provided stats to the ones held by the current instance, effectively merging the two.
boolean	equals(Object o)
Map<String,CCSTelemetrySnapshot.PerClusterCCSTelemetry>	getByRemoteCluster()
Map<String,Long>	getClientCounts()
Map<String,Long>	getFailureReasons()
Map<String,Long>	getFeatureCounts()
double	getRemotesPerSearchAvg()
long	getRemotesPerSearchMax()
long	getSearchCountWithSkippedRemotes()
long	getSuccessCount()
LongMetric.LongMetricValue	getTook()
LongMetric.LongMetricValue	getTookMrtFalse()
LongMetric.LongMetricValue	getTookMrtTrue()
long	getTotalCount()
int	hashCode()
String	toString()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.elasticsearch.xcontent.ToXContentFragment

isFragment

Field Details

CCS_TELEMETRY_FIELD_NAME

public static final String CCS_TELEMETRY_FIELD_NAME

See Also:

• Constant Field Values

Constructor Details

CCSTelemetrySnapshot

public CCSTelemetrySnapshot(long totalCount,
 long successCount,
 Map<String,Long> failureReasons,
 LongMetric.LongMetricValue took,
 LongMetric.LongMetricValue tookMrtTrue,
 LongMetric.LongMetricValue tookMrtFalse,
 long remotesPerSearchMax,
 double remotesPerSearchAvg,
 long skippedRemotes,
 Map<String,Long> featureCounts,
 Map<String,Long> clientCounts,
 Map<String,CCSTelemetrySnapshot.PerClusterCCSTelemetry> byRemoteCluster)

Creates a new stats instance with the provided info.

CCSTelemetrySnapshot

public CCSTelemetrySnapshot()

Creates a new empty stats instance, that will get additional stats added through add(CCSTelemetrySnapshot)

CCSTelemetrySnapshot

public CCSTelemetrySnapshot(StreamInput in)
                     throws IOException

Throws:

IOException

Method Details

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Throws:

IOException

getTotalCount

public long getTotalCount()

getSuccessCount

public long getSuccessCount()

getFailureReasons

public Map<String,Long> getFailureReasons()

getTook

public LongMetric.LongMetricValue getTook()

getTookMrtTrue

public LongMetric.LongMetricValue getTookMrtTrue()

getTookMrtFalse

public LongMetric.LongMetricValue getTookMrtFalse()

getRemotesPerSearchMax

public long getRemotesPerSearchMax()

getRemotesPerSearchAvg

public double getRemotesPerSearchAvg()

getSearchCountWithSkippedRemotes

public long getSearchCountWithSkippedRemotes()

getFeatureCounts

public Map<String,Long> getFeatureCounts()

getClientCounts

public Map<String,Long> getClientCounts()

getByRemoteCluster

public Map<String,CCSTelemetrySnapshot.PerClusterCCSTelemetry> getByRemoteCluster()

add

public void add(CCSTelemetrySnapshot stats)

Add the provided stats to the ones held by the current instance, effectively merging the two.

Parameters:

stats - the other stats object to add to this one

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
 ToXContent.Params params)
                           throws IOException

Specified by:

toXContent in interface ToXContent

Throws:

IOException

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object