Deployment
Observability
8 min
healthcheck the http endpoint /api/v1/status will return metadata and health info about the engine's cluster curl s localhost 4004/api/v1/status | jq { "clusters joined" { "1271a537 27f7 47e4 875d c5242ed12a72" true }, "web connected" true, "credential adapters" \[ "vault" ], "domain" null, "key adapters" \[ "deltacrdt", "vault" ], "ports" { "http" 4004, "https" 4443, "mysql" 3307, "postgres" 6543 } } description of returned values 194,549,246 false true unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type metrics metrics on flow and cluster status are collected by default they can be emitted to several locations based on the environment variables set on the engine for metrics with tags, a separate timeseries is created for every combination of tags within a metric for example, policy handling total will be reported separately for every handling value the following metrics are reported for all backends prometheus metrics are named slightly differently dots are replaced with underscores, eg database total instead of database total false true left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type false unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type statsd metrics are emitted over udp to the configured statsd host by default in addition to the common metrics, the following metrics are reported trueleft unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type statsd can be configured with these variables trueleft unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type datadog datadog is configured through the statsd metrics exporter jumpwire statsd type should be set to datadog for compatibility with dogstatsd in the datadog agent when using the datadog type, the following metrics will have a different format than the base statsd false true left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type prometheus enabled by default prometheus metrics are exposed on port 9568 at /metrics in addition to the common metrics, the following metrics are reported false true left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type cloudwatch access to the configured cloudwatch namespace is granted through iam credentials in addition to the common metrics, the following metrics are reported trueleft unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type unhandled content type unhandled content type unhandled content type unhandled content type cloudwatch can be configured with these variables trueleft unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type left unhandled content type