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

Đang mở Phù hợp với người mới
#4,348 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
2/5
Thời gian dự kiến
1-3 giờ
Mức phù hợp với người mới
78/100
Loại issue
Lỗi
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
go
Lĩnh vực
backend-api-design

Hướng nghiên cứu

Bắt đầu với prepareAnalyticEvent trong gateway/gateway-runtime/policy-engine/internal/analytics/analytics.go; issue xác định đường dẫn request và APIResourceTemplate trống là các điểm chính. Theo dõi cách giá trị đó đi tới publishers/traffic_log_event.go và publishers/moesif.go. Công việc hoàn tất khi các request bị từ chối có đường dẫn được gọi trong thao tác ghi log lưu lượng, URI và metadata của Moesif, giống như các request thành công.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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.

Ngôn ngữ chính
Go
Star
85
Fork
137
Merge trung bình
1 ngày 12 giờ
Pull request đã merge (30 ngày)
247

Chuẩn bị môi trường

  • Không có Dockerfile hay tệp Docker Compose
  • Có mẫu pull request
  • Không có hướng dẫn đóng góp

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của wso2/api-platform

Tất cả issue của wso2/api-platform

Issue tương tự

Thêm issue về Go

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.