io.grpc

Class StreamTracer

java.lang.Object

io.grpc.StreamTracer

Direct Known Subclasses:

ClientStreamTracer, ServerStreamTracer

@ExperimentalApi(value="https://github.com/grpc/grpc-java/issues/2861")
 @ThreadSafe
public abstract class StreamTracer
extends Object

Listens to events on a stream to collect metrics.

Constructor Summary

Constructors

Constructor and Description
StreamTracer()

Method Summary

Modifier and Type	Method and Description
void	inboundMessage() An inbound message has been received by the stream.
void	inboundUncompressedSize(long bytes) The uncompressed size of some inbound data is revealed.
void	inboundWireSize(long bytes) The wire size of some inbound data is revealed.
void	outboundMessage() An outbound message has been passed to the stream.
void	outboundUncompressedSize(long bytes) The uncompressed size of some outbound data is revealed.
void	outboundWireSize(long bytes) The wire size of some outbound data is revealed.
void	streamClosed(Status status) Stream is closed.

Methods inherited from class java.lang.Object

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

Constructor Detail

StreamTracer

public StreamTracer()

Method Detail

streamClosed

public void streamClosed(Status status)

Stream is closed. This will be called exactly once.

outboundMessage

public void outboundMessage()

An outbound message has been passed to the stream. This is called as soon as the stream knows about the message, but doesn't have further guarantee such as whether the message is serialized or not.

inboundMessage

public void inboundMessage()

An inbound message has been received by the stream. This is called as soon as the stream knows about the message, but doesn't have further guarantee such as whether the message is deserialized or not.

outboundWireSize

public void outboundWireSize(long bytes)

The wire size of some outbound data is revealed. This can only used to record the accumulative outbound wire size. There is no guarantee wrt timing or granularity of this method.

outboundUncompressedSize

public void outboundUncompressedSize(long bytes)

The uncompressed size of some outbound data is revealed. This can only used to record the accumulative outbound uncompressed size. There is no guarantee wrt timing or granularity of this method.

inboundWireSize

public void inboundWireSize(long bytes)

The wire size of some inbound data is revealed. This can only be used to record the accumulative received wire size. There is no guarantee wrt timing or granularity of this method.

inboundUncompressedSize

public void inboundUncompressedSize(long bytes)

The uncompressed size of some inbound data is revealed. This can only used to record the accumulative received uncompressed size. There is no guarantee wrt timing or granularity of this method.