diff --git a/pages/docs/deployment/self-host.mdx b/pages/docs/deployment/self-host.mdx index 22250f213..1b8ab1b90 100644 --- a/pages/docs/deployment/self-host.mdx +++ b/pages/docs/deployment/self-host.mdx @@ -200,7 +200,7 @@ The Enterprise Edition ([compare versions](/docs/deployment/feature-overview)) o ### Health and Readiness Check Endpoint Langfuse includes a health check endpoint at `/api/public/health` and a readiness check endpoint at `/api/public/ready`. -The health check endpoint checks both API functionality and database connectivity and indicates if the application is alive. +The health check endpoint checks the API functionality and indicates if the application is alive. The readiness check endpoint indicates if the application is ready to serve traffic. Access the health and readiness check endpoints: @@ -222,6 +222,10 @@ The potential responses from the readiness check endpoint are: Applications and monitoring services can call this endpoint periodically for health updates. +Per default, the healthcheck endpoint does not validate if the database is reachable, as there are cases where the +database is unavailable, but the application still serves traffic. +If you want to run database healthchecks, you can add `?failIfDatabaseUnavailable=true` to the healthcheck endpoint. + ### Encryption #### Encryption in transit (HTTPS) [#https] diff --git a/pages/docs/deployment/v3/overview.mdx b/pages/docs/deployment/v3/overview.mdx index c93657757..11e66fb2c 100644 --- a/pages/docs/deployment/v3/overview.mdx +++ b/pages/docs/deployment/v3/overview.mdx @@ -331,6 +331,10 @@ The potential responses from the readiness check endpoint are: Applications and monitoring services can call this endpoint periodically for health updates. +Per default, the Langfuse web healthcheck endpoint does not validate if the database is reachable, as there are cases where the +database is unavailable, but the application still serves traffic. +If you want to run database healthchecks, you can add `?failIfDatabaseUnavailable=true` to the healthcheck endpoint. + ### Encryption #### Encryption in transit (HTTPS) [#https]