HTTP REST Api endpoint health - IBM/ibm-spectrum-scale-bridge-for-grafana GitHub Wiki

  • /health

    • Available since: Version 9.1.2
    • Liveness probe endpoint. Confirms the bridge process is running and able to serve requests.
    • Intended for use by container orchestration platforms (Kubernetes, OpenShift) as a livenessProbe or readinessProbe, and can also be polled by monitoring tools or load balancers.
    • Does not perform any backend connectivity check (e.g. does not verify that the IBM Storage Scale performance monitoring collector is reachable).
    • No authentication is required.

Example output:

# curl http://10.88.0.178:4242/health
{"status": "ok"}

Kubernetes / OpenShift probe definition example:

livenessProbe:
  httpGet:
    path: /health
    port: 4242
  initialDelaySeconds: 10
  periodSeconds: 30
  failureThreshold: 3