Observability

Introduced in 0.5

If you want to track your webhooks and monitor their reception, you can do so with the Observability module.

Prometheus

You can activate the Prometheus module which will activate the /metrics endpoint and bring up the webhooked information.

To activate / desactivate the Prometheus module, on your configuration file set metricsEnabled to true or false

apiVersion: v1alpha1
observability:
  metricsEnabled: true
specs: []

The collected data is prefixed with webhooked namespace. All go metrics are also exported to respect the Prometheus recommendations.

Available additional metrics :

• webhooked_http_server_request_duration_seconds_bucket with labels: "method", "status_code", "version", "spec", "secure"
• webhooked_http_server_request_duration_seconds_count with labels: "method", "status_code", "version", "spec", "secure"
• webhooked_http_server_request_duration_seconds_sum with labels: "method", "status_code", "version", "spec", "secure"

Labels:

• method represents the HTTP Method (POST is currently the only method)
• status_code resume the code returned by webhooked to the server that sends the webhook
• version represents the current api version used (currently only v1alpha1)
• spec resume the name given in configuration file by you
• secure is a boolean that defines whether your specification uses a security strategy (true) or whether you receive your webhooks in insecure (false)