Comprobación de salud de terminales

Asegúrate de que todos tus servicios están en funcionamiento realizando llamadas a la API a puntos finales especiales, llamados puntos finales de comprobación de estado.

Estos puntos finales ejecutan comprobaciones de estado y devuelven un estado que te indica si el servicio que estás comprobando funciona o no.

Punto final de comprobación de estado de Orchestrator

Para comprobar la disponibilidad de tu instancia de Orchestrator y sus dependencias, utiliza los siguientes puntos de conexión:

• Obtener

  https://{yourDomain}/api/health: comprueba solo las dependencias críticas

• Obtener

  https://{yourDomain}/api/health/startup: comprueba todas las dependencias

De forma predeterminada, los puntos finales de las comprobaciones de estado anteriores devuelven un cuerpo de respuesta vacío.

Para ver qué comprobaciones de estado se han realizado y los estados que tienen:

1. En el mapa de configuración orchestrator-customconfig (configurado a través de orchestrator-configurator.sh), y
   añadir <add key="HealthCheck.DetailsKey" value="12345" /> en la sección <appsettings>. 12345 sirve como contraseña que le permite acceder a las comprobaciones de estado, así que no olvide cambiarla con un valor propio.
2. Reinicie IIS para asegurarse de que el cambio surta efecto.
3. Utilice la contraseña establecida previamente como parámetro de consulta en la llamada a la API de comprobación de estado (por ejemplo, /api/health?detailsKey=password). Si se realiza correctamente, la llamada devuelve un cuerpo de respuesta que contiene detalles sobre las comprobaciones de estado y sus estados.

Una vez que complete estos pasos, también se podrá acceder a la comprobación de estado desde una máquina diferente al servidor de Orchestrator.

Punto final de comprobación de estado del Identity Server

Para comprobar si el Identity Server funciona, utilice el siguiente punto de conexión:

• OBTENER https://{yourDomain}/identity/health

El cuerpo de respuesta de este punto final resume la configuración de Identity Server.

{
    "status": "Healthy",
    "results": {
        "ApplicationDbContext": {
            "status": "Healthy",
            "description": null,
            "data": {}
            },
        "AuditDbContext": {
            "status": "Healthy",
            "description": null,
            "data": {}
            },
        "PersistedGrantDbContext": {
            "status": "Healthy",
            "description": null,
            "data": {}
            },
        "IdentityServerConfigurationDbContext": {
            "status": "Healthy",
            "description": null,
            "data": {}
            }
    }
}

Un código de error 500 indica un estado incorrecto, sin embargo, puede devolver un cuerpo de respuesta. Compruebe el contenido del cuerpo de la respuesta para conocer los motivos.

Punto final de comprobación de estado de Webhooks

Para comprobar la disponibilidad de tu servicio Webhooks, utiliza el siguiente punto de conexión:

• OBTENER https://{yourDomain}/webhooks/api/status

Interpretación del código de respuesta

Interprete el código de respuesta de la siguiente manera:

• 200 OK: su servicio está en funcionamiento
• 5xx error: su servicio está inactivo

Algunas comprobaciones de estado pueden devolver un código de respuesta 200 OK y un estado Degraded , lo que significa que el componente marcado está en un estado degradado.