[Bug]: content-length-guardrail policy does not mark streamed violations in analytics

オープン
#4,323 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

まだ誰も着手していません。

評価

難易度
3/5
見積もり時間
1〜2日
初心者へのやさしさ
56/100
issue の種類
バグ
明瞭さ
おおむね明確
活発さ
活発
技術スタック
go
領域
observability

調査の方向性

Start by locating the content-length-guardrail policy implementation and comparing the streamed response violation path with the request and buffered response paths that set analytics metadata. Trace where the stream violation sets its error and fault, then check the analytics event for isGuardrailHit and guardrailName. Done means streamed violations include both fields, matching the other violation paths.

索引モデルが issue の本文から書いたものです。

説明

Area/Policies Aspect/Monitoring Severity/Minor Type/Bug
Please select the area the issue is related to

Gateway

Please select the aspect the issue is related to

Aspect/Monitoring (Metrics, observability, health checks, alerts)

Description

The content-length-guardrail policy does not mark a streamed response violation in analytics. The analytics event has no isGuardrailHit or guardrailName metadata.

Request violations and buffered response violations set both fields. When the policy ends a stream for a violation, it sets the error and the fault but leaves the analytics metadata empty.

The enforcement itself works. The client gets the guardrail's error event and the stream ends. Only the analytics record is incomplete. Dashboards and reports that count guardrail hits from this metadata miss every streamed violation.

Steps to Reproduce
  1. Create a REST API with the content-length-guardrail policy on an operation, with analytics enabled on the Gateway:
    {"name":"content-length-guardrail","version":"v1","params":{"response":{"enabled":true,"min":1,"max":5}}}
    
  2. Send a request whose upstream replies with an SSE stream. The first delta has more than 5 bytes of content:
    data: {"choices":[{"delta":{"content":"this is longer than five bytes"}}]}
    
    data: [DONE]
    
  3. The client gets the guardrail's SSE error event, and the stream ends. This is expected.
  4. Read the request's analytics event. It has neither isGuardrailHit nor guardrailName in its metadata.
  5. Repeat with a request over a request-side max, or a buffered response over max. The event has isGuardrailHit: true and guardrailName: content-length-guardrail.
Severity Level of the Issue

Severity/Minor (Non-critical functionality. Can be fixed in future releases)

Environment Details (with versions)
  • Policy: content-length-guardrail v1.1.0, wso2/gateway-controllers main (4f1520a8)
  • Gateway versions: 1.1.0 (patched), 1.2.0 and latest (main-59dcd51)
  • macOS 27.0.1 (Apple silicon), Colima 0.10.3, Docker Engine 29.5.2
主要言語
Go
スター
85
フォーク
137
平均マージ
1日 12時間
マージ済み PR(30日)
247

環境構築

  • Dockerfile・Docker Compose ファイルなし
  • プルリクエストのテンプレートあり
  • コントリビューションガイドなし

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

wso2/api-platform のほかの issue

wso2/api-platform の issue をすべて見る

似ている issue

Go の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。