Skip to content

Commit

Permalink
feat: healthcheck (keephq#2820)
Browse files Browse the repository at this point in the history
  • Loading branch information
Matvey-Kuk authored Dec 12, 2024
1 parent c658931 commit afc4a72
Show file tree
Hide file tree
Showing 3 changed files with 31 additions and 0 deletions.
22 changes: 22 additions & 0 deletions docs/deployment/monitoring.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
title: "Monitoring"
sidebarTitle: "Monitoring"
---

# Healthchecks

Keep's Backend healthcheck url:
```
{BACKEND_API_URL}/healthcheck
```

Keep's Frontend healthcheck url:
```
{FRONTEND_URL}/api/healthcheck
```

# Prometheus Metrics

(TBD)

> Please note that [/api/metrics](api-ref/metrics/get-metrics) are not designed for production instance's health monitoring, but for usage monitoring by a specific tenant.
1 change: 1 addition & 0 deletions docs/mint.json
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,7 @@
"group": "Deployment",
"pages": [
"deployment/configuration",
"deployment/monitoring",
{
"group": "Authentication",
"pages": [
Expand Down
8 changes: 8 additions & 0 deletions keep-ui/app/api/healthcheck/route.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
import { NextResponse } from 'next/server'

export async function GET() {
return NextResponse.json({
status: 'ok',
timestamp: new Date().toISOString()
})
}

0 comments on commit afc4a72

Please sign in to comment.