[DX-2353] docs: clarify max_record_size and omit_detailed_recording do not apply to aggregate pumps

[sharadregoti]

User description

Jira

DX-2353 - max_record_size and omit_detailed_recording are documented identically for every pump type, including aggregate pumps, but have no effect there.

Change

Adds a caveat to the pumps.mongoaggregate.omit_detailed_recording, pumps.mongoaggregate.max_record_size, pumps.sqlaggregate.omit_detailed_recording, and pumps.sqlaggregate.max_record_size entries on the Tyk Pump environment-variable reference, clarifying they have no effect on aggregate pumps because aggregated analytics records never include raw_request or raw_response data. A customer had followed the docs and set max_record_size on an aggregate pump expecting it to control aggregate record size.

Why this edits an auto-generated snippet

snippets/pump-config.mdx is normally synced from the Tyk Pump source. The durable fix is in tyk-pump#1090, which adds the same caveat to the originating Go struct doc comments in config.go. This PR applies the identical wording directly so the correction ships immediately, ahead of the next config-docs sync. Once tyk-pump#1090 merges, the next sync regenerates the same text, so there is no drift.

---

PR Type

Documentation

---

Description

• Clarify aggregate pump setting limitations

• Note omit_detailed_recording has no effect

• Note max_record_size has no effect

• Explain aggregate records lack raw payloads

---

Diagram Walkthrough

flowchart LR
  a["Aggregate pump settings"]
  b["omit_detailed_recording caveat"]
  c["max_record_size caveat"]
  d["Clarified aggregate pump behavior"]
  a -- "documents" --> b
  a -- "documents" --> c
  b -- "explains" --> d
  c -- "explains" --> d

Loading

File Walkthrough

	Relevant files
Documentation	pump-config.mdx Document no-op settings for aggregate pumps                            snippets/pump-config.mdx Added caveat under pumps.mongoaggregate.omit_detailed_recording Added caveat under pumps.mongoaggregate.max_record_size Added matching caveats for pumps.sqlaggregate settings Explained aggregate records exclude raw_request and raw_response +12/-0

---

[probelabs]

This pull request clarifies the documentation for Tyk Pump, specifying that the max_record_size and omit_detailed_recording settings do not apply to aggregate pumps (mongo-pump-aggregate, sql_aggregate). The change adds a note explaining that these settings have no effect because aggregated analytics records never include raw request or response data, addressing a point of confusion for users.

Files Changed Analysis

• snippets/pump-config.mdx: (+12, -0) The only file changed. A clarifying note has been added in four places: under the omit_detailed_recording and max_record_size sections for both mongoaggregate and sqlaggregate pumps.

Architecture & Impact Assessment

• What this PR accomplishes: It corrects the Tyk Pump configuration documentation to prevent users from incorrectly setting max_record_size and omit_detailed_recording on aggregate pumps, where these settings have no effect.
• Key technical changes introduced: This is a documentation-only change with no impact on application code or functionality.
• Affected system components: The change affects only the documentation for Tyk Pump. There is no impact on the runtime behavior of the Tyk Gateway or Tyk Pump.

flowchart LR
  a["Aggregate pump settings documentation"] -- clarifies --> b["omit_detailed_recording"]
  a -- clarifies --> c["max_record_size"]
  b --> d["No effect on aggregate pumps"]
  c --> d

Loading

Scope Discovery & Context Expansion

• The change is confined to a single documentation file, snippets/pump-config.mdx.
• The PR description notes that this is a direct edit to an auto-generated file to ship the correction quickly. The permanent fix is being made in the Tyk Pump repository (tyk-pump#1090), which is the source for this documentation. This ensures the clarification will persist after the next documentation sync.

Metadata

• Review Effort: 1 / 5
• Primary Label: documentation

---

Powered by Visor from Probelabs

Last updated: 2026-08-26T14:14:58.515Z | Triggered by: pr_updated | Commit: 76a7c1d

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

[github-actions]

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

🎫 Ticket compliance analysis ❌ 1090 - Not compliant Non-compliant requirements: Add a new Portal and Dashboard architecture section to the portal introduction page. Explain that the Developer Portal operates as a client of the Tyk Dashboard API and does not connect directly to the Gateway. Include a Mermaid diagram showing the data flow between Portal, Dashboard, Gateway, and upstream services. Add a cross-reference note in the setup guide linking to the new architecture section. Requires further human verification: Verify that the Mermaid diagram renders correctly. Verify that the cross-reference links work. Verify that the architecture explanation is accurate.

⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪

🧪 No relevant tests

🔒 No security concerns identified

⚡ No major issues detected

[probelabs]

✅ Security Check Passed

No security issues found – changes LGTM.

✅ Performance Check Passed

No performance issues found – changes LGTM.

✅ Security Check Passed

No security issues found – changes LGTM.

\n\n \n\n

✅ Performance Check Passed

No performance issues found – changes LGTM.

\n\n

✅ Quality Check Passed

No quality issues found – changes LGTM.

---

Powered by Visor from Probelabs

Last updated: 2026-08-26T14:14:56.113Z | Triggered by: pr_updated | Commit: 76a7c1d

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

[github-actions]

PR Code Suggestions ✨

No code suggestions found for the PR.