Flight recorder
The flight recorder available in the Enterprise Edition is an event collection tool that gathers various information about a working Tarantool instance, such as:
- logs
- metrics
- requests and responses
This information helps you investigate incidents related to crashing a Tarantool instance.
The flight recorder is disabled by default and can be enabled and configured for
a specific Tarantool instance.
To enable the flight recorder, set the flightrec_enabled
configuration option to true.
This option is dynamic and can be changed at runtime by calling box.cfg{}:
box.cfg{ flightrec_enabled = true }
After flightrec_enabled is set to true, the flight recorder starts collecting data in the flight recording file current.ttfr.
This file is stored in the memtx_dir directory.
If the instance crashes and reboots, Tarantool rotates the flight recording:
current.ttfr is renamed to <timestamp>.ttfr (for example, 20230411T050721.ttfr)
and the new current.ttfr file is created for collecting data.
In the case of correct shutdown (for example, using os.exit()),
Tarantool continues writing to the existing current.ttfr file after restart.
Примечание
Note that old flight recordings should be removed manually.
This section describes options related to the flight recorder configuration. Note that all options are dynamic and can be changed at runtime.
This section describes the flight recorder settings related to logging. For example, you can configure a more detailed logging level in the flight recorder for deeper analysis.
-
flightrec_logs_size¶ Specifies the size (in bytes) of the log storage. You can set this option to
0to disable the log storage.Type: integerDefault: 10485760Environment variable: TT_FLIGHTREC_LOGS_SIZE
-
flightrec_logs_max_msg_size¶ Specifies the maximum size (in bytes) of the log message. The log message is truncated if its size exceeds this limit.
Type: integerDefault: 4096Maximum: 16384Environment variable: TT_FLIGHTREC_LOGS_MAX_MSG_SIZE
This section describes the flight recorder settings related to collecting metrics.
-
flightrec_metrics_period¶ Specifies the time period (in seconds) that defines how long metrics are stored from the moment of dump. So, this value defines how much historical metrics data is collected up to the moment of crash. The frequency of metric dumps is defined by flightrec_metrics_interval.
Type: integerDefault: 180Environment variable: TT_FLIGHTREC_METRICS_PERIOD
-
flightrec_metrics_interval¶ Specifies the time interval (in seconds) that defines the frequency of dumping metrics. This value shouldn’t exceed flightrec_metrics_period.
Type: numberDefault: 1.0Minimum: 0.001Environment variable: TT_FLIGHTREC_METRICS_INTERVAL
Примечание
Given that the average size of a metrics entry is 2 kB, you can estimate the size of the metrics storage as follows:
(flightrec_metrics_period / flightrec_metrics_interval) * 2 kB
This section lists the flight recorder settings related to storing the request and response data.
-
flightrec_requests_size¶ Specifies the size (in bytes) of storage for the request and response data. You can set this parameter to
0to disable a storage of requests and responses.Type: integerDefault: 10485760Environment variable: TT_FLIGHTREC_REQUESTS_SIZE
-
flightrec_requests_max_req_size¶ Specifies the maximum size (in bytes) of a request entry. A request entry is truncated if this size is exceeded.
Type: integerDefault: 16384Environment variable: TT_FLIGHTREC_REQUESTS_MAX_REQ_SIZE
-
flightrec_requests_max_res_size¶ Specifies the maximum size (in bytes) of a response entry. A response entry is truncated if this size is exceeded.
Type: integerDefault: 16384Environment variable: TT_FLIGHTREC_REQUESTS_MAX_RES_SIZE