/health/live
Returns a status HTTP 200 when Gateway is up.
/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.
healthcheck
configuration below is optional, as it’s already backed into the Conduktor image and not required unless you’re experiencing issues./versions
Returns the Gateway version.
/health
on the Gateway API (by default, on port 8888
):
<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:
Metric description | Metric value |
---|---|
The number of connections closed per second | gateway_upstream_connection_close_rate |
The total number of connections closed | gateway_upstream_connection_close_total |
The number of new connections established per second | gateway_upstream_connection_creation_rate |
The total number of new connections established | gateway_upstream_connection_creation_total |
The number of times the I/O layer checked for new I/O to perform per second | gateway_upstream_select_rate |
The total number of times the I/O layer checked for new I/O to perform | gateway_upstream_select_total |
The number of time the I/O thread spent waiting | gateway_upstream_io_wait_rate |
The total time the I/O thread spent waiting | gateway_upstream_io_wait_total |
The number of active broker connections of the connection pool | gateway_brokered_active_connections |
The number of active connections per vcluster | gateway_active_connections_vcluster |
The latency to process a request and generate a response | gateway_latency_request_response |
The latency to process a request and generate a response for each ApiKey | gateway_apiKeys_latency_request_response |
The total number of bytes exchanged through Gateway | gateway_bytes_exchanged |
The total bytes exchanged within the context of the specified Virtual Cluster | gateway_bytes_exchanged_vcluster |
A counter on number of rebuilding kafka request | gateway_thread_request_rebuild |
The number of pending tasks on our Gateway thread (where all rebuilding request/response happen) | gateway_thread_tasks |
The number of connections from Gateway to the backing Kafka cluster | gateway_upstream_connections_upstream_connected |
The number of connections from clients to Gateway | gateway_upstream_connections_downstream |
The number of Kafka nodes | gateway_upstream_io_nodes |
The size of the kcache (equal to the number of key-value pairs we have in the cache) | gateway_kcache_size |
The number of active backend brokers | gateway_backend_brokered_active_connections |
The number of authentication attempts that failed for each user | gateway_failed_authentications |
The log end offset of client topics | gateway_topic_log_end_offset |
The current offset of consumer group on client topic | gateway_topic_current_offset |
The total bytes exchanged within the context of the specified topic | gateway_bytes_exchanged_topic_total |
The total errors per API key for the specified virtual cluster and username | gateway_error_per_apiKeys |
The current inflight API keys of the specified virtual cluster and username | gateway_current_inflight_apiKeys |
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. |
/api/health/live
Returns a status HTTP 200 when Console is up.
/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.
healthcheck
configuration below is optional, as it’s already backed into the Conduktor image and not required unless you’re experiencing issues./api/versions
This endpoint exposes module versions used to build the Console along with the overall Console version.
/ready
on port 9009
Returns a status 200 with response ready
if Cortex is running
/ready
on port 9010
Returns a status 200 with response ready
if Alertmanager is running
/-/healthy
on port 9090
Returns a status 200 with response Prometheus Server is Healthy.
if Prometheus is running