Package io.camunda.zeebe.transport.stream.api

Interface ClientStreamMetrics

public interface ClientStreamMetrics

  • Method Summary

    Modifier and Type
    Method
    Description
    default void
    aggregatedStreamCount(int count)
    Invoked whenever the count of streams in the registry changes
    default void
    clientCount(int count)
    Invoked whenever the total count of clients in the registry changes
    static ClientStreamMetrics
    noop()
     
    default void
    observeAggregatedClientCount(int count)
    Invoked whenever the count of streams in an aggregated stream changes.
    default void
    pushFailed()
    Invoked if pushing a payload to a stream failed
    default void
    pushSucceeded()
    Invoked after a payload is successfully pushed to a stream
    default void
    pushTryFailed(ErrorCode code)
    Invoked when a push failed for a given client, regardless of whether it ultimately succeeded with another.
    default void
    serverCount(int count)
    Invoked whenever the count of known servers in the registry changes

  • Method Details

    • serverCount

      default void serverCount(int count)
      Invoked whenever the count of known servers in the registry changes

    • clientCount

      default void clientCount(int count)
      Invoked whenever the total count of clients in the registry changes

    • aggregatedStreamCount

      default void aggregatedStreamCount(int count)
      Invoked whenever the count of streams in the registry changes

    • observeAggregatedClientCount

      default void observeAggregatedClientCount(int count)
      Invoked whenever the count of streams in an aggregated stream changes. The expected implementations of this metric is an histogram, or something which records observations individually.

    • pushSucceeded

      default void pushSucceeded()
      Invoked after a payload is successfully pushed to a stream

    • pushFailed

      default void pushFailed()
      Invoked if pushing a payload to a stream failed

    • pushTryFailed

      default void pushTryFailed(ErrorCode code)
      Invoked when a push failed for a given client, regardless of whether it ultimately succeeded with another.
      Parameters:
      code - the error code for the given attempt

    • noop

      static ClientStreamMetrics noop()