Skip to content

Conversation

@JakeSCahill
Copy link
Contributor

@JakeSCahill JakeSCahill commented Apr 2, 2025

Description

Resolves https://redpandadata.atlassian.net/browse/DOC-1006
Review deadline: April 4

This pull request includes significant enhancements and clarifications to the documentation for programmable push filters in Kafka, focusing on the use of JavaScript for filtering records. The changes improve readability, provide detailed examples, and clarify performance expectations.

Documentation improvements:

  • Updated the description to clarify the use of custom JavaScript code for filtering Kafka records within the UI.
  • Expanded the explanation of push-down filters, emphasizing their execution on the backend and the logical combination of multiple filters.
  • Added detailed instructions for adding a JavaScript filter, including navigation steps and input area usage.

Resource usage and performance:

  • Included a new section on resource usage and performance, detailing the impact of JavaScript filter complexity and data volume on CPU and network resources.

Examples and properties:

  • Provided multiple JavaScript filter examples for common scenarios, such as filtering by header value, timestamp, schema ID, JSON record values, and string keys.
  • Listed available JavaScript properties injected into the filter context, along with their descriptions and types.

Page previews

https://deploy-preview-1044--redpanda-docs-preview.netlify.app/current/console/ui/programmable-push-filters/

Checks

  • New feature
  • Content gap
  • Support Follow-up
  • Small fix (typos, links, copyedits, etc)

@JakeSCahill JakeSCahill requested a review from bojand April 2, 2025 14:57
@JakeSCahill JakeSCahill requested a review from a team as a code owner April 2, 2025 14:57
@netlify
Copy link

netlify bot commented Apr 2, 2025

Deploy Preview for redpanda-docs-preview ready!

Name Link
🔨 Latest commit ec2430e
🔍 Latest deploy log https://app.netlify.com/sites/redpanda-docs-preview/deploys/67ee95159f88cf00088236a1
😎 Deploy Preview https://deploy-preview-1044--redpanda-docs-preview.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@JakeSCahill JakeSCahill requested a review from bojand April 2, 2025 16:48
. Define your JavaScript filtering logic in the provided input area.

Suppose you have a series of Avro, JSON, or Protobuf encoded record values that deserialize to JSON objects like this:
image::ROOT:console:js-filter.png[alt="JavaScript filter in {ui}"]
Copy link
Contributor

Choose a reason for hiding this comment

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

Jake this is really nice, but since it's shared in Cloud, could you crop out the left nav?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Oh, interesting. The image is currently autogenerated from our tests. I'll exclude it from Cloud for now.

Copy link
Contributor

@micheleRP micheleRP left a comment

Choose a reason for hiding this comment

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

looks good, just left a couple minor suggestions

@hyperlint-ai-deprecated
Copy link
Contributor

PR Change Summary

Expanded documentation for programmable push filters in Redpanda Console, enhancing clarity and usability.

  • Clarified the use of custom JavaScript for filtering Kafka records in the UI.
  • Expanded explanation of push-down filters and their logical combination.
  • Added detailed instructions for adding JavaScript filters with navigation steps.
  • Included a new section on resource usage and performance of JavaScript filters.

Modified Files

  • modules/console/pages/ui/programmable-push-filters.adoc

How can I customize these reviews?

Check out the Hyperlint AI Reviewer docs for more information on how to customize the review.

If you just want to ignore it on this PR, you can add the hyperlint-ignore label to the PR. Future changes won't trigger a Hyperlint review.

Note specifically for link checks, we only check the first 30 links in a file and we cache the results for several hours (for instance, if you just added a page, you might experience this). Our recommendation is to add hyperlint-ignore to the PR to ignore the link check for this PR.

@JakeSCahill JakeSCahill merged commit 99aa484 into main Apr 3, 2025
9 checks passed
@JakeSCahill JakeSCahill deleted the DOC-1006 branch April 3, 2025 14:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants