🎯 Recommended Merge Targets

Based on JIRA ticket TT-7519: [Innersource] Include original request path in analytics

Fix Version: Tyk 5.14.0

⚠️ Warning: Expected release branches not found in repository

Required:

• master - No matching release branches found. Fix will be included in future releases.

📋 Workflow

1. Merge this PR to master first

This PR addresses a bug in OpenTelemetry tracing where the tyk.original_path attribute was being incorrectly attached to middleware child spans instead of the main inbound HTTP request span. The fix introduces a new, dedicated middleware, withOriginalPathSpanAttribute, which wraps the primary request handler chain. This ensures the attribute is set on the correct parent span immediately after the request is received and the main span is created. The old logic in the generic trace middleware has been removed to prevent incorrect, redundant attribute setting.

Additionally, the PR includes a minor fix for a YAML indentation issue in a CI test scenario and adds robust regression tests. These new tests utilize a mock OpenTelemetry collector to validate that the tyk.original_path attribute is correctly present on the main span and, crucially, appears only once, even when detailed middleware tracing is enabled.

Files Changed Analysis

• gateway/api.go: Introduces the new withOriginalPathSpanAttribute middleware. This function wraps the main http.Handler to get the active span from the context and set the tyk.original_path attribute.
• gateway/api_loader.go: Integrates the new middleware. It modifies the API processing logic to wrap the handler chain with withOriginalPathSpanAttribute when OpenTelemetry tracing is enabled, applying the fix globally.
• gateway/middleware.go: Removes the incorrect logic that previously added the tyk.original_path attribute within the generic TraceMiddleware, which executed for every middleware and created child spans.
• gateway/original_request_path_test.go: Adds significant test coverage. TestOriginalRequestPath_MainHTTPSpanAttribute verifies the attribute is correctly added, and TestOriginalRequestPath_OnlyOnMainSpan_DetailedTracing ensures it is added only to the main span and not to any child spans.
• ci/tests/tracing/scenarios/tyk_test_200.yml: Contains a minor fix for a User-Agent header indentation error in the test definition.

Architecture & Impact Assessment

• What this PR accomplishes: It corrects the placement of the tyk.original_path span attribute in OpenTelemetry traces, ensuring it is attached to the main parent HTTP span for accurate request tracing.
• Key technical changes introduced: The primary change is the shift from setting the attribute in a broad middleware to a dedicated middleware (withOriginalPathSpanAttribute) applied at the top of the request handler chain. This centralizes the logic and guarantees it executes in the correct context.
• Affected system components: The change is narrowly focused on the Gateway's OpenTelemetry tracing subsystem. It modifies how trace data is enriched but does not alter core API gateway functionality, making it a low-risk change.

sequenceDiagram
    participant Client
    participant Gateway as "Gateway (api_loader.go)"
    participant OTEL as "otel.HTTPHandler"
    participant NewMiddleware as "withOriginalPathSpanAttribute"
    participant DownstreamChain as "Downstream Middleware/Handler"

    Client->>Gateway: HTTP Request
    activate Gateway
    Gateway->>OTEL: Process Request
    activate OTEL
    Note over OTEL: Starts main inbound span
    OTEL->>NewMiddleware: Invoke wrapped handler
    activate NewMiddleware
    NewMiddleware-->>OTEL: otel.SpanFromContext(r.Context())
    NewMiddleware->>OTEL: span.SetAttributes(tyk.original_path)
    Note right of NewMiddleware: Attribute is set on the main span
    NewMiddleware->>DownstreamChain: next.ServeHTTP(w, r)
    deactivate NewMiddleware
    deactivate OTEL
    deactivate Gateway

Scope Discovery & Context Expansion

• The modification in gateway/api_loader.go is the central integration point. Since processSpec handles the construction of the request processing chain for each API definition, this change ensures the fix is applied globally to all APIs with OpenTelemetry tracing enabled.
• The removal of attribute-setting logic from gateway/middleware.go is a critical cleanup step, preventing the attribute from being redundantly and incorrectly added to child spans created during detailed tracing.
• The new tests in gateway/original_request_path_test.go are robust, establishing a mock OpenTelemetry collector to inspect the actual exported trace payload. This provides strong end-to-end validation of the fix and protects against future regressions.
• The value for the attribute is sourced from ctxGetOriginalRequestPath, which retrieves the path from the request context. This context value is set earlier in the request lifecycle by the OriginalRequestPath middleware, ensuring the data is available when the new tracing middleware executes.

Powered by Visor from Probelabs

Last updated: 2026-06-15T14:21:21.877Z | Triggered by: pr_updated | Commit: 4a6b47e

💡 TIP: You can chat with Visor using /visor ask <your question>

✅ Architecture Check Passed

No architecture issues found – changes LGTM.

✅ Performance Check Passed

No performance issues found – changes LGTM.

✅ Architecture Check Passed

No architecture issues found – changes LGTM.

✅ Performance Check Passed

No performance issues found – changes LGTM.

✅ Quality Check Passed

No quality issues found – changes LGTM.

Powered by Visor from Probelabs

Last updated: 2026-06-15T14:21:20.356Z | Triggered by: pr_updated | Commit: 4a6b47e

💡 TIP: You can chat with Visor using /visor ask <your question>

SentinelOne CNS Hardcoded Secret Detector
✅ Congratulations, your code is safe

SentinelOne CNS is a cloud-agnostic, agentless CSPM & CWPP solution that continuously detects and prevents vulnerabilities that have the highest probability of being exploited in Azure, AWS, Google Cloud, and Kubernetes.

🚨 Jira Linter Failed

Commit: 4a6b47e
Failed at: 2026-06-15 14:20:08 UTC

The Jira linter failed to validate your PR. Please check the error details below:

failed to validate branch and PR title rules: PR title contains 'TT-17495' but branch has 'TT-7519' - they must match

Next Steps

• Ensure your branch name contains a valid Jira ticket ID (e.g., ABC-123)
• Verify your PR title matches the branch's Jira ticket ID
• Check that the Jira ticket exists and is accessible

This comment will be automatically deleted once the linter passes.

Quality Gate passed

Issues
0 New issues
1 Accepted issue

Measures
0 Security Hotspots
100.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

hi @tbuchaillot can you please fix the CI pipeline before merging this PR. ?

hi @tbuchaillot can you please fix the CI pipeline before merging this PR. ?
The sentinelOne/Jira and arm64 upgrade doesn't seems related to these changes :)