diff --git a/modules/ROOT/nav.adoc b/modules/ROOT/nav.adoc index 8e30301d3a..f4e9ef7c02 100644 --- a/modules/ROOT/nav.adoc +++ b/modules/ROOT/nav.adoc @@ -49,6 +49,7 @@ *** xref:develop:consume-data/follower-fetching.adoc[Follower Fetching] *** xref:console:ui/programmable-push-filters.adoc[Filter Messages] *** xref:console:ui/record-deserialization.adoc[Deserialize Messages] +*** xref:console:ui/paginate-messages-events.adoc[] ** xref:develop:data-transforms/index.adoc[] *** xref:develop:data-transforms/how-transforms-work.adoc[Overview] *** xref:develop:data-transforms/run-transforms-index.adoc[Get Started] diff --git a/modules/console/pages/index.adoc b/modules/console/pages/index.adoc index c55aa249da..d6dd75943c 100644 --- a/modules/console/pages/index.adoc +++ b/modules/console/pages/index.adoc @@ -24,7 +24,7 @@ image::broker-overview.png[] Observe and debug your streaming data: -* *Message inspection*: Browse and filter messages within your topics, with options to search by key, timestamp, or custom filters. +* *Message inspection*: Browse and filter messages within your topics, with options to search by key, timestamp, or custom filters. See xref:console:ui/paginate-messages-events.adoc[] to inspect large result sets. * xref:console:ui/programmable-push-filters.adoc[*Programmable push filters*]: Write custom JavaScript filters to isolate specific messages, enabling deep inspection and debugging. * *Rewind and Replay*: Roll back consumer offsets to reprocess messages, allowing you to correct issues or replay data as needed. diff --git a/modules/console/pages/ui/paginate-messages-events.adoc b/modules/console/pages/ui/paginate-messages-events.adoc new file mode 100644 index 0000000000..2790fd67b7 --- /dev/null +++ b/modules/console/pages/ui/paginate-messages-events.adoc @@ -0,0 +1,40 @@ += Paginate Messages in {ui} +:description: Enable Continuous Pagination on a topic's Messages tab to scroll through all records instead of being capped by Max results. +:page-topic-type: how-to + + +// tag::single-source[] + +By default, the *Messages* tab on a topic returns the number of records set in *Max results*. Enable *Continuous Pagination* when you need to inspect a topic beyond that cap. + +== Browse all messages in a topic + +. Go to *Topics* and select a topic. +. Open the *Messages* tab. +. (Optional) Set *Start offset* and *Max results*, or apply filters, to narrow the records you want to inspect. ++ +ifdef::env-cloud[] +See xref:manage:schema-reg/programmable-push-filters.adoc[] and xref:manage:schema-reg/record-deserialization.adoc[]. +endif::[] +ifndef::env-cloud[] +See xref:console:ui/programmable-push-filters.adoc[] and xref:console:ui/record-deserialization.adoc[]. +endif::[] +. Enable the *Continuous Pagination* toggle. +. Scroll the message list. {ui} keeps loading records until you reach the end of the topic. + +When continuous pagination is on, the max results cap no longer limits the browsing session. + +== Performance considerations + +Retrieving large result sets increases load on the {ui} backend and the cluster. To keep responses fast: + +* Narrow the result set with filters or a bounded offset range before enabling continuous pagination. +ifdef::env-cloud[] +* Use xref:manage:schema-reg/programmable-push-filters.adoc[JavaScript push filters] to match only the records you need. +endif::[] +ifndef::env-cloud[] +* Use xref:console:ui/programmable-push-filters.adoc[JavaScript push filters] to match only the records you need. +endif::[] +* Leave continuous pagination off and rely on max results when you only need a sample. + +// end::single-source[]