[Bug]: A refused request's analytics event and traffic log lose the path the client called
メンテナーはふだん 1 日以内に返信
まだ誰も着手していません。
評価
- 難易度
- 2/5
- 見積もり時間
- 1〜3時間
- 初心者へのやさしさ
- 78/100
- issue の種類
- バグ
- 明瞭さ
- 明確に書かれている
- 活発さ
- 活発
- 技術スタック
- go
調査の方向性
gateway/gateway-runtime/policy-engine/internal/analytics/analytics.go の prepareAnalyticEvent から始めてください。issue では、リクエストパスと空の APIResourceTemplate が重要なポイントとして挙げられています。この値が publishers/traffic_log_event.go と publishers/moesif.go にどのように渡るかを追ってください。拒否されたリクエストにも、成功したリクエストと同様に、呼び出されたパスがトラフィックログ操作、Moesif URI、メタデータに含まれる状態になれば完了です。
索引モデルが issue の本文から書いたものです。
説明
Please select the area the issue is related to
Gateway
Please select the aspect the issue is related to
Aspect/API (API backends, definitions, contracts, interfaces, OpenAPI)
Description
When a policy refuses a request, for example a 401 from jwt-auth, the analytics event and the traffic log lose the path the client called:
- The traffic log line's
operationhas onlymethod, with nopath. - The Moesif event's URI is the API context alone, and its
apiResourceTemplatemetadata is missing.
A request that reaches the backend reports its full path in both, so refused requests can't be grouped or filtered by operation.
Observed
Setup: gateway built from current main, with the Moesif publisher and the traffic log enabled. One REST API, context /probe-path-ktel3flz-3, with jwt-auth on GET /data.
Request 1: GET /probe-path-ktel3flz-3/data with a valid token, 200.
- Traffic log:
"operation":{"method":"GET","path":"/probe-path-ktel3flz-3/data"}. - Moesif event: URI
/probe-path-ktel3flz-3/data, metadataapiResourceTemplate/probe-path-ktel3flz-3/data.
Request 2: the same path with no token, 401.
- Traffic log:
"operation":{"method":"GET"}. The client's path appears only in"target":{"statusCode":401,"destination":"127.0.0.1:33384/probe-path-ktel3flz-3/data"}. - Moesif event: URI
/probe-path-ktel3flz-3, with noapiResourceTemplatein its metadata.
Expected
The refused request's traffic log operation.path, Moesif URI and apiResourceTemplate are the path the client called, /probe-path-ktel3flz-3/data, as for the request that succeeded.
Cause
prepareAnalyticEvent in gateway/gateway-runtime/policy-engine/internal/analytics/analytics.go sets operation.APIResourceTemplate only from the access log entry's original path, the pre-rewrite :path (Envoy's x-envoy-original-path). gateway/configs/config-template.toml notes that Envoy sets it "whenever a route rewrite occurred". A request a policy refuses never reaches the upstream, so it's never rewritten and the original path is empty.
The same function already reads the request's own path into requestPath (it uses it for target.destination), but doesn't fall back to it.
With APIResourceTemplate empty:
- The traffic log publisher omits
path, becauseTrafficLogOperation.Pathisomitemptyinpublishers/traffic_log_event.go. - The Moesif publisher (
publishers/moesif.go,Publish) builds the URI asAPIContext + APIResourceTemplate, which is the context alone.
Steps to Reproduce
- Start a gateway with
[traffic_logging] enabled = trueand the Moesif analytics publisher. - Create a REST API with context
/orders, operationGET /dataand the policy{"name": "jwt-auth", "version": "v1"}, with a key manager configured. - Call
GET /orders/datawith a valid token. The traffic log line has"path":"/orders/data", and the Moesif URI is/orders/data. - Call
GET /orders/datawith noAuthorizationheader. It returns 401. The traffic log line has"operation":{"method":"GET"}, and the Moesif URI is/orders.
Severity Level of the Issue
Severity/Minor (Minor functionality is broken. Doesn't need immediate attention)
Environment Details (with versions)
Current main. The gateway is built from source and run by the IT suite (tests/framework), on macOS with Rancher Desktop.
- 主要言語
- Go
- スター
- 85
- フォーク
- 137
- 平均マージ
- 1日 12時間
- マージ済み PR(30日)
- 247
環境構築
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートあり
- コントリビューションガイドなし
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
wso2/api-platform のほかの issue
-
Area/DeveloperPortal Aspect/UI Severity/Minor Type/Bug
難易度 1/5 1時間未満 初心者へのやさしさ 88/100
wso2/api-platform#4369 ·
メンテナーはふだん 1 日以内に返信
-
[Bug]: host-rewrite policy documentation lists fewer allowed host characters than the policy acceptsオープンArea/Policies Aspect/Other Severity/Trivial Type/Bug
難易度 1/5 1時間未満 初心者へのやさしさ 91/100
wso2/api-platform#4355 ·
メンテナーはふだん 1 日以内に返信
-
Aspect/AI Aspect/API. Severity/Major
難易度 2/5 1〜3時間 初心者へのやさしさ 77/100
wso2/api-platform#4343 ·
メンテナーはふだん 1 日以内に返信
-
Area/Policies Aspect/Configuration Severity/Minor Type/Bug
難易度 2/5 1〜3時間 初心者へのやさしさ 74/100
wso2/api-platform#4330 ·
メンテナーはふだん 1 日以内に返信
-
Area/Policies Aspect/API Aspect/Configuration Severity/Minor Type/Bug
難易度 2/5 1〜3時間 初心者へのやさしさ 83/100
wso2/api-platform#4329 ·
メンテナーはふだん 1 日以内に返信
wso2/api-platform の issue をすべて見る
似ている issue
-
難易度 1/5 1時間未満 初心者へのやさしさ 88/100
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 73/100
keyxmakerx/Chronicle#2285 ·
メンテナーはふだん 1 日以内に返信
-
vLLM metrics adapter tests start the adapter twice and race on its request counters対応中かも @bhargavchintam が今日担当しました。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 82/100
llm-d/llm-d-inference-sim#933 ·
メンテナーはふだん 2 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
spellshift/realm#2509 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 65/100
lionsoul2014/ip2region#552 ·
メンテナーはふだん 1 日以内に返信