Class GrpclbClientLoadRecorder

java.lang.Object

io.grpc.ClientStreamTracer.Factory

io.grpc.grpclb.GrpclbClientLoadRecorder

@ThreadSafe
final class GrpclbClientLoadRecorder
extends ClientStreamTracer.Factory

Record and aggregate client-side load data for GRPCLB. This records load occurred during the span of an LB stream with the remote load-balancer.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static final class	GrpclbClientLoadRecorder.LongHolder
private class	GrpclbClientLoadRecorder.StreamTracer

Field Summary

Fields

Modifier and Type	Field	Description
private Map<String, GrpclbClientLoadRecorder.LongHolder>	callsDroppedPerToken
private long	callsFailedToSend
private static final AtomicLongFieldUpdater<GrpclbClientLoadRecorder>	callsFailedToSendUpdater
private long	callsFinished
private long	callsFinishedKnownReceived
private static final AtomicLongFieldUpdater<GrpclbClientLoadRecorder>	callsFinishedKnownReceivedUpdater
private static final AtomicLongFieldUpdater<GrpclbClientLoadRecorder>	callsFinishedUpdater
private long	callsStarted
private static final AtomicLongFieldUpdater<GrpclbClientLoadRecorder>	callsStartedUpdater
private final TimeProvider	time

Constructor Summary

Constructors

Constructor	Description
GrpclbClientLoadRecorder(TimeProvider time)

Method Summary

Modifier and Type	Method	Description
(package private) ClientStats	generateLoadReport()	Generate the report with the data recorded this LB stream since the last report.
ClientStreamTracer	newClientStreamTracer(ClientStreamTracer.StreamInfo info, Metadata headers)	Creates a ClientStreamTracer for a new client stream.
(package private) void	recordDroppedRequest(String token)	Records that a request has been dropped as instructed by the remote balancer.

Methods inherited from class Object

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

Field Details

callsStartedUpdater

private static final AtomicLongFieldUpdater<GrpclbClientLoadRecorder> callsStartedUpdater

callsFinishedUpdater

private static final AtomicLongFieldUpdater<GrpclbClientLoadRecorder> callsFinishedUpdater

callsFailedToSendUpdater

private static final AtomicLongFieldUpdater<GrpclbClientLoadRecorder> callsFailedToSendUpdater

callsFinishedKnownReceivedUpdater

private static final AtomicLongFieldUpdater<GrpclbClientLoadRecorder> callsFinishedKnownReceivedUpdater

time

private final TimeProvider time

callsStarted

private volatile long callsStarted

callsFinished

private volatile long callsFinished

callsDroppedPerToken

private Map<String, GrpclbClientLoadRecorder.LongHolder> callsDroppedPerToken

callsFailedToSend

private volatile long callsFailedToSend

callsFinishedKnownReceived

private volatile long callsFinishedKnownReceived

Constructor Details

GrpclbClientLoadRecorder

GrpclbClientLoadRecorder(TimeProvider time)

Method Details

newClientStreamTracer

public ClientStreamTracer newClientStreamTracer(ClientStreamTracer.StreamInfo info,
 Metadata headers)

Description copied from class: ClientStreamTracer.Factory

Creates a ClientStreamTracer for a new client stream. This is called inside the transport when it's creating the stream.

Overrides:

newClientStreamTracer in class ClientStreamTracer.Factory

Parameters:

info - information about the stream

headers - the mutable headers of the stream. It can be safely mutated within this method. Changes made to it will be sent by the stream. It should not be saved because it is not safe for read or write after the method returns.

recordDroppedRequest

void recordDroppedRequest(String token)

Records that a request has been dropped as instructed by the remote balancer.

generateLoadReport

ClientStats generateLoadReport()

Generate the report with the data recorded this LB stream since the last report.