symphony.bdk.core.service.health.health_service.HealthService#

class symphony.bdk.core.service.health.health_service.HealthService(system_api: symphony.bdk.gen.agent_api.system_api.SystemApi, signals_api: symphony.bdk.gen.agent_api.signals_api.SignalsApi, retry_config: symphony.bdk.core.config.model.bdk_retry_config.BdkRetryConfig)#

Bases: object

Service class for checking health of the Agent server.

__init__(system_api: symphony.bdk.gen.agent_api.system_api.SystemApi, signals_api: symphony.bdk.gen.agent_api.signals_api.SignalsApi, retry_config: symphony.bdk.core.config.model.bdk_retry_config.BdkRetryConfig)#

Methods

`__init__`(system_api, signals_api, retry_config)
`get_agent_info`()	Gets information about the Agent.
`health_check`()	Returns the connectivity status of your Agent server.
`health_check_extended`()	Returns the connectivity status of the Agent services as well as users connectivity.

async get_agent_info() → symphony.bdk.gen.agent_model.agent_info.AgentInfo#

Gets information about the Agent. Wraps the Agent Info v1 endpoint. Available on Agent 2.53.0 and above.

Returns: AgentInfo: information of the agent server.

async health_check() → symphony.bdk.gen.agent_model.v3_health.V3Health#

Returns the connectivity status of your Agent server. Wraps the Health Check v3 endpoint. If your Agent server is started and running properly, the status value will be UP. Available on Agent 2.57.0 and above.

Returns: V3Health: the connectivity status of your Agent server.

async health_check_extended() → symphony.bdk.gen.agent_model.v3_health.V3Health#

Returns the connectivity status of the Agent services as well as users connectivity. Wraps the Health Check Extended v3 endpoint. Available on Agent 2.57.0 and above.

Returns: V3Health: the connectivity status of the Agent services as well as users connectivity.