Skip to content

Commit 9f0a03e

Browse files
committed
doc/user: document mz_dataflow_shutdown_durations_histogram
1 parent 4ee3b72 commit 9f0a03e

File tree

1 file changed

+21
-12
lines changed

1 file changed

+21
-12
lines changed

doc/user/content/sql/system-catalog/mz_internal.md

Lines changed: 21 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -415,6 +415,21 @@ The `mz_dataflow_addresses` view describes how the [dataflow] channels and opera
415415
| `id` | [`bigint`] | The ID of the channel or operator. Corresponds to [`mz_dataflow_channels.id`](#mz_dataflow_channels) or [`mz_dataflow_operators.id`](#mz_dataflow_operators). |
416416
| `address` | [`bigint list`] | A list of scope-local indexes indicating the path from the root to this channel or operator. |
417417

418+
### `mz_dataflow_arrangement_sizes`
419+
420+
The `mz_dataflow_arrangement_sizes` view describes how many records and batches
421+
are contained in operators under each dataflow.
422+
423+
| Field | Type | Meaning |
424+
|---------------|------------|------------------------------------------------------------------------------|
425+
| `id` | [`bigint`] | The ID of the [dataflow]. Corresponds to [`mz_dataflows.id`](#mz_dataflows). |
426+
| `name` | [`bigint`] | The name of the object (e.g., index) maintained by the dataflow. |
427+
| `records` | [`bigint`] | The number of records in all arrangements in the dataflow. |
428+
| `batches` | [`bigint`] | The number of batches in all arrangements in the dataflow. |
429+
| `size` | [`bigint`] | The utilized size in bytes of the arrangements. |
430+
| `capacity` | [`bigint`] | The capacity in bytes of the arrangements. Can be larger than the size. |
431+
| `allocations` | [`bigint`] | The number of separate memory allocations backing the arrangements. |
432+
418433
### `mz_dataflow_channels`
419434

420435
The `mz_dataflow_channels` view describes the communication channels between [dataflow] operators.
@@ -469,20 +484,14 @@ The `mz_dataflow_operator_parents` view describes how [dataflow] operators are n
469484
| `id` | [`bigint`] | The ID of the operator. Corresponds to [`mz_dataflow_operators.id`](#mz_dataflow_operators). |
470485
| `parent_id` | [`bigint`] | The ID of the operator's parent operator. Corresponds to [`mz_dataflow_operators.id`](#mz_dataflow_operators). |
471486

472-
### `mz_dataflow_arrangement_sizes`
487+
### `mz_dataflow_shutdown_durations_histogram`
473488

474-
The `mz_dataflow_arrangement_sizes` view describes how many records and batches
475-
are contained in operators under each dataflow.
489+
The `mz_dataflow_shutdown_durations_histogram` view describes a histogram of the time in nanoseconds required to fully shut down dropped [dataflows][dataflow].
476490

477-
| Field | Type | Meaning |
478-
|---------------|------------|------------------------------------------------------------------------------|
479-
| `id` | [`bigint`] | The ID of the [dataflow]. Corresponds to [`mz_dataflows.id`](#mz_dataflows). |
480-
| `name` | [`bigint`] | The name of the object (e.g., index) maintained by the dataflow. |
481-
| `records` | [`bigint`] | The number of records in all arrangements in the dataflow. |
482-
| `batches` | [`bigint`] | The number of batches in all arrangements in the dataflow. |
483-
| `size` | [`bigint`] | The utilized size in bytes of the arrangements. |
484-
| `capacity` | [`bigint`] | The capacity in bytes of the arrangements. Can be larger than the size. |
485-
| `allocations` | [`bigint`] | The number of separate memory allocations backing the arrangements. |
491+
| Field | Type | Meaning |
492+
| -------------- | ------------ | -------- |
493+
| `duration_ns` | [`bigint`] | The upper bound of the bucket in nanoseconds. |
494+
| `count` | [`bigint`] | The (noncumulative) count of dataflows in this bucket. |
486495

487496
### `mz_message_counts`
488497

0 commit comments

Comments
 (0)