Package io.grpc.internal

Class TransportTracer

java.lang.Object
io.grpc.internal.TransportTracer
public final class TransportTracer extends Object
A class for gathering statistics about a transport. This is an experimental feature. Can only be called from the transport thread unless otherwise noted.

  • Field Details

    • DEFAULT_FACTORY

      private static final TransportTracer.Factory DEFAULT_FACTORY

    • timeProvider

      private final TimeProvider timeProvider

    • streamsStarted

      private long streamsStarted

    • lastLocalStreamCreatedTimeNanos

      private long lastLocalStreamCreatedTimeNanos

    • lastRemoteStreamCreatedTimeNanos

      private long lastRemoteStreamCreatedTimeNanos

    • streamsSucceeded

      private long streamsSucceeded

    • streamsFailed

      private long streamsFailed

    • keepAlivesSent

      private long keepAlivesSent

    • flowControlWindowReader

      private TransportTracer.FlowControlReader flowControlWindowReader

    • messagesSent

      private long messagesSent

    • lastMessageSentTimeNanos

      private long lastMessageSentTimeNanos

    • messagesReceived

      private final LongCounter messagesReceived

    • lastMessageReceivedTimeNanos

      private volatile long lastMessageReceivedTimeNanos

  • Constructor Details

    • TransportTracer

      public TransportTracer()

    • TransportTracer

      private TransportTracer(TimeProvider timeProvider)

  • Method Details

    • getStats

      public InternalChannelz.TransportStats getStats()
      Returns a read only set of current stats.

    • reportLocalStreamStarted

      public void reportLocalStreamStarted()
      Called by the client to report a stream has started.

    • reportRemoteStreamStarted

      public void reportRemoteStreamStarted()
      Called by the server to report a stream has started.

    • reportStreamClosed

      public void reportStreamClosed(boolean success)
      Reports that a stream closed with the specified Status.

    • reportMessageSent

      public void reportMessageSent(int numMessages)
      Reports that some messages were successfully sent. numMessages must be at least 0.

    • reportMessageReceived

      public void reportMessageReceived()
      Reports that a message was successfully received. This method is thread safe.

    • reportKeepAliveSent

      public void reportKeepAliveSent()
      Reports that a keep alive message was sent.

    • setFlowControlWindowReader

      public void setFlowControlWindowReader(TransportTracer.FlowControlReader flowControlWindowReader)
      Registers a TransportTracer.FlowControlReader that can be used to read the local and remote flow control window sizes.

    • getDefaultFactory

      public static TransportTracer.Factory getDefaultFactory()