Skip to main content

ā€‹
Overview

Health and metrics endpoints provide service status information, deployment details, and runtime performance data for monitoring and verification.

ā€‹
GET /health

Retrieve service health status and deployment information.

ā€‹
Request

curl https://gitgost.leapcell.app/health

ā€‹
Response

ā€‹
status
string
required
Service health status. Always returns "healthy" when responding.
ā€‹
deployedCommit
string
required
Full Git commit hash of the currently deployed version
ā€‹
deployedAt
string
required
Build timestamp of the deployed binary (ISO 8601 format or ā€œunknownā€ if not set)
ā€‹
sourceRepo
string
required
GitHub repository URL where the source code is hosted
ā€‹
leapcell
boolean
required
Indicates deployment on Leapcell platform. Always true for the official instance.
ā€‹
goVersion
string
required
Go runtime version used to compile the binary (e.g., go1.21.5)
ā€‹
verify
object
required
Verification links for auditing the deployed code
ā€‹
verify.github
string
Direct link to the commit on GitHub
ā€‹
verify.source
string
Verification notice indicating full auditability

ā€‹
Response Example

{
  "status": "healthy",
  "deployedCommit": "a3f2c1e9b7d4f8a2c5e1d9b4f7a8c3e6d2b5f9a1",
  "deployedAt": "2026-03-05T10:23:45Z",
  "sourceRepo": "https://github.com/livrasand/gitGost",
  "leapcell": true,
  "goVersion": "go1.21.5",
  "verify": {
    "github": "https://github.com/livrasand/gitGost/commit/a3f2c1e9b7d4f8a2c5e1d9b4f7a8c3e6d2b5f9a1",
    "source": "100% open source - auditable"
  }
}

ā€‹
Use Cases

ā€‹
Uptime Monitoring

Healthcheck Script
#!/bin/bash
STATUS=$(curl -s https://gitgost.leapcell.app/health | jq -r '.status')
if [ "$STATUS" != "healthy" ]; then
  echo "gitGost is down!"
  exit 1
fi

ā€‹
Deployment Verification

Verify Deployment
# Check what commit is currently deployed
curl -s https://gitgost.leapcell.app/health | jq -r '.deployedCommit'

# Verify the commit exists on GitHub
COMMIT=$(curl -s https://gitgost.leapcell.app/health | jq -r '.deployedCommit')
open "https://github.com/livrasand/gitGost/commit/$COMMIT"

ā€‹
CI/CD Integration

GitHub Actions
steps:
  - name: Check gitGost Health
    run: |
      HEALTH=$(curl -sf https://gitgost.leapcell.app/health)
      echo "Service status: $(echo $HEALTH | jq -r '.status')"
      echo "Deployed commit: $(echo $HEALTH | jq -r '.deployedCommit')"

ā€‹
GET /metrics

Retrieve runtime performance metrics.

ā€‹
Request

curl https://gitgost.leapcell.app/metrics

ā€‹
Response

ā€‹
memory
object
required
Memory usage statistics from Go runtime
ā€‹
memory.alloc
integer
Bytes of allocated heap objects (currently in use)
ā€‹
memory.total_alloc
integer
Cumulative bytes allocated for heap objects (lifetime total)
ā€‹
memory.sys
integer
Total bytes of memory obtained from the OS
ā€‹
memory.num_gc
integer
Number of completed garbage collection cycles
ā€‹
goroutines
integer
required
Number of currently active goroutines
ā€‹
uptime
string
required
Service uptime since last restart (human-readable duration, e.g., ā€œ4h23m15sā€)

ā€‹
Response Example

{
  "memory": {
    "alloc": 12485632,
    "total_alloc": 245678912,
    "sys": 35782656,
    "num_gc": 42
  },
  "goroutines": 23,
  "uptime": "4h23m15.234567s"
}

ā€‹
Metric Interpretation

MetricMeaningHealthy Range
memory.allocCurrent heap usage< 500 MB typical
memory.sysTotal OS memory< 1 GB typical
goroutinesConcurrent operations10-100 normal
uptimeTime since restartHigher = stable

ā€‹
Use Cases

ā€‹
Performance Monitoring

Monitor Memory Growth
while true; do
  ALLOC=$(curl -s https://gitgost.leapcell.app/metrics | jq '.memory.alloc')
  echo "$(date): Memory: $((ALLOC / 1024 / 1024)) MB"
  sleep 60
done

ā€‹
Alert on High Goroutine Count

Goroutine Monitor
GOROUTINES=$(curl -s https://gitgost.leapcell.app/metrics | jq '.goroutines')
if [ "$GOROUTINES" -gt 200 ]; then
  echo "WARNING: High goroutine count: $GOROUTINES"
fi

ā€‹
GET /api/status

Retrieve current service operational status (used by frontend).

ā€‹
Request

curl https://gitgost.leapcell.app/api/status

ā€‹
Response

ā€‹
panic_mode
boolean
required
Indicates if the service is currently suspended. When true, all push operations are rejected.

ā€‹
Response Example

ā€‹
Normal Operation

{
  "panic_mode": false
}

ā€‹
Service Suspended

{
  "panic_mode": true
}

ā€‹
Usage

The frontend polls this endpoint to display service status banners. When panic mode is active:
  • All Git push operations are rejected with an explanatory message
  • The website shows a prominent suspension notice
  • The deployed badge changes to red
See Moderation for panic mode control.

ā€‹
Security Notes

ā€‹
Exposed Information

All health endpoints expose only public information:
  • Git commit hashes (public on GitHub)
  • Build timestamps (non-sensitive)
  • Memory/runtime stats (non-sensitive)
  • Service status (public)

ā€‹
No Sensitive Data

These endpoints never expose:
  • Environment variables
  • API tokens or secrets
  • Database credentials
  • User data or IP addresses
  • Internal configuration

ā€‹
No Authentication Required

Health and metrics endpoints are intentionally public for:
  • Uptime monitoring services
  • Transparency and verification
  • Operational observability
  • Trust building through openness

ā€‹
Implementation Reference

Source: internal/http/handlers.go
  • HealthHandler (lines 493-506)
  • MetricsHandler (lines 508-522)
  • ServiceStatusHandler (lines 817-822)
  • SetBuildInfo (lines 531-535)
  • Build info variables (lines 524-528)
  • Runtime tracking (lines 537-538)
Router configuration: internal/http/router.go (lines 140-141, 215)

Build docs developers (and LLMs) love

Get started for freeTalk to us