IceMX.MetricsAdminPrx

class IceMX.MetricsAdminPrx

Bases: ObjectPrx

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.

Notes

The Slice compiler generated this proxy class from Slice interface ::IceMX::MetricsAdmin.

static checkedCast(proxy: ObjectPrx | None, facet: str | None = None, context: dict[str, str] | None = None) → MetricsAdminPrx | None

Creates a new proxy from an existing proxy after confirming the target object’s type via a remote invocation.

Parameters:

• proxy (ObjectPrx | None) – The source proxy.

• facet (str, optional) – A facet name.

• context (dict[str, str], optional) – The request context.

Returns:

A new proxy with the requested type, or None if the source proxy is None or if the target object does not support the requested type.

Return type:

ObjectPrx | None

static checkedCastAsync(proxy: ObjectPrx | None, facet: str | None = None, context: dict[str, str] | None = None) → Awaitable[MetricsAdminPrx | None]

Creates a new proxy from an existing proxy after confirming the target object’s type via a remote invocation.

Parameters:

• proxy (ObjectPrx | None) – The source proxy.

• facet (str, optional) – A facet name.

• context (dict[str, str], optional) – The request context.

Returns:

A new proxy with the requested type, or None if the source proxy is None or if the target object does not support the requested type.

Return type:

ObjectPrx | None

disableMetricsView(name: str, context: dict[str, str] | None = None) → None

Disables a metrics view.

Parameters:

• name (str) – The metrics view name.

• context (dict[str, str]) – The request context for the invocation.

Raises:

UnknownMetricsView – Thrown when the metrics view cannot be found.

Return type:

None

disableMetricsViewAsync(name: str, context: dict[str, str] | None = None) → Awaitable[None]

Disables a metrics view.

Parameters:

• name (str) – The metrics view name.

• context (dict[str, str]) – The request context for the invocation.

Returns:

An awaitable that is completed when the invocation completes.

Return type:

Awaitable[None]

enableMetricsView(name: str, context: dict[str, str] | None = None) → None

Enables a metrics view.

Parameters:

• name (str) – The metrics view name.

• context (dict[str, str]) – The request context for the invocation.

Raises:

UnknownMetricsView – Thrown when the metrics view cannot be found.

Return type:

None

enableMetricsViewAsync(name: str, context: dict[str, str] | None = None) → Awaitable[None]

Enables a metrics view.

Parameters:

• name (str) – The metrics view name.

• context (dict[str, str]) – The request context for the invocation.

Returns:

An awaitable that is completed when the invocation completes.

Return type:

Awaitable[None]

getMapMetricsFailures(view: str, map: str, context: dict[str, str] | None = None) → list[MetricsFailures]

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

Parameters:

• view (str) – The name of the metrics view.

• map (str) – The name of the metrics map.

• context (dict[str, str]) – The request context for the invocation.

Returns:

The metrics failures associated with the map.

Return type:

list[MetricsFailures]

Raises:

UnknownMetricsView – Thrown when the metrics view cannot be found.

getMapMetricsFailuresAsync(view: str, map: str, context: dict[str, str] | None = None) → Awaitable[list[MetricsFailures]]

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

Parameters:

• view (str) – The name of the metrics view.

• map (str) – The name of the metrics map.

• context (dict[str, str]) – The request context for the invocation.

Returns:

The metrics failures associated with the map.

Return type:

Awaitable[list[MetricsFailures]]

getMetricsFailures(view: str, map: str, id: str, context: dict[str, str] | None = None) → MetricsFailures

Gets the metrics failure associated for the given metrics.

Parameters:

• view (str) – The name of the metrics view.

• map (str) – The name of the metrics map.

• id (str) – The ID of the metrics.

• context (dict[str, str]) – The request context for the invocation.

Returns:

The metrics failures associated with the metrics.

Return type:

MetricsFailures

Raises:

UnknownMetricsView – Thrown when the metrics view cannot be found.

getMetricsFailuresAsync(view: str, map: str, id: str, context: dict[str, str] | None = None) → Awaitable[MetricsFailures]

Gets the metrics failure associated for the given metrics.

Parameters:

• view (str) – The name of the metrics view.

• map (str) – The name of the metrics map.

• id (str) – The ID of the metrics.

• context (dict[str, str]) – The request context for the invocation.

Returns:

The metrics failures associated with the metrics.

Return type:

Awaitable[MetricsFailures]

getMetricsView(view: str, context: dict[str, str] | None = None) → tuple[dict[str, list[Metrics | None]], int]

Gets the metrics objects for the given metrics view.

Parameters:

• view (str) – The name of the metrics view.

• context (dict[str, str]) – The request context for the invocation.

Returns:

A tuple containing:

• dict[str, list[Metrics | None]] 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.

• int The local time of the process when the metrics objects were retrieved.

Return type:

tuple[dict[str, list[Metrics | None]], int]

Raises:

UnknownMetricsView – Thrown when the metrics view cannot be found.

getMetricsViewAsync(view: str, context: dict[str, str] | None = None) → Awaitable[tuple[dict[str, list[Metrics | None]], int]]

Gets the metrics objects for the given metrics view.

Parameters:

• view (str) – The name of the metrics view.

• context (dict[str, str]) – The request context for the invocation.

Returns:

A tuple containing:

• dict[str, list[Metrics | None]] 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.

• int The local time of the process when the metrics objects were retrieved.

Return type:

Awaitable[tuple[dict[str, list[Metrics | None]], int]]

getMetricsViewNames(context: dict[str, str] | None = None) → tuple[list[str], list[str]]

Gets the names of enabled and disabled metrics.

Parameters:

context (dict[str, str]) – The request context for the invocation.

Returns:

A tuple containing:

• list[str] The names of the enabled views.

• list[str] The names of the disabled views.

Return type:

tuple[list[str], list[str]]

getMetricsViewNamesAsync(context: dict[str, str] | None = None) → Awaitable[tuple[list[str], list[str]]]

Gets the names of enabled and disabled metrics.

Parameters:

context (dict[str, str]) – The request context for the invocation.

Returns:

A tuple containing:

• list[str] The names of the enabled views.

• list[str] The names of the disabled views.

Return type:

Awaitable[tuple[list[str], list[str]]]

static ice_staticId() → str

Gets the Slice type ID of the interface associated with this proxy.

Returns:

The type ID, “::Ice::Object”.

Return type:

str

static uncheckedCast(proxy: ObjectPrx, facet: str | None = None) → MetricsAdminPrx

static uncheckedCast(proxy: None, facet: str | None = None) → None

Creates a new proxy from an existing proxy.

Parameters:

• proxy (ObjectPrx | None) – The source proxy.

• facet (str, optional) – A facet name.

Returns:

A new proxy with the requested type, or None if the source proxy is None.

Return type:

ObjectPrx | None