Skip to content

Commit

Permalink
chore: document failIfDatabaseUnavailable healthcheck flag (#967)
Browse files Browse the repository at this point in the history
  • Loading branch information
Steffen911 authored Nov 14, 2024
1 parent 003aade commit f1daab6
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 1 deletion.
6 changes: 5 additions & 1 deletion pages/docs/deployment/self-host.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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]
Expand Down
4 changes: 4 additions & 0 deletions pages/docs/deployment/v3/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down

0 comments on commit f1daab6

Please sign in to comment.