@zeroc/ice
    Preparing search index...

    Class MetricsAdminAbstract

    The metrics administrative facet interface. This interface allows remote administrative clients to access the metrics of an application that enabled the Ice administrative facility and configured one or more metrics views.

    Hierarchy (View Summary)

    Index

    Constructors

    Methods

    • Disables a metrics view.

      Parameters

      • name: string

        The metrics view name.

      • current: Current

        The Current object for the dispatch.

      Returns void | PromiseLike<void>

      A promise like object representing the result of the dispatch.

      IceMX.UnknownMetricsView Thrown when the metrics view cannot be found.

    • Dispatches an incoming request to one of the methods of this generated class, based on the operation name carried by the request.

      Parameters

      Returns OutgoingResponse | PromiseLike<OutgoingResponse>

      The outgoing response (when the selected method returns a value), or a promise with the outgoing response (when the selected method returns a promise).

      Ice marshals any exception thrown by this method into the response.

    • Enables a metrics view.

      Parameters

      • name: string

        The metrics view name.

      • current: Current

        The Current object for the dispatch.

      Returns void | PromiseLike<void>

      A promise like object representing the result of the dispatch.

      IceMX.UnknownMetricsView Thrown when the metrics view cannot be found.

    • Gets the metrics failures associated with the given view and map.

      Parameters

      • view: string

        The name of the metrics view.

      • map: string

        The name of the metrics map.

      • current: Current

        The Current object for the dispatch.

      Returns MetricsFailures[] | PromiseLike<MetricsFailures[]>

      A promise like object representing the result of the dispatch, which resolves to:

      • IceMX.MetricsFailures[] : The metrics failures associated with the map.

      IceMX.UnknownMetricsView Thrown when the metrics view cannot be found.

    • Gets the metrics failure associated for the given metrics.

      Parameters

      • view: string

        The name of the metrics view.

      • map: string

        The name of the metrics map.

      • id: string

        The ID of the metrics.

      • current: Current

        The Current object for the dispatch.

      Returns MetricsFailures | PromiseLike<MetricsFailures>

      A promise like object representing the result of the dispatch, which resolves to:

      • IceMX.MetricsFailures : The metrics failures associated with the metrics.

      IceMX.UnknownMetricsView Thrown when the metrics view cannot be found.

    • Gets the metrics objects for the given metrics view.

      Parameters

      • view: string

        The name of the metrics view.

      • current: Current

        The Current object for the dispatch.

      Returns [Map<string, Metrics[]>, bigint] | PromiseLike<[Map<string, Metrics[]>, bigint]>

      A promise like object representing the result of the dispatch, which resolves to an array with the following entries:

      • Map<string, (IceMX.Metrics | null)[]> : The metrics view data, a dictionary of metric maps for each metrics class configured with the view. The timestamp allows the client to compute averages which are not dependent of the invocation latency for this operation.
      • bigint : The local time of the process when the metrics objects were retrieved.

      IceMX.UnknownMetricsView Thrown when the metrics view cannot be found.

    • Gets the names of enabled and disabled metrics.

      Parameters

      • current: Current

        The Current object for the dispatch.

      Returns [string[], string[]] | PromiseLike<[string[], string[]]>

      A promise like object representing the result of the dispatch, which resolves to an array with the following entries:

      • string[] : The names of the enabled views.
      • string[] : The names of the disabled views.
    • Returns the Slice type ID of the most-derived interface supported by this object.

      Parameters

      • current: Current

        The Current object for the invocation.

      Returns string | PromiseLike<string>

      The Slice type ID of the most-derived interface.

    • Returns the Slice type IDs of the interfaces supported by this object.

      Parameters

      • current: Current

        The Current object for the invocation.

      Returns string[] | PromiseLike<string[]>

      The Slice type IDs of the interfaces supported by this object, in alphabetical order.

    • Tests whether this object supports a specific Slice interface.

      Parameters

      • typeID: string

        The type ID of the Slice interface to test against.

      • current: Current

        The Current object for the invocation.

      Returns boolean | PromiseLike<boolean>

      True if this object has the interface specified by typeID or derives from the interface specified by typeID.

    • Tests whether this object can be reached.

      Parameters

      • current: Current

        The Current object for the invocation.

      Returns void | PromiseLike<void>

    • Obtains the Slice type ID of this type.

      Returns string

      The return value is always "::IceMX::MetricsAdmin".