io.nats.client.Statistics Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jnats Show documentation
Client library for working with the NATS messaging system.
There is a newer version: 2.20.5
// Copyright 2015-2018 The NATS Authors
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at:
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package io.nats.client;

/**
 * Connections can provide an instance of Statistics, {@link Connection#getStatistics() getStatistics()}. The statistics
 * object provides information about key metrics related to the connection over its entire lifecycle.
 * 
 * The Statistics toString() provides a summary of the statistics.
 */
public interface Statistics {

    /**
     * @return the total number of pings that have been sent from this connection.
     */
    long getPings();

    /**
     * @return the total number of times this connection has tried to reconnect.
     */
    long getReconnects();

    /**
     * @return the total number of messages dropped by this connection across all slow consumers.
     */
    long getDroppedCount();

    /**
     * @return the total number of op +OKs received by this connection.
     */
    long getOKs();

    /**
     * @return the total number of op -ERRs received by this connection.
     */
    long getErrs();

    /**
     * @return the total number of exceptions seen by this connection.
     */
    long getExceptions();

    /**
     * @return the total number of requests sent by this connection.
     */
    long getRequestsSent();

    /**
     * @return the total number of replies received by this connection.
     */
    long getRepliesReceived();

    /**
     * @return the total number of duplicate replies received by this connection.
     *
     * NOTE: This is only counted if advanced stats are enabled.
     */
    long getDuplicateRepliesReceived();

    /**
     * @return the total number of orphan replies received by this connection.
     *
     * NOTE: This is only counted if advanced stats are enabled.
     */
    long getOrphanRepliesReceived();

    /**
     * @return the total number of messages that have come in to this connection.
     */
    long getInMsgs();

    /**
     * @return the total number of messages that have gone out of this connection.
     */
    long getOutMsgs();

    /**
     * @return the total number of message bytes that have come in to this connection.
     */
    long getInBytes();

    /**
     * @return the total number of message bytes that have gone out of this connection.
     */
    long getOutBytes();

    /**
     * @return the total number of outgoing message flushes by this connection.
     */
    long getFlushCounter();

    /**
     * @return the count of outstanding of requests from this connection.
     */
    long getOutstandingRequests();
}