Monitoring

Goma Gateway offers built-in monitoring capabilities to help you track the health, performance, and behavior of your gateway and its routes. Metrics are exposed in a Prometheus-compatible format and can be visualized using tools like Prometheus and Grafana.

The monitoring section in the configuration enables you to control observability features such as Prometheus metrics, readiness/liveness probes, and detailed route health checks.

Configuration Options

Key	Type	Default	Description
host	string	""	Restricts access to observability endpoints to a specific hostname.
enableMetrics	bool	false	Enables the Prometheus-compatible /metrics endpoint.
metricsPath	string	/metrics	Sets a custom path for metrics exposure.
enableReadiness	bool	true	Enables the /readyz readiness probe endpoint.
enableLiveness	bool	true	Enables the /healthz liveness probe endpoint.
enableRouteHealthCheck	bool	false	Enables the /healthz/routes endpoint for route-level health checks.
includeRouteHealthErrors	bool	false	Includes route errors in the /healthz/routes response if true.
middleware.metrics	[]string	[]	Middleware chain applied to the metrics endpoint.
middleware.routeHealthCheck	[]string	[]	Middleware chain applied to the route health check endpoint.

💡 Note: If host is not set, observability endpoints are accessible from any route host. To restrict access, set a specific host value.

---

Route-Level Metrics

By default, each route collects metrics. You can opt out of metrics for a specific route by setting:

disableMetrics: true

---

Example Monitoring Configuration

gateway:
  monitoring:
    enableMetrics: true                  # Enable Prometheus metrics
    metricsPath: /metrics                # Custom metrics path (optional)
    enableReadiness: true               # Enable /readyz endpoint
    enableLiveness: true                # Enable /healthz endpoint
    enableRouteHealthCheck: true        # Enable /healthz/routes
    includeRouteHealthErrors: true      # Include route errors in health checks
    middleware:
      metrics:
        - ldap                          # Middleware for /metrics
      routeHealthCheck:
        - ldap                          # Middleware for /healthz/routes

---

Accessing Metrics

Once configured, metrics are available at:

http://<gateway-host>:<port>/metrics

You can configure Prometheus to scrape this endpoint and use Grafana for visualization.

---

Health Endpoints

In addition to performance metrics, Goma Gateway provides dedicated endpoints to monitor health:

• Liveness Probe: /healthz
• Readiness Probe: /readyz
• Route Health Check: /healthz/routes (if enabled)

All endpoints return structured JSON indicating the current status.

---

Prometheus Scrape Configuration Example

scrape_configs:
  - job_name: "gateway"
    metrics_path: "/metrics"  # Optional, defaults to /metrics
    scheme: http              # Use https if TLS is enabled
    scrape_interval: 15s
    static_configs:
      - targets: ["gateway-host:port"]
        labels:
          application: "goma_gateway"
    basic_auth:               # Optional: enable if your gateway requires authentication
      username: username
      password: password
    tls_config:
      insecure_skip_verify: false

---

Available Metrics

Goma Gateway exposes several Prometheus metrics to monitor the gateway at various levels:

• gateway_middlewares_count — Number of registered middlewares.
• gateway_routes_count — Number of active routes.
• gateway_uptime_seconds — Gateway uptime in seconds.
• gateway_requests_total — Total processed requests (method, path, route).
• http_response_status_total — HTTP responses by status, method, path, route.
• http_request_duration_seconds — Histogram of request latencies.
• http_request_size_bytes — Histogram of request sizes.
• And many more…

---

Grafana Dashboard

A prebuilt Grafana dashboard is available to visualize metrics from Goma Gateway.

You can import it using dashboard ID: 23799

Dashboard Preview

---