Skip to main content

Platform Monitoring

Set up infrastructure-level monitoring for your kuploy-cloud deployment. This covers Prometheus integration, alerting rules, health endpoints, and log aggregation.

For application-level monitoring (logs, metrics, alerts from the developer perspective), see Monitoring & Logs.

Health Endpoints

Kuploy exposes two health endpoints for liveness and readiness probes:

EndpointPurpose
/api/healthBasic health check (is the process running?)
/api/health/readyReadiness check (is the database connected?)
# Test from inside cluster
kubectl exec -it deployment/kuploy -n kuploy -- curl -s localhost:3000/api/health

# Test from outside (if ingress is configured)
curl -s https://console.example.com/api/health

Prometheus Metrics

Kuploy exposes Prometheus-compatible metrics at /metrics. To scrape them, create a ServiceMonitor:

apiVersion: monitoring.coreos.com/v1
kind: ServiceMonitor
metadata:
name: kuploy
namespace: kuploy
spec:
selector:
matchLabels:
app.kubernetes.io/name: kuploy
endpoints:
- port: http
path: /metrics

Alerting Rules

Example alerts for Prometheus Alertmanager:

groups:
- name: kuploy
rules:
- alert: KuployDown
expr: up{job="kuploy"} == 0
for: 5m
labels:
severity: critical
annotations:
summary: "Kuploy is down"
- alert: KuployHighErrorRate
expr: rate(http_requests_total{job="kuploy",status=~"5.."}[5m]) > 0.1
for: 5m
labels:
severity: warning

External Monitoring Integrations

Export metrics to your preferred monitoring platform:

  • Prometheus — Metrics endpoint available at /metrics
  • Datadog — Use the Datadog agent integration
  • New Relic — Install the New Relic agent
  • Grafana — Connect via Prometheus endpoint

Log Aggregation

Forward logs to external services for centralized analysis:

  • Papertrail — Configure syslog forwarding
  • Logtail — Use the Logtail drain
  • Datadog Logs — Configure log forwarding
  • Elasticsearch — Set up log shipping

To configure log forwarding:

  1. Go to SettingsLog Drains
  2. Click Add Drain
  3. Select your provider
  4. Enter connection details
  5. Click Save