Stream Browse (Messages)

Contents

Viewing Topic Messages

When you are producing data on a stream and you would like to see whether messages have ended up on the platform correctly, you can use Browse & Search. This functionality is found on the Topic Detail in the top right navigation.

Topic Messages Navigation

  1. Open the Topic Detail page

  2. Click Messages tab in the top right. The following screen will be shown

    Topic Messages Controls

  3. To browse a stream, change of the following filters Environent, Cluster, Relative time range or use the default values.

  4. Click on the Search button to execute the search.

  5. Optionally narrow down the search to a particular time window using absolute time range

    1. Click Time range and select Timestamp from (default: last hour) and Timestamp to (default: now)

    2. Choose how many results you want to see per page, by choosing a messages per page

    3. Click Apply

  6. Click the Search button to execute the search

Stream Browse search controls
You can also search stream messages using the search input field. type a keyword and hit Enter or click the Search button.

Providing there are messages available you will then be shown your results in a paginated table view such as below.

Search results

Every row shows:

  1. Technical message details: technical details about the message, see also Technical message details

  2. Key: the contents of the message Key (abbreviated with an ellipsis)

  3. Value: the contents of the message Value (abbreviated with an ellipsis)

Click a row to expand the view and open a viewer that shows the full message details, for which you can expand or collapse individual fields.

Search result (row) expanded

Pagination

Use the pagination controls in the bottom to jump to individual pages or use the arrow buttons to traverse search results. You can adjust the Page size before you search, to show more results per page.

Technical message details

Every row shows some technical details, which can be handy for debugging purposes:

  1. Partition: the stream’s partition the message is stored on

  2. Offset: the sequence number of the message on the partition

  3. timestamp: the producer timestamp

Controlling permissions to browse a stream

Tenant Admin can configure who can browse stream messages in an environment. This functionality is available when granular stream browse permissions is enabled for an instance. See Enabling Granular Stream Browse Permissions For An Instance

Granular Stream browse permissions are disabled in private environments and in public environments with the authorization issuer set to "auto".

  1. Visit the Topic Detail page and click on eye icon button inside the stream card.

Stream Browse Access Eye Icon

  1. The stream-browse permission modal opens as below:

Stream Browse Permission Modal

  1. Search for a user and add user. The added user is displayed below the search box.

  2. To Revoke user access, click on the Cross icon. A modal will appear to confirm action. Click on Revoke access button to continue. Otherwise, click Cancel to go back.