Skip to content

Commit

Permalink
storage: adjust statistics docs to use new names
Browse files Browse the repository at this point in the history
  • Loading branch information
@guswynn
guswynn committed Feb 15, 2024
1 parent eeeaad7 commit 90acd55
Showing 1 changed file with 15 additions and 15 deletions.
30 changes: 15 additions & 15 deletions doc/user/content/sql/system-catalog/mz_internal.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -857,21 +857,21 @@ these statistics. They are occasionally reset to zero as internal components of
the system are restarted.

<!-- RELATION_SPEC mz_internal.mz_source_statistics_raw -->
| Field | Type | Meaning |
| -------------------------|------------- | -------- |
| `id` | [`text`] | The ID of the source. Corresponds to [`mz_catalog.mz_sources.id`](../mz_catalog#mz_sources). |
| `messages_received` | [`uint8`] | The number of messages the worker has received from the external system. Messages are counted in a source type-specific manner. Messages do not correspond directly to updates: some messages produce multiple updates, while other messages may be coalesced into a single update. |
| `bytes_received` | [`uint8`] | The number of bytes the worker has read from the external system. Bytes are counted in a source type-specific manner and may or may not include protocol overhead. |
| `updates_staged` | [`uint8`] | The number of updates (insertions plus deletions) the worker has written but not yet committed to the storage layer. |
| `updates_committed` | [`uint8`] | The number of updates (insertions plus deletions) the worker has committed to the storage layer. |
| `records_indexed` | [`uint8`] | The number of individual records stored in the source envelope state. |
| `bytes_indexed` | [`uint8`] | The number of bytes stored in the source envelope state. |
| `rehydration_latency` | [`interval`] | The amount of time it took for the worker to rehydrate the source envelope state. |
| `snapshot_records_known` | [`uint8`] | Not yet populated. {{< warn-if-unreleased v0.87 >}} |
| `snapshot_records_staged` | [`uint8`] | Not yet populated. {{< warn-if-unreleased v0.87 >}} |
| `snapshot_committed` | [`boolean`] | Whether the worker has committed the initial snapshot for a source. |
| `offset_known` | [`uint8`] | Not yet populated. {{< warn-if-unreleased v0.87 >}} |
| `offset_committed` | [`uint8`] | Not yet populated. {{< warn-if-unreleased v0.87 >}} |
| Field | Type | Meaning |
| --------------------------|------------- | -------- |
| `id` | [`text`] | The ID of the source. Corresponds to [`mz_catalog.mz_sources.id`](../mz_catalog#mz_sources). |
| `messages_received` | [`uint8`] | The number of messages the worker has received from the external system. Messages are counted in a source type-specific manner. Messages do not correspond directly to updates: some messages produce multiple updates, while other messages may be coalesced into a single update. |
| `bytes_received` | [`uint8`] | The number of bytes the worker has read from the external system. Bytes are counted in a source type-specific manner and may or may not include protocol overhead. |
| `updates_staged` | [`uint8`] | The number of updates (insertions plus deletions) the worker has written but not yet committed to the storage layer. |
| `updates_committed` | [`uint8`] | The number of updates (insertions plus deletions) the worker has committed to the storage layer. |
| `records_indexed` | [`uint8`] | The number of individual records indexed in the source envelope state. |
| `bytes_indexed` | [`uint8`] | The number of bytes indexed in the source envelope state. |
| `rehydration_latency` | [`interval`] | The amount of time it took for the worker to rehydrate the source envelope state. |
| `snapshot_records_known` | [`uint8`] | Not yet populated. {{< warn-if-unreleased v0.87 >}} |
| `snapshot_records_staged` | [`uint8`] | Not yet populated. {{< warn-if-unreleased v0.87 >}} |
| `snapshot_committed` | [`boolean`] | Whether the worker has committed the initial snapshot for a source. |
| `offset_known` | [`uint8`] | Not yet populated. {{< warn-if-unreleased v0.87 >}} |
| `offset_committed` | [`uint8`] | Not yet populated. {{< warn-if-unreleased v0.87 >}} |

### `mz_source_statistics`

Expand Down

0 comments on commit 90acd55

Please sign in to comment.