Skip to content

[TT-11125] Add trace_id to traffic logs #899

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
lghiur wants to merge 1 commit into from

[TT-11125] Add trace_id to traffic logs

8941d7f
Select commit
Loading
Failed to load commit list.
Closed

[TT-11125] Add trace_id to traffic logs #899

[TT-11125] Add trace_id to traffic logs
8941d7f
Select commit
Loading
Failed to load commit list.
probelabs / Visor: quality succeeded Oct 2, 2025 in 4m 47s

✅ Check Passed (Warnings Found)

quality check passed. Found 1 warning, but fail_if condition was not met.

Details

📊 Summary

  • Total Issues: 3
  • Warning Issues: 1

🐛 Issues by Category

⚡ Performance (3)

  • ⚠️ analytics/analytics.go:78 - The new TraceID field is mapped to a traceid database column. Trace IDs are commonly used for lookups, and querying this column without an index will lead to slow, full-table-scan queries, severely degrading performance on large datasets.
  • ℹ️ analytics/analytics.go:78 - The addition of the TraceID string field increases the memory footprint of each AnalyticsRecord. In a high-throughput environment like Tyk Pump, this small increase per record can lead to a significant rise in overall memory consumption.
  • ℹ️ analytics/analytics_test.go:173 - The new test for RemoveIgnoredFields covers a function that uses an inefficient, reflection-based nested loop to remove fields from records. This function runs on a hot path for every record when field exclusion is configured, which can create significant CPU overhead.

Generated by Visor - AI-powered code review

Annotations

Check warning on line 78 in analytics/analytics.go

See this annotation in the file changed.

@probelabs probelabs / Visor: quality

performance Issue 

The new `TraceID` field is mapped to a `traceid` database column. Trace IDs are commonly used for lookups, and querying this column without an index will lead to slow, full-table-scan queries, severely degrading performance on large datasets.
Raw output 
Ensure that a database index is created for the `traceid` column in all supported SQL databases. This should be documented as a requirement for this feature, and migration scripts should be provided if applicable.

Check notice on line 78 in analytics/analytics.go

See this annotation in the file changed.

@probelabs probelabs / Visor: quality

performance Issue 

The addition of the `TraceID` string field increases the memory footprint of each `AnalyticsRecord`. In a high-throughput environment like Tyk Pump, this small increase per record can lead to a significant rise in overall memory consumption.
Raw output 
This is an acceptable trade-off for the added functionality. However, the impact on memory should be documented and considered for capacity planning in production environments.

Check notice on line 185 in analytics/analytics_test.go

See this annotation in the file changed.

@probelabs probelabs / Visor: quality

performance Issue 

The new test for `RemoveIgnoredFields` covers a function that uses an inefficient, reflection-based nested loop to remove fields from records. This function runs on a hot path for every record when field exclusion is configured, which can create significant CPU overhead.
Raw output 
While this is a pre-existing issue, it's worth noting. To optimize, consider caching a map of JSON tags to struct fields upon pump initialization. This would change the lookup from a slow O(N) iteration to a fast O(1) map lookup per field, significantly improving performance for users of this feature.
View more details on probelabs