Download Support Bundle
Required role: read or higher.
Generate a support bundle for a pipeline.
This endpoint collects various diagnostic data from the pipeline including circuit profile, heap profile, metrics, logs, stats, and connector statistics, and packages them into a single ZIP file for support purposes.
The response starts before the data is collected, and has no
Content-Length. When the bundle collects new data, its first entry,
collection_log.txt, gets a line every 10 seconds until the collection is
complete, so that the response is never idle for long. Data that the
pipeline cannot supply is reported inside the bundle. A failure after the
response started cuts the response short, so a client must check that the
ZIP file is complete.
| Path Parameters |
|---|
pipeline_name string — REQUIREDUnique pipeline name |
| Query Parameters |
|---|
collect booleanWhether to collect new data from the running pipeline (default: true) When false, only previously collected data will be included in the bundle |
limit int64Maximum number of collections to include in the bundle, counted from
the most recent. Must be at least 1; With the default |
circuit_profile booleanWhether to collect circuit profile data (default: true) |
heap_profile booleanWhether to collect heap profile data (default: true) |
metrics booleanWhether to collect metrics data (default: true) |
logs booleanWhether to collect logs data (default: true) |
stats booleanWhether to collect stats data (default: true) |
pipeline_config booleanWhether to collect pipeline configuration data (default: true) |
source_code booleanWhether the pipeline configuration includes the program source code
(default: true). When false, the bundle removes from the pipeline
configuration the SQL program, the UDF code, the generated Rust code,
and the code excerpts in the compiler messages. The dataflow graph is a
separate item, controlled by |
system_config booleanWhether to collect system configuration data (default: true) |
dataflow_graph booleanWhether to collect dataflow graph data (default: true) |
pipeline_events booleanWhether to collect the pipeline monitor event history (default: true) |
| Responses | ||||
|---|---|---|---|---|
200Support bundle containing diagnostic information
| ||||
400A query parameter was invalid (e.g.,
| ||||
404Pipeline with that name does not exist
| ||||
500
| ||||
503The database was busy before the response started (
|