Skip to main content

​
Gateway health and monitoring

​
Liveness endpoint

/health/live Returns a status HTTP 200 when Gateway is up.
cURL example
curl -s http://localhost:8888/health/live
Could be used to set up probes on Kubernetes.

​
Kubernetes startup probe

Port configuration

ports:
  - containerPort: 8888
    protocol: TCP
    name: httpprobe
Probe configuration
startupProbe:
    httpGet:
        path: /health/live
        port: httpprobe
    enabled: true
    initialDelaySeconds: 10
    periodSeconds: 10
    timeoutSeconds: 1
    failureThreshold: 5
    successThreshold: 1

​
Kubernetes liveness probe

Port configuration
ports:
  - containerPort: 8888
    protocol: TCP
    name: httpprobe
Probe configuration
livenessProbe:
  httpGet:
    path: /health/live
    port: httpprobe
  enabled: true
  initialDelaySeconds: 0
  periodSeconds: 5
  timeoutSeconds: 1
  failureThreshold: 3
  successThreshold: 1

​
Readiness endpoint

/health/ready Returns readiness of Gateway. Modules status:
  • NOTREADY (initial state)
  • READY
This endpoint returns a 200 status code if Gateway is in a READY state. Otherwise, it returns a 503 status code if Gateway is not ready to accept traffic yet.
cURL example
curl -s  http://localhost:8888/health/ready
# READY
Could be used to set up probes on docker-compose or Kubernetes.

​
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.
healthcheck:
  test:
    [
      'CMD-SHELL',
      'curl --fail http://localhost:${CDK_LISTENING_PORT:-8888}/health/ready',
    ]
  interval: 5s
  retries: 25

​
Kubernetes readiness probe

Port configuration

ports:
  - containerPort: 8888
    protocol: TCP
    name: httpprobe
Probe configuration
readinessProbe:
    httpGet:
        path: /health/ready
        port: httpprobe
    enabled: true
    initialDelaySeconds: 0
    periodSeconds: 5
    timeoutSeconds: 1
    failureThreshold: 3
    successThreshold: 1

​
Gateway versions

/versions Returns the Gateway version.
cURL example
curl -s  http://localhost:8888/versions | jq .
# {
#  "gateway": "3.12.0-SNAPSHOT"
# }

​
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
curl -s  http://localhost:8888/health | jq .
Output Example
{
  "status": "UP",
  "checks": [
    {
      "id": "buildInfo",
      "status": "UP",
      "data": {
        "version": "3.1.0",
        "time": "2024-06-03T20:32:32+0000",
        "commit": "41967691f4c54b5d76a3f1fa8aee3701903b89d9"
      }
    },
    {
      "id": "live",
      "status": "UP"
    }
  ],
  "outcome": "UP"
}

​
Access Prometheus metrics from Gateway

The Prometheus endpoint is <gateway_host>:<gateway_port>/metrics. For example: 
localhost:8888/metrics
Please be aware that if 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
curl conduktor-gateway:8888/metrics --user "admin:conduktor"

​
Available metrics for Prometheus

Find out more about Gateway metrics.

​
Audit log events

Event typeDescription
Admin.KafkaConnect.CreateA Kafka Connect instance is created.
Admin.KafkaConnect.UpdateA Kafka Connect instance is updated
Admin.KafkaConnect.DeleteA Kafka Connect instance is deleted.
Admin.KsqlDB.CreateA ksqlDB instance is created.
Admin.KsqlDB.UpdateA ksqlDB instance is updated.
Admin.KsqlDB.DeleteA ksqlDB instance is deleted.
Admin.KafkaCluster.CreateA Kafka cluster is created.
Admin.KafkaCluster.UpdateA Kafka cluster is updated.
Admin.KafkaCluster.DeleteA Kafka cluster is deleted.
Admin.SchemaRegistry.ChangeCompatibilityThe global compatibility of the schema registry is updated.
Admin.Integration.UpdateThe alert integration (Slack, MS Teams, Webhook) is updated.
Admin.AdminApiKey.CreateA new admin API key is created.
Admin.AdminApiKey.DeleteAn admin API key is deleted.
Admin.DataMaskingPolicy.CreateA data masking policy is created.
Admin.DataMaskingPolicy.UpdateA data masking policy is updated.
Admin.DataMaskingPolicy.DeleteA data masking policy is deleted.
Admin.Certificate.CreateA certificate is created.
Admin.Certificate.DeleteA certificate is deleted.
Iam.User.CreateIAM user is created.
Iam.User.UpdateIAM user is updated.
Iam.User.DeleteIAM user is deleted.
Iam.User.LoginIAM user logs in.
Iam.User.LogoutIAM user logs out.
Iam.Group.CreateIAM group is created.
Iam.Group.UpdateIAM group is updated.
Iam.Group.DeleteIAM group is deleted.

