Skip to content

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

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

Open
sharadregoti wants to merge 2 commits into
base: main
Choose a base branch
from
Open

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

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b353e4b
[DX-2353] Clarify max_record_size and omit_detailed_recording do not …
sharadregoti Aug 25, 2026
76a7c1d
Merge main into DX-2353-aggregate-pump-doc-caveat
probelabs[bot] Aug 26, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions snippets/pump-config.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2809,6 +2809,9 @@ Type: `bool`<br />
Reduce the size of the traffic logs generated for each request by setting this to true. Tyk Pump will
then not include the `raw_request` and `raw_response` in the logs. Defaults to `false`.

This setting has no effect on aggregate pumps (`mongo-pump-aggregate`, `sql_aggregate`), because
aggregated analytics records never include `raw_request` or `raw_response` data.

### pumps.mongoaggregate.max_record_size
ENV: <b>TYK_PMP_PUMPS_MONGOAGGREGATE_MAXRECORDSIZE</b><br />
Type: `int`<br />
Expand All @@ -2826,6 +2829,9 @@ information. This can also be set at a pump level. For example:
}
```

This setting has no effect on aggregate pumps (`mongo-pump-aggregate`, `sql_aggregate`), because
aggregated analytics records never include `raw_request` or `raw_response` data.

### pumps.mongoaggregate.ignore_fields
ENV: <b>TYK_PMP_PUMPS_MONGOAGGREGATE_IGNOREFIELDS</b><br />
Type: `[]string`<br />
Expand Down Expand Up @@ -4011,6 +4017,9 @@ Type: `bool`<br />
Reduce the size of the traffic logs generated for each request by setting this to true. Tyk Pump will
then not include the `raw_request` and `raw_response` in the logs. Defaults to `false`.

This setting has no effect on aggregate pumps (`mongo-pump-aggregate`, `sql_aggregate`), because
aggregated analytics records never include `raw_request` or `raw_response` data.

### pumps.sqlaggregate.max_record_size
ENV: <b>TYK_PMP_PUMPS_SQLAGGREGATE_MAXRECORDSIZE</b><br />
Type: `int`<br />
Expand All @@ -4028,6 +4037,9 @@ information. This can also be set at a pump level. For example:
}
```

This setting has no effect on aggregate pumps (`mongo-pump-aggregate`, `sql_aggregate`), because
aggregated analytics records never include `raw_request` or `raw_response` data.

### pumps.sqlaggregate.ignore_fields
ENV: <b>TYK_PMP_PUMPS_SQLAGGREGATE_IGNOREFIELDS</b><br />
Type: `[]string`<br />
Expand Down
Loading