[Bug]: A refused request's analytics event and traffic log lose the path the client called
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 78/100
- Issue type
- Bug
- Clarity
- Clearly specified
- Activity status
- Active
- Tech stack
- go
- Domain
- backend-api-design
Research direction
Start with prepareAnalyticEvent in gateway/gateway-runtime/policy-engine/internal/analytics/analytics.go; the issue identifies the request path and the empty APIResourceTemplate as the key points. Trace how that value reaches publishers/traffic_log_event.go and publishers/moesif.go. Done when refused requests include the called path in the traffic log operation and Moesif URI and metadata, matching successful requests.
Written by the indexing model from the issue text.
Description
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.
- Dominant language
- Go
- Stars
- 85
- Forks
- 137
- Avg merge
- 1d 12h
- Merged PRs (30d)
- 247
Getting set up
- No Dockerfile or Docker Compose file
- Has a pull request template
- No contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from wso2/api-platform
-
Area/DeveloperPortal Aspect/UI Severity/Minor Type/Bug
Difficulty 1/5 Under an hour Newbie friendliness 88/100
wso2/api-platform#4369 ·
Maintainers usually reply within 1 day
-
[Bug]: host-rewrite policy documentation lists fewer allowed host characters than the policy acceptsOpenArea/Policies Aspect/Other Severity/Trivial Type/Bug
Difficulty 1/5 Under an hour Newbie friendliness 91/100
wso2/api-platform#4355 ·
Maintainers usually reply within 1 day
-
Aspect/AI Aspect/API. Severity/Major
Difficulty 2/5 1-3 hours Newbie friendliness 77/100
wso2/api-platform#4343 ·
Maintainers usually reply within 1 day
-
Area/Policies Aspect/Configuration Severity/Minor Type/Bug
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
wso2/api-platform#4330 ·
Maintainers usually reply within 1 day
-
Area/Policies Aspect/API Aspect/Configuration Severity/Minor Type/Bug
Difficulty 2/5 1-3 hours Newbie friendliness 83/100
wso2/api-platform#4329 ·
Maintainers usually reply within 1 day
All issues in wso2/api-platform
Similar issues
-
Difficulty 1/5 Under an hour Newbie friendliness 88/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 73/100
keyxmakerx/Chronicle#2285 ·
Maintainers usually reply within 1 day
-
vLLM metrics adapter tests start the adapter twice and race on its request countersPossibly taken @bhargavchintam claimed this today. Open
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
llm-d/llm-d-inference-sim#933 ·
Maintainers usually reply within 2 days
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
spellshift/realm#2509 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
lionsoul2014/ip2region#552 ·
Maintainers usually reply within 1 day