🔄 Preview: [DX-2353] docs: clarify max_record_size and omit_detailed_recording do not apply to aggregate pumps - #2801
Draft
probelabs[bot] wants to merge 479 commits into
Draft
🔄 Preview: [DX-2353] docs: clarify max_record_size and omit_detailed_recording do not apply to aggregate pumps#2801probelabs[bot] wants to merge 479 commits into
probelabs[bot] wants to merge 479 commits into
Conversation
* Update pump.mdx * Update pump.mdx * Update pump.mdx * Update pump.mdx * Update pump.mdx * Apply suggestions from code review * Removed unnecessary reference * Update Tyk Pump version to 1.13.3 in release notes --------- Co-authored-by: Leonid Bugaev <leonsbox@gmail.com> Co-authored-by: andyo-tyk <99968932+andyo-tyk@users.noreply.github.com> Co-authored-by: Master <sharadregoti15@gmail.com>
* Update mdcb.mdx * Update mdcb.mdx * Update mdcb.mdx * Update mdcb.mdx * Update latest version to 2.8.8 in release notes --------- Co-authored-by: Leonid Bugaev <leonsbox@gmail.com> Co-authored-by: Master <sharadregoti15@gmail.com>
* Update gateway.mdx * Update dashboard.mdx * Update overview.mdx * Update gateway.mdx * Update gateway.mdx * Update developer-support/release-notes/gateway.mdx Co-authored-by: andyo-tyk <99968932+andyo-tyk@users.noreply.github.com> * Update developer-support/release-notes/gateway.mdx Co-authored-by: andyo-tyk <99968932+andyo-tyk@users.noreply.github.com> * Update gateway.mdx * Update dashboard.mdx * Update dashboard.mdx * Update dashboard.mdx * Update gateway.mdx * Improved readability * Update developer-support/release-notes/gateway.mdx * Update developer-support/release-notes/dashboard.mdx * Update dashboard.mdx * Update gateway.mdx --------- Co-authored-by: andyo-tyk <99968932+andyo-tyk@users.noreply.github.com> Co-authored-by: Master <sharadregoti15@gmail.com> Co-authored-by: Leonid Bugaev <leonsbox@gmail.com>
…or on Kubernetes (#1362)
…Field component (#1499)
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
* Update gateway.mdx * Update dashboard.mdx * Update overview.mdx * Update dashboard.mdx * Update gateway.mdx * Update gateway.mdx * Update dashboard.mdx * Update developer-support/release-notes/dashboard.mdx Co-authored-by: andyo-tyk <99968932+andyo-tyk@users.noreply.github.com> * Update developer-support/release-notes/dashboard.mdx Co-authored-by: andyo-tyk <99968932+andyo-tyk@users.noreply.github.com> * Update developer-support/release-notes/dashboard.mdx Co-authored-by: andyo-tyk <99968932+andyo-tyk@users.noreply.github.com> * Update developer-support/release-notes/dashboard.mdx Co-authored-by: andyo-tyk <99968932+andyo-tyk@users.noreply.github.com> * Update developer-support/release-notes/dashboard.mdx Co-authored-by: andyo-tyk <99968932+andyo-tyk@users.noreply.github.com> * Update developer-support/release-notes/gateway.mdx Co-authored-by: andyo-tyk <99968932+andyo-tyk@users.noreply.github.com> * Update developer-support/release-notes/gateway.mdx Co-authored-by: andyo-tyk <99968932+andyo-tyk@users.noreply.github.com> * Update developer-support/release-notes/gateway.mdx Co-authored-by: andyo-tyk <99968932+andyo-tyk@users.noreply.github.com> * Update developer-support/release-notes/gateway.mdx Co-authored-by: andyo-tyk <99968932+andyo-tyk@users.noreply.github.com> * Update developer-support/release-notes/gateway.mdx Co-authored-by: andyo-tyk <99968932+andyo-tyk@users.noreply.github.com> * Update developer-support/release-notes/gateway.mdx Co-authored-by: andyo-tyk <99968932+andyo-tyk@users.noreply.github.com> * Apply suggestion from @andyo-tyk Co-authored-by: andyo-tyk <99968932+andyo-tyk@users.noreply.github.com> * Apply suggestion from @andyo-tyk Co-authored-by: andyo-tyk <99968932+andyo-tyk@users.noreply.github.com> * Update gateway.mdx * Update gateway.mdx * Update developer-support/release-notes/gateway.mdx * Update gateway.mdx * F * Update gateway.mdx * Update dashboard.mdx * Update gateway.mdx --------- Co-authored-by: andyo-tyk <99968932+andyo-tyk@users.noreply.github.com> Co-authored-by: Sharad Regoti <sharadregoti15@gmail.com> Co-authored-by: probelabs[bot] <219682034+probelabs[bot]@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
13 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
🔗 Auto-generated mirror PR for Mintlify preview
Original PR: #2800
Author: @sharadregoti
Purpose
This PR provides a Mintlify preview link for reviewing documentation changes.
Preview Link
The Mintlify preview will be available once this PR is processed.
Changes
Jira
DX-2353 -
max_record_sizeandomit_detailed_recordingare 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, andpumps.sqlaggregate.max_record_sizeentries on the Tyk Pump environment-variable reference, clarifying they have no effect on aggregate pumps because aggregated analytics records never includeraw_requestorraw_responsedata. A customer had followed the docs and setmax_record_sizeon an aggregate pump expecting it to control aggregate record size.Why this edits an auto-generated snippet
snippets/pump-config.mdxis 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 inconfig.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.