Gateway health and monitoring
Liveness endpoint
/health/live
Returns a status HTTP 200 when Gateway is up.
cURL example
Kubernetes startup probe
Port configuration
Probe configuration
Kubernetes liveness probe
Port configuration
Probe configuration
Readiness endpoint
/health/ready
Returns readiness of Gateway. Modules status:
NOTREADY
(initial state)READY
READY
state. Otherwise, it returns a 503 status code if Gateway is not ready to accept traffic yet.
cURL example
Docker-compose probe setup
The
healthcheck
configuration below is optional, as it’s already backed into the Conduktor image and not required unless you’re experiencing issues.Kubernetes readiness probe
Port configuration
Probe configuration
Gateway versions
/versions
Returns the Gateway version.
cURL example
Health (deprecated)
To check the health of Gateway, you can use the endpoint/health
on the Gateway API (by default, on port 8888
):
cURL Example
Output Example
Access Prometheus metrics from Gateway
The Prometheus endpoint is<gateway_host>:<gateway_port>/metrics
. For example:
GATEWAY_SECURED_METRICS
is enabled (which is the default setting), you will need to use the credentials specified in GATEWAY_ADMIN_API_USERS
to access it.
For example, using the default credentials, you can access the metrics with the following command:
Retrieve Gateway Metrics
Available metrics for Prometheus
Find out more about Gateway metrics.Audit log events
Event type | Description |
---|---|
Admin.KafkaConnect.Create | A Kafka Connect instance is created. |
Admin.KafkaConnect.Update | A Kafka Connect instance is updated |
Admin.KafkaConnect.Delete | A Kafka Connect instance is deleted. |
Admin.KsqlDB.Create | A ksqlDB instance is created. |
Admin.KsqlDB.Update | A ksqlDB instance is updated. |
Admin.KsqlDB.Delete | A ksqlDB instance is deleted. |
Admin.KafkaCluster.Create | A Kafka cluster is created. |
Admin.KafkaCluster.Update | A Kafka cluster is updated. |
Admin.KafkaCluster.Delete | A Kafka cluster is deleted. |
Admin.SchemaRegistry.ChangeCompatibility | The global compatibility of the schema registry is updated. |
Admin.Integration.Update | The alert integration (Slack, MS Teams, Webhook) is updated. |
Admin.AdminApiKey.Create | A new admin API key is created. |
Admin.AdminApiKey.Delete | An admin API key is deleted. |
Admin.DataMaskingPolicy.Create | A data masking policy is created. |
Admin.DataMaskingPolicy.Update | A data masking policy is updated. |
Admin.DataMaskingPolicy.Delete | A data masking policy is deleted. |
Admin.Certificate.Create | A certificate is created. |
Admin.Certificate.Delete | A certificate is deleted. |
Iam.User.Create | IAM user is created. |
Iam.User.Update | IAM user is updated. |
Iam.User.Delete | IAM user is deleted. |
Iam.User.Login | IAM user logs in. |
Iam.User.Logout | IAM user logs out. |
Iam.Group.Create | IAM group is created. |
Iam.Group.Update | IAM group is updated. |
Iam.Group.Delete | IAM group is deleted. |
Console endpoints
Liveness endpoint
/api/health/live
Returns a status HTTP 200 when Console is up.
cURL example
Kubernetes startup probe
Port configuration
Probe configuration
Kubernetes liveness probe
Port configuration
Probe configuration
Readiness/startup endpoint
/api/health/ready
Returns readiness of the Console.
Modules status :
NOTREADY
(initial state)READY
READY
state. Otherwise, it returns a 503 status code if Console fails to start.
cURL example
Docker-compose probe setup
The
healthcheck
configuration below is optional, as it’s already backed into the Conduktor image and not required unless you’re experiencing issues.Kubernetes readiness probe
Port configuration
Probe configuration
Console versions
/api/versions
This endpoint exposes module versions used to build the Console along with the overall Console version.
cURL example
Cortex monitoring endpoints
Cortex endpoint
/ready
on port 9009
Returns a status 200 with response ready
if Cortex is running
cURL example
Alertmanager endpoint
/ready
on port 9010
Returns a status 200 with response ready
if Alertmanager is running
cURL example
Prometheus endpoint
/-/healthy
on port 9090
Returns a status 200 with response Prometheus Server is Healthy.
if Prometheus is running
cURL example