​
Console endpoints

​
Liveness endpoint

/api/health/live Returns a status HTTP 200 when Console is up.
cURL example
curl -s  http://localhost:8080/api/health/live
Could be used to set up probes on Kubernetes.

​
Kubernetes startup probe

Port configuration

ports:
  - containerPort: 8080
    protocol: TCP
    name: httpprobe
Probe configuration
startupProbe:
    httpGet:
        path: /api/health/live
        port: httpprobe
    enabled: false
    initialDelaySeconds: 10
    periodSeconds: 10
    timeoutSeconds: 5
    failureThreshold: 10
    successThreshold: 1

​
Kubernetes liveness probe

Port configuration
ports:
  - containerPort: 8080
    protocol: TCP
    name: httpprobe
Probe configuration
livenessProbe:
  httpGet:
    path: /api/health/live
    port: httpprobe
  enabled: true
  initialDelaySeconds: 30
  periodSeconds: 10
  timeoutSeconds: 5
  failureThreshold: 3
  successThreshold: 1

​
Readiness/startup endpoint

/api/health/ready Returns readiness of the Console. Modules status :
  • NOTREADY (initial state)
  • READY
This endpoint returns a 200 status code if Console is in a READY state. Otherwise, it returns a 503 status code if Console fails to start.
cURL example
curl -s  http://localhost:8080/api/health/ready
# READY
Could be used to set up probes on docker-compose or Kubernetes.

​
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.
healthcheck:
  test:
    [
      'CMD-SHELL',
      'curl --fail http://localhost:${CDK_LISTENING_PORT:-8080}/api/health/ready',
    ]
  interval: 10s
  start_period: 120s # Leave time for the psql init scripts to run
  timeout: 5s
  retries: 3

​
Kubernetes readiness probe

Port configuration
ports:
  - containerPort: 8080
    protocol: TCP
    name: httpprobe
Probe configuration
readinessProbe:
  httpGet:
    path: /api/health/ready
    port: httpprobe
  enabled: true
  initialDelaySeconds: 30
  periodSeconds: 10
  timeoutSeconds: 5
  failureThreshold: 3
  successThreshold: 1

​
Console versions

/api/versions This endpoint exposes module versions used to build the Console along with the overall Console version.
cURL example
curl -s  http://localhost:8080/api/versions | jq .
# {
#  "platform": "1.27.0",
#  "platformCommit": "ed849cbd545bb4711985ce0d0c93ca8588a6b31f",
#  "console": "f97704187a7122f78ddc9110c09abdd1a9f9d470",
#  "console_web": "05dea2124c01dfd9479bc0eb22d9f7d8aed6911b"
# }

​
Cortex monitoring endpoints

​
Cortex endpoint

/ready on port 9009 Returns a status 200 with response ready if Cortex is running
cURL example
curl -s "http://localhost:9009/ready"

​
Alertmanager endpoint

/ready on port 9010 Returns a status 200 with response ready if Alertmanager is running
cURL example
curl -s "http://localhost:9010/ready"

​
Prometheus endpoint

/-/healthy on port 9090 Returns a status 200 with response Prometheus Server is Healthy. if Prometheus is running
cURL example
curl -s "http://localhost:9090/-/healthy"