Skip to content

Commit 59c565d

Browse files
committed
docs: Add Cayenne CDC and scan-path observability metrics
Document the new OpenTelemetry instruments registered for CDC ingestion (burst duration, bytes, envelopes, fixed-cost phases) and scan-path observability (listing table cache, fence wait, scan duration) in the Cayenne deployment guide.
1 parent 179393a commit 59c565d

1 file changed

Lines changed: 18 additions & 1 deletion

File tree

website/docs/components/data-accelerators/cayenne/deployment.md

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,24 @@ Vortex compression typically delivers 2–4× better compression than Parquet Sn
7272

7373
## Metrics
7474

75-
Generic acceleration metrics are available with the `dataset_acceleration_` prefix. Cayenne-specific OpenTelemetry instruments are not currently registered at the runtime layer; use Cayenne's footer/segment cache hit rates surfaced via query plan explain and the generic acceleration counters.
75+
Generic acceleration metrics are available with the `dataset_acceleration_` prefix. Cayenne also registers the following OpenTelemetry instruments for CDC ingestion and scan-path observability, all tagged by `dataset`:
76+
77+
### CDC Apply Metrics
78+
79+
| Metric | Type | Unit | Description |
80+
| ------ | ---- | ---- | ----------- |
81+
| `dataset_acceleration_cdc_apply_burst_duration_ms` | Histogram | ms | Duration to apply one coalesced CDC burst. |
82+
| `dataset_acceleration_cdc_apply_burst_bytes` | Histogram | bytes | Arrow in-memory bytes in one coalesced CDC apply burst. |
83+
| `dataset_acceleration_cdc_apply_burst_envelopes` | Histogram | envelopes | Number of source envelopes in one coalesced CDC apply burst. |
84+
| `dataset_acceleration_cdc_apply_fixed_cost_ms` | Histogram | ms | Duration for fixed-cost phases of CDC apply (with `phase` label: `finalize_wait`, `commit_wait`, etc.). |
85+
86+
### Scan-Path Metrics
87+
88+
| Metric | Type | Unit | Description |
89+
| ------ | ---- | ---- | ----------- |
90+
| `cayenne_scan_listing_table_cache_entries` | Gauge | entries | Number of entries in the scan `ListingTable` cache. Cleared on snapshot change (compaction/sort/overwrite). |
91+
| `cayenne_listing_fence_wait_duration_ms` | Histogram | ms | Time spent waiting on listing-fence reads during scans. |
92+
| `cayenne_listing_scan_duration_ms` | Histogram | ms | Duration of listing-table scans. |
7693

7794
See [Component Metrics](../../../features/observability/component_metrics) for enabling and exporting metrics.
7895

0 commit comments

Comments
 (0)