[Bug]: A refused request's analytics event and traffic log lose the path the client called

Open Beginner friendly
#4,348 0 comments 0 reactions 0 assignees View on GitHub

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

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

Area/Gateway Aspect/API Severity/Minor Type/Bug
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 operation has only method, with no path.
  • The Moesif event's URI is the API context alone, and its apiResourceTemplate metadata 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, metadata apiResourceTemplate /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 no apiResourceTemplate in 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, because TrafficLogOperation.Path is omitempty in publishers/traffic_log_event.go.
  • The Moesif publisher (publishers/moesif.go, Publish) builds the URI as APIContext + APIResourceTemplate, which is the context alone.
Steps to Reproduce
  1. Start a gateway with [traffic_logging] enabled = true and the Moesif analytics publisher.
  2. Create a REST API with context /orders, operation GET /data and the policy {"name": "jwt-auth", "version": "v1"}, with a key manager configured.
  3. Call GET /orders/data with a valid token. The traffic log line has "path":"/orders/data", and the Moesif URI is /orders/data.
  4. Call GET /orders/data with no Authorization header. 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

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from wso2/api-platform

All issues in wso2/api-platform

Similar issues

More Go issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.