Skip to content

Commit eb8de4f

Browse files
maheshwaripclaude
andcommitted
docs: add v26.38.0 notes for dictionary compression and observability
Documents three user-facing additions to the v26.38.0 release notes: * **Dictionary compression**, as a public-preview feature section. Covers the memory it saves when a column repeats values, the `EXPERIMENTAL ARRANGEMENT COMPRESSION` opt-in, and the CPU-for-memory tradeoff plus the replica replacement that changing the option triggers. The option is per cluster only; it is rejected on unmanaged clusters, per test/sqllogictest/managed_cluster.slt:450. * **Observability integrations for Self-Managed**, covering export of metrics and optionally logs to Datadog, Honeycomb, Google Cloud Monitoring, Prometheus remote write, or any OTLP endpoint, with the bundled monitoring stack the Terraform modules install as the fallback for deployments that have no stack of their own. * **materialize-debug-freshness**, the agent skill added in MaterializeInc/agent-skills#35. All 16 links and their anchors were verified to resolve against a local Hugo build, which passes clean. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
1 parent 0405c97 commit eb8de4f

1 file changed

Lines changed: 58 additions & 0 deletions

File tree

doc/user/content/releases/_index.md

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,11 +23,69 @@ both Cloud and Self-Managed. See [Release schedule](/releases/schedule) for deta
2323
*Released to Materialize Cloud: 2026-08-19* <br>
2424
*Released to Materialize Self-Managed: 2026-08-20* <br>
2525

26+
### Dictionary compression {#v26.38-dictionary-compression}
27+
28+
{{< public-preview />}}
29+
30+
Dictionary compression reduces the memory that
31+
[arrangements](/get-started/arrangements/#arrangements) use when a column holds the same values repeatedly. Instead of storing a repeated column value each time it appears, Materialize stores that value once and has each row reference it. This can reduce steady state memory requirements after [hydration](/concepts/hydration/) has completed.
32+
33+
Dictionary compression is off by default. You opt in per cluster with the
34+
`EXPERIMENTAL ARRANGEMENT COMPRESSION` option:
35+
36+
```mzsql
37+
-- Turn compression on for a new cluster
38+
CREATE CLUSTER my_cluster (
39+
SIZE = '100cc',
40+
EXPERIMENTAL ARRANGEMENT COMPRESSION = true
41+
);
42+
43+
-- Or turn it on for an existing cluster
44+
ALTER CLUSTER my_cluster SET (EXPERIMENTAL ARRANGEMENT COMPRESSION = true);
45+
```
46+
47+
For more information, see:
48+
- [Guide: Dictionary compression](/transform-data/dictionary-compression/), including [when it helps and when it does not](/transform-data/dictionary-compression/#the-tradeoff)
49+
- [`CREATE CLUSTER`: Dictionary compression](/sql/create-cluster/#dictionary-compression)
50+
- [`ALTER CLUSTER`: Dictionary compression](/sql/alter-cluster/#dictionary-compression)
51+
52+
### Integrate with your observability stack {#v26.38-self-managed-observability}
53+
54+
<red>*Materialize Self-Managed only*</red>
55+
56+
Materialize Self-Managed now integrates with the observability tools you already
57+
run. You can export metrics, and optionally logs, from Materialize to Datadog,
58+
Honeycomb, Google Cloud Monitoring, Prometheus remote write, or any monitoring
59+
backend with an Open Telemetry (OTLP) endpoint. Template dashboards and alerts are provided to
60+
help you get started.
61+
62+
Follow the instructions for your destination:
63+
- [Datadog](/manage/monitor/self-managed/datadog/)
64+
- [Honeycomb](/manage/monitor/self-managed/honeycomb/)
65+
- [Google Cloud Monitoring](/manage/monitor/self-managed/google-cloud-monitoring/)
66+
- [Prometheus remote write](/manage/monitor/self-managed/prometheus-remote-write/), for Mimir, Amazon Managed Prometheus, or Grafana Cloud
67+
- [OpenTelemetry](/manage/monitor/self-managed/opentelemetry/), for any other OTLP endpoint, including your own collector
68+
69+
If you don't have an observability stack set up, the [Materialize Terraform
70+
modules](/self-managed-deployments/installation/#install-using-terraform-modules)
71+
can deploy one alongside Materialize. It collects metrics from Materialize and
72+
from your Kubernetes cluster, collects Materialize's container logs and
73+
Kubernetes events, stores both in your own object storage, and ships [Grafana](/manage/monitor/self-managed/grafana/)
74+
dashboards and Alertmanager alert rules to query them. The stack is controlled by
75+
the `enable_observability` variable, which defaults to `true` starting with
76+
v11.0.0 of the modules.
77+
78+
For more information, see:
79+
- [Monitoring Self-Managed Materialize](/manage/monitor/self-managed/)
80+
- [How logs and metrics are stored and delivered](/manage/monitor/self-managed/storage/)
81+
- [Alerting](/manage/monitor/self-managed/alerting/)
82+
2683
### Improvements {#v26.38-improvements}
2784
- **Notice for single-replica sources on multi-replica clusters**: Materialize now warns when a command leaves a cluster holding more than one replica alongside PostgreSQL, MySQL, or SQL Server sources, which always run on a single replica, since the extra replicas make those sources neither more fault tolerant nor faster to ingest.
2885
- **Self-Managed: Graceful resizing of system clusters**: `ALTER CLUSTER ... SET (SIZE ...)` on a system cluster such as `mz_catalog_server` or `mz_system` now runs as a background graceful reconfiguration, with a 24-hour default deadline and a rollback on timeout, instead of recreating the whole replica set at once, so `SHOW CLUSTERS` settles on the new configuration rather than flipping to it.
2986

3087
### Agent Skills {#v26.38-agent-skills}
88+
- **materialize-debug-freshness**: New agent skill for diagnosing why an object is behind wall-clock time, whether that surfaces as a stale materialized view, index, or sink, or as a freshness alert. Running on the read-only tools of the Materialize developer MCP server, it ranks what is lagging, attributes the lag to a single hop, then rules out in-progress hydration, a replica dominated by one dataflow, and per-worker skew before naming the culprit operator and the SQL responsible for the expensive work.
3189
- **mz-deploy**: New agent skill covering the `mz-deploy` CLI — project layout, the compile/test/apply/stage/promote workflow, deploy IDs and staging suffixes, schema-granularity conflict detection, stable API schemas, profile resolution, and the `EXECUTE UNIT TEST` grammar.
3290
- **mz-sql-lsp**: New Claude Code plugin, installable from the `agent-skills` repository's new `materialize` plugin marketplace, that registers the `mz-deploy` language server for `.sql` files so agents can use go-to-definition, hover, and workspace symbols in an mz-deploy project instead of text search.
3391

0 commit comments

Comments
 (0)