Monitor Service

Ansys HPS includes a Monitor Service that provides real-time streaming of logs and metrics from running evaluators and HPS services over WebSocket, as well as build metadata over REST.

The ansys.hps.client.monitor Python subpackage provides a client for the monitor REST and WebSocket interfaces.

APIs

MonitorApi(client[, ws_connection_options, ...])

Client for the HPS monitor REST and WebSocket interfaces.

Models

BuildInfoResponse(payload)	Typed wrapper for monitor build-info responses.
MonitorMessage(payload)	Typed wrapper around a single monitor message payload.
MessageEnvelope(messages)	Typed model for normalizing monitor WebSocket message payloads.
ListTagsCommand([limit])	Typed model for the monitor WebSocket list_tags command.
ListTagsResponse(tag_list)	Typed model for the monitor list_tags response payload.
SubscribeCommand(topics[, backlog_limit])	Typed model for the monitor WebSocket subscribe command.