[PR #1250] [MERGED] docs(plugin): add streaming observability sample filter and Filter guide example #1238

New issue

Closed

opened 2026-10-18 14:18:13 +00:00 by bsakaguchi · 0 comments

bsakaguchi commented

2026-10-18 14:18:13 +00:00

Owner

📋 Pull Request Information

Original PR: https://github.com/open-webui/docs/pull/1250
Author: @vigneshwarrvenkat
Created: 5/10/2026
Status: ✅ Merged
Merged: 5/14/2026
Merged by: @Classic298

Base: dev ← Head: feat/sample-filter-stream-observability

📝 Commits (3)

2e79ba2 docs(plugin): add streaming observability filter sample and Filter doc example
676b7bb docs(plugin): observability streaming filter as prose-only example
98c70c1 Update filter.mdx

📊 Changes

1 file changed (+64 additions, -18 deletions)

View changed files

📝 docs/features/extensibility/plugin/functions/filter.mdx (+64 -18)

📄 Description

Summary

Adds a downloadable sample Filter and Example #3 on the Filter Function guide, showing how to use the stream hook with status events (and optional chat: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

Atomic change: only the Filter doc page + one static sample file.
Conventions: matches existing Filter guide structure (Examples section, admonitions, Docusaurus/MDX style).
No new dependencies.
Code of Conduct: Open WebUI Code of Conduct applies.

(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.py
docs/features/extensibility/plugin/functions/filter.mdx
Community url : https://openwebui.com/posts/461c301e-30c4-46d1-a8aa-eb5ece7be85f

Checklist

Self-review for tone, accuracy, and security callouts (Filters run arbitrary Python; sample is admin-only to install).
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

_{🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.}

## 📋 Pull Request Information **Original PR:** https://github.com/open-webui/docs/pull/1250 **Author:** [@vigneshwarrvenkat](https://github.com/vigneshwarrvenkat) **Created:** 5/10/2026 **Status:** ✅ Merged **Merged:** 5/14/2026 **Merged by:** [@Classic298](https://github.com/Classic298) **Base:** `dev` ← **Head:** `feat/sample-filter-stream-observability` --- ### 📝 Commits (3) - [`2e79ba2`](https://github.com/open-webui/docs/commit/2e79ba2d3eed2a61bd7a28fbebd8cb3c0432edf6) docs(plugin): add streaming observability filter sample and Filter doc example - [`676b7bb`](https://github.com/open-webui/docs/commit/676b7bb5ce6c44fb1ac71bbd3a6caa061e402af9) docs(plugin): observability streaming filter as prose-only example - [`98c70c1`](https://github.com/open-webui/docs/commit/98c70c1b882cec177f54b04b081cdcc40caab95e) Update filter.mdx ### 📊 Changes **1 file changed** (+64 additions, -18 deletions) <details> <summary>View changed files</summary> 📝 `docs/features/extensibility/plugin/functions/filter.mdx` (+64 -18) </details> ### 📄 Description ## Summary Adds a downloadable **sample Filter** and **Example #3** on the Filter Function guide, showing how to use the `stream` hook with `status` events (and optional `chat:completion` / `usage`) for lightweight streaming observability without custom frontend code. Follows maintainer guidance to land this as **documentation + sample** in the [docs repository](https://github.com/open-webui/docs) rather than in the core app repo. ## How this aligns with [Contributing](https://docs.openwebui.com/contributing) - **Atomic change:** only the Filter doc page + one static sample file. - **Conventions:** matches existing Filter guide structure (Examples section, admonitions, Docusaurus/MDX style). - **No new dependencies.** - **Code of Conduct:** [Open WebUI Code of Conduct](https://github.com/open-webui/open-webui/blob/main/CODE_OF_CONDUCT.md) applies. (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.py` - `docs/features/extensibility/plugin/functions/filter.mdx` - Community url : https://openwebui.com/posts/461c301e-30c4-46d1-a8aa-eb5ece7be85f ## Checklist - [x] Self-review for tone, accuracy, and security callouts (Filters run arbitrary Python; sample is admin-only to install). - [x] `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](https://github.com/open-webui/open-webui/discussions/5455) --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>

bsakaguchi

2026-10-18 14:18:13 +00:00