KSQL versus ksqlDB¶
Overview of key differences between KSQL and ksqlDB.
Install and configure ksqlDB¶
You have a number of options when you set up ksqlDB Server. For more information on installing and configuring ksqlDB, see the following topics.
- Configure ksqlDB Server
- Configure ksqlDB CLI
- Configure Security
- ksqlDB Configuration Parameter Reference
- The ksqlDB REST API supports a "server info" request at
http://<server>:8088/infoand a basic server health check endpoint at
- Check runtime stats for the ksqlDB server that you are connected to
DESCRIBE EXTENDED <stream or table>and
EXPLAIN <name of query>.
ksql-print-metricson a ksqlDB server. For example, see this blog post.
The Capacity Planning guide describes how to size your ksqlDB clusters.
If ksqlDB isn't behaving as expected, see Troubleshoot ksqlDB issues
Monitoring and Metrics¶
ksqlDB includes JMX (Java Management Extensions) metrics which give insights into what is happening inside your ksqlDB servers. These metrics include the number of messages, the total throughput, throughput distribution, error rate, and more.
To enable JMX metrics, set
JMX_PORT before starting the ksqlDB server:
ksql-print-metrics command line utility collects these metrics and
prints them to the console. You can invoke this utility from your
Your output should resemble:
1 2 3 4 5 6 7 8 9
For more information about Kafka Streams metrics, see Monitoring Streams Applications.
- Watch the screencast of Taking KSQL to Production.
Page last revised on: 2020-04-29