Skip to content
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion local-antora-playbook.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ content:
- url: https://github.com/redpanda-data/docs
branches: [v/*, shared, site-search,'!v-end-of-life/*']
- url: https://github.com/redpanda-data/cloud-docs
branches: 'main'
branches: 'DOC-1907-paginate-messages-events'
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🔴 Critical

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
# Description: Verify cloud-docs branch reference is set to 'main'

# Check the cloud-docs branch configuration
grep -A1 "url: https://github.com/redpanda-data/cloud-docs" local-antora-playbook.yml | grep "branches:"

Repository: redpanda-data/docs

Length of output: 111


Revert cloud-docs branch reference to main before merging.

The cloud-docs source is currently pointing to the feature branch DOC-1907-paginate-messages-events (set for Netlify preview). Line 21 of local-antora-playbook.yml must be updated to branches: main as indicated in the PR checklist before this PR can be merged.

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@local-antora-playbook.yml` at line 21, The playbook currently sets the Antora
source branch to the feature branch via the YAML key `branches:
'DOC-1907-paginate-messages-events'`; update that `branches` value to `main` in
local-antora-playbook.yml (replace the string assigned to the `branches` key) so
the `cloud-docs` source points back to the main branch before merging.

- url: https://github.com/redpanda-data/redpanda-labs
branches: main
start_paths: [docs,'*/docs']
Expand Down
1 change: 1 addition & 0 deletions modules/ROOT/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down
2 changes: 1 addition & 1 deletion modules/console/pages/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
40 changes: 40 additions & 0 deletions modules/console/pages/ui/paginate-messages-events.adoc
Original file line number Diff line number Diff line change
@@ -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 up to the number of records set in *Max results*. Enable *Continuous Pagination* when you need to inspect a topic beyond that cap.
Comment thread
micheleRP marked this conversation as resolved.
Outdated

== Browse all messages in a topic

. In the menu, go to *Topics* and select a topic.
Comment thread
micheleRP marked this conversation as resolved.
Outdated
. 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*.
Comment thread
micheleRP marked this conversation as resolved.
Outdated
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[]