CrateDB Flight Recorder (CFR)¶
About
In a similar spirit like the Java Flight Recorder (JFR), CFR helps to collect information about CrateDB clusters for support requests and self-service debugging.
CFR is a utility application to acquire and export diagnostic information from CrateDB’s system tables into an archive file. You can transmit this file to support engineers, in order to optimally convey relevant information about your cluster, mostly for debugging and troubleshooting purposes.
Details
The CrateDB Flight Recorder (CFR) is an ETL application dumping all database
tables in the sys schema into a timestamped tarball archive file.
On the receiving end, the recording can be imported into another CrateDB
instance, in order to inspect and analyze it.
Flight recordings can be started against any running CrateDB cluster at runtime.
The utility connects to CrateDB like a regular client, talking SQL.
CFR is part of the CrateDB Toolkit (ctk cfr), and is also available as a
standalone application cratedb-cfr(.exe).
Synopsis¶
- Export:
cratedb-cfr sys-exportinvokes the export operation.- Import:
cratedb-cfr sys-importinvokes the import operation.
Install¶
Select one of the standalone application bundles, matching the platform and architecture of the corresponding system where you intend to run CFR.
Learn¶
Learn about the concepts of CFR, and how to use it.