docs(plugin): add streaming observability sample filter and Filter guide example#1250
Merged
Classic298 merged 3 commits intoMay 14, 2026
Conversation
…c example - Add static sample observability_metrics_filter.py (status + chat:completion usage) - Extend Filter Function guide with Example open-webui#3: install steps and download link
Remove bundled .py sample per review; expand Filter guide Example open-webui#3.
Collaborator
|
thanks refactored it a bit |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds a downloadable sample Filter and Example #3 on the Filter Function guide, showing how to use the
streamhook withstatusevents (and optionalchat:completion/usage) for lightweight streaming observability without custom frontend code.Follows maintainer guidance to land this as documentation + sample in the docs repository rather than in the core app repo.
How this aligns with Contributing
(If you opened or continued a GitHub Discussion when this was first proposed, link it here—that matches the “discussion first” expectation for larger ideas; a small docs addition after explicit maintainer redirect is usually fine either way.)
Changes
static/samples/functions/observability_metrics_filter.pydocs/features/extensibility/plugin/functions/filter.mdxCommunity url : https://openwebui.com/posts/461c301e-30c4-46d1-a8aa-eb5ece7be85f
Checklist
npm ci+npx docusaurus build(or your usual local build) passes.Context
Link to maintainer comment / closed PR on
open-webui(optional but helpful).Follow-up to Discussion #5455 — Observability / streaming metrics