Create new Message Envelope page with new 25.2 features #19542
Conversation
✅ Deploy Preview for cockroachdb-interactivetutorials-docs canceled.
|
✅ Deploy Preview for cockroachdb-api-docs canceled.
|
✅ Netlify Preview
To edit notification comments on pull requests, go to your Netlify project configuration. |
6804b9d to
d33b480
Compare
| <a id="resolved-option"></a>`resolved` | Emit `resolved` timestamps in a format depending on the connected sink. **Note:** The `resolved` timestamp is emitted as a separate message, and has its own envelope containing a `resolved` key and a timestamp value as a string. For more details on the `resolved` options, refer to [Resolved messages]({% link {{ page.version.version }}/changefeed-messages.md %}#resolved-messages). | All | ||
| <a id="updated-option"></a>`updated` | Add an [`"updated"`](#updated) timestamp field to each message, showing the commit time of the change. When the changefeed runs an initial scan or a [schema change backfill]({% link {{ page.version.version }}/changefeed-messages.md %}#schema-changes-with-column-backfill), the `"updated"` field will reflect the time of the scan or backfill, not the MVCC timestamp. If you use `updated` with [`enriched_properties=source`](#enriched-properties-option), the `"updated"` field will be replaced with `"ts_ns"` and `"ts_hlc"` in the [`"source"`](#source) fields. **Note:** `envelope=enriched` with the `updated` option will not produce a change event commit timestamp in the message—to include the timestamp, use `updated` with `envelope=enriched, enriched_properties=source, updated`. | All | ||
|
|
||
| ### `envelope` option examples |
There was a problem hiding this comment.
All this content except the enriched part was existing.
New content begins again in the Field Reference section.
| CREATE CHANGEFEED FOR TABLE products INTO 'kafka://localhost:9092' WITH envelope=enriched, enriched_properties=source, updated; | ||
| ~~~ | ||
| ~~~ | ||
| {"after": {"category": "Home & Kitchen", "created_at": "2025-04-30T20:02:35.40316", "description": "Adjustable LED desk lamp with touch controls", "id": "4b36388a-f7e6-4b95-9f78-3aee9e2060d6", "in_stock": true, "name": "LED Desk Lamp", "price": 22.30}, "op": "c", "source": {"changefeed_sink": "kafka", "cluster_id": "585e6512-ea54-490a-8f1d-50c8d182a2e6", "cluster_name": "", "database_name": "test", "db_version": "v25.2.0-beta.2", "job_id": "1068153948173991937", "node_id": "1", "node_name": "localhost", "origin": "cockroachdb", "primary_keys": ["id"], "schema_name": "public", "source_node_locality": "", "table_name": "products", "ts_hlc": "1746045115619002000.0000000000", "ts_ns": 1746045115619002000}, "ts_ns": 1746045115679811000} |
There was a problem hiding this comment.
this is annoying to read. maybe we should split it across multiple lines?
|
|
||
| ### `"payload"` | ||
|
|
||
| The change event data. `"payload"` is a wrapper only with [webhook]({% link {{ page.version.version }}/changefeed-sinks.md %}#webhook-sink) sinks and when the [`enriched_properties`](#enriched-properties-option) options is used. |
There was a problem hiding this comment.
i guess there are two different payloads in question here, which is a little confusing. can you try to disambiguate them?
There was a problem hiding this comment.
maybe this organization/format doesnt make that much sense given that we're mixing fields from various envelopes together. this makes it seem like you can get all these fields but actually you only get a subset depending on envelope
There was a problem hiding this comment.
Added bullet points to the payload section to call out the difference between the two types of payload wrappers mentioned here. Lmk if you wanted something else.
As a reference, I think this works fine, and each description comes with the option/configuration that enables that field. The alternative would involve every combination as an example that imo would be harder to reference. Given the large number of examples already on this page, I'd like to give this format a shot, but be ready to adapt if we get signal this isn't working.
There was a problem hiding this comment.
I also think the fields and options are kind of ripe for automation something like what docs do for the cluster settings page; however, that is a much bigger project for another day involving more stakeholders.
Added similar language to what was already in the PR, in the |
|
|
||
| ~~~json | ||
| { | ||
| "payload": { |
There was a problem hiding this comment.
- now we're demoing an enriched envelope? the text didnt say that. i thought we were still talking about wrapped.
- payload wrapper only present if schema is
There was a problem hiding this comment.
this is still a problem i think. you switch envelope types without mentioning it.
There was a problem hiding this comment.
@asg0451 Latest commit removes the entire Overview section. This was just meant to be a high-level of the envelope features before the use case section, but mostly duplicates information that is throughout this page. Because this isn't landing, I've removed and moved the links to the content on the page into the introductory paragraphs. This should resolve the issue here.
fd9f508 to
9b9cc06
Compare
9eef7b6 to
88b1fb7
Compare
|
@asg0451 Please take another look, I've addressed each of the requested changes and the further comment. |
|
|
||
| It is important to consider that a full-fidelity envelope increases the size of each message significantly, which can have an impact on changefeed throughput. | ||
|
|
||
| Use the [`mvcc_timestamp`](#mvcc-timestamp-option), [`envelope=enriched, enriched_properties='source,schema'`](#enriched-properties-option), [`diff`](#diff-option), and [`key_in_value`](#key-in-value-option) (for Kafka) options with [`CREATE CHANGEFEED`]({% link {{ page.version.version }}/create-changefeed.md %}) to create a full-fidelity envelope: |
1f0e285 to
3a5c716
Compare
Fixes DOC-11555, DOC-12241, DOC-12307
This PR adds the new enriched envelope format for changefeed messages to docs and restructures our content on changefeed message envelopes.
Includes:
New Changefeed Message Envelope page
Other
CREATE CHANGEFEEDpage.Preview
New Changefeed Message Envelope page