Documentation

kapacitor record batch

The kapacitor record batch command records the result of a Kapacitor batch task. Once the recording is stopped, the command outputs the recording ID. If no recording ID is specified, Kapacitor assigns a random ID.

The command requires the following:

  • Time range to query: Use the -past flag or -start and -stop flags
  • Task ID: Use the -task flag

To replay the recording, see kapacitor replay.

Usage

kapacitor record batch [flags]

Flags

FlagDescription
-no-waitRun recording in the background
-pastSet start time via now - past
-recording-idID to assign to the recording
-startStart time for the set of queries
-stopStop time for the set of queries (default is now)
-taskRequired: Task ID (uses the queries in the task)

Examples

Record a batch task using an absolute time range

kapacitor record batch \
  -task example-task-id \
  -start 2023-01-01T00:00:00Z \
  -stop 2023-06-01T00:00:00Z

Record a batch task using a relative time range

kapacitor record batch \
  -task example-task-id \
  -past 90d

Record a batch task and assign a custom recording ID

kapacitor record batch \
  -task example-task-id \
  -past 90d \
  -recording-id 90d-example-task-rec

Was this page helpful?

Thank you for your feedback!


The future of Flux

Flux is going into maintenance mode. You can continue using it as you currently are without any changes to your code.

Flux is going into maintenance mode and will not be supported in InfluxDB 3.0. This was a decision based on the broad demand for SQL and the continued growth and adoption of InfluxQL. We are continuing to support Flux for users in 1.x and 2.x so you can continue using it with no changes to your code. If you are interested in transitioning to InfluxDB 3.0 and want to future-proof your code, we suggest using InfluxQL.

For information about the future of Flux, see the following: