Skip to content
Merged
Show file tree
Hide file tree
Changes from 2 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[Paginate Messages and Events]
** 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
65 changes: 65 additions & 0 deletions modules/console/pages/ui/paginate-messages-events.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
= Paginate Messages and Pipeline Events in {ui}
:description: Retrieve more than 500 messages or pipeline events in {ui} by paging through larger result sets.
:page-topic-type: how-to


// tag::single-source[]

{description} Use pagination when you need to inspect large topics or debug
ifdef::env-cloud[]
xref:develop:connect/about.adoc[Redpanda Connect]
endif::[]
ifndef::env-cloud[]
xref:redpanda-connect:home:index.adoc[Redpanda Connect]
endif::[]
pipelines that emit more events than the initial result set includes.

== Paginate topic messages

When you browse a topic in {ui}, the *Messages* tab returns an initial batch of records. To retrieve additional records beyond this batch:
Comment thread
micheleRP marked this conversation as resolved.
Outdated

. In the menu, go to *Topics* and select a topic.
Comment thread
micheleRP marked this conversation as resolved.
Outdated
. Open the *Messages* tab.
. Apply any filters or a starting offset 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::[]
. After the initial results load, load the next batch to continue through the topic.

You can continue paginating until you reach the end of the topic or the end of the offset range you specified.

== Paginate Redpanda Connect pipeline events

When you debug a Redpanda Connect pipeline, {ui} shows the events the pipeline emits, including logs at the configured log level. Pipelines that run with debug-level logging often produce more events than fit in a single result set.

To retrieve additional pipeline events:

. In the menu, go to *Connect* and select the pipeline you want to debug.
. Open the pipeline's events view.
. After the initial events load, load the next batch to continue inspecting events.

ifdef::env-cloud[]
For guidance on configuring log levels and monitoring pipelines, see xref:develop:connect/configuration/monitor-connect.adoc[].
endif::[]
ifndef::env-cloud[]
For guidance on configuring log levels and monitoring pipelines, see xref:redpanda-connect:guides:monitoring.adoc[].
endif::[]

== 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 paginating.
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::[]
* For pipeline debugging, raise the log level only as long as you need it.

// end::single-source[]
Loading