@zeroc/ice
    Preparing search index...

    Class InvocationMetrics

    Provide measurements for proxy invocations. Proxy invocations can either be sent over the wire or be collocated.

    Hierarchy (View Summary)

    Index

    Constructors

    • One-shot constructor to initialize all data members.

      Parameters

      • Optionalid: string

        The metrics identifier.

      • Optionaltotal: bigint

        The total number of objects observed by this metrics.

      • Optionalcurrent: number

        The number of objects currently observed by this metrics.

      • OptionaltotalLifetime: bigint

        The sum of the lifetime of each observed objects.

      • Optionalfailures: number

        The number of failures observed.

      • Optionalretry: number

        The number of retries for the invocations.

      • OptionaluserException: number

        The number of invocations that failed with a user exception.

      • Optionalremotes: Metrics[]

        The remote invocation metrics map.

      • Optionalcollocated: Metrics[]

        The collocated invocation metrics map.

      Returns InvocationMetrics

    Properties

    collocated: Metrics[]

    The collocated invocation metrics map.

    CollocatedMetrics

    current: number

    The number of objects currently observed by this metrics.

    failures: number

    The number of failures observed.

    id: string

    The metrics identifier.

    remotes: Metrics[]

    The remote invocation metrics map.

    RemoteMetrics

    retry: number

    The number of retries for the invocations.

    total: bigint

    The total number of objects observed by this metrics. This includes the number of currently observed objects and the number of objects observed in the past.

    totalLifetime: bigint

    The sum of the lifetime of each observed objects. This does not include the lifetime of objects which are currently observed, only the objects observed in the past.

    userException: number

    The number of invocations that failed with a user exception.

    Methods

    • Obtains the sliced data associated with this instance.

      Returns SlicedData

      The sliced data if the value has a preserved-slice base class and has been sliced during unmarshaling of the value, nil otherwise.

    • Obtains the Slice type ID of the most-derived class supported by this object.

      Returns string

      The type ID.

    • The Ice run time invokes this method after unmarshaling an object's data members. This allows a subclass to override this method in order to perform additional initialization.

      Returns void

    • The Ice run time invokes this method prior to marshaling an object's data members. This allows a subclass to override this method in order to validate its data members.

      Returns void

    • Obtains the Slice type ID of this type.

      Returns string

      The return value is always "::Ice::Object".