Skip to content

feat: Add MaxCacheItems to basic options#3308

Merged
philipphofmann merged 3 commits intomasterfrom
feat/max-cache-items
Mar 25, 2021
Merged

feat: Add MaxCacheItems to basic options#3308
philipphofmann merged 3 commits intomasterfrom
feat/max-cache-items

Conversation

@philipphofmann
Copy link
Copy Markdown
Member

@philipphofmann philipphofmann commented Mar 24, 2021

We are going to enable Apple once 7.0.0 GA is released. I added this to #3307 to not forget about it.

Fixes GH-2879

@vercel
Copy link
Copy Markdown

vercel bot commented Mar 24, 2021

This pull request is being automatically deployed with Vercel (learn more).
To see the status of your deployment, click below or on the icon next to each commit.

🔍 Inspect: https://vercel.com/sentry/sentry-docs/8XJ9UdwZkxXSyVHcgV4e4btgo8Zr
✅ Preview: https://sentry-docs-git-feat-max-cache-items.sentry.dev

@philipphofmann philipphofmann requested a review from a team March 24, 2021 09:23

<ConfigKey name="max-cache-items" supported={[ "dotnet", "android"]} >

The maximum number of [envelopes](https://develop.sentry.dev/sdk/envelopes/) to keep in cache. The SDKs use envelopes to send data, as events, attachments, user feedback, session, etc. to Sentry. An envelope can contain multiple items - for example, an event with a session and two attachments. Depending on the usage of the SDK, the size of an envelope can differ. When the number of envelopes in the local cache exceeds max-cache-items, the SDK deletes the oldest envelope. When deleting an envelope, we migrate sessions to the next envelope to not mess up your release health stats. The default is `30`.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The maximum number of [envelopes](https://develop.sentry.dev/sdk/envelopes/) to keep in cache. The SDKs use envelopes to send data, as events, attachments, user feedback, session, etc. to Sentry. An envelope can contain multiple items - for example, an event with a session and two attachments. Depending on the usage of the SDK, the size of an envelope can differ. When the number of envelopes in the local cache exceeds max-cache-items, the SDK deletes the oldest envelope. When deleting an envelope, we migrate sessions to the next envelope to not mess up your release health stats. The default is `30`.
The maximum number of [envelopes](https://develop.sentry.dev/sdk/envelopes/) to keep in cache. The SDKs use envelopes to send data, as events, attachments, user feedback, session, etc. to Sentry. An envelope can contain multiple items - for example, an event with a session and two attachments. Depending on the usage of the SDK, the size of an envelope can differ. When the number of envelopes in the local cache exceeds max-cache-items, the SDK deletes the oldest envelope. The default is `30`.

I think this is implementation details, if we want to explain it, it'd be better to release health docs

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I added it because people might think that this messes up their session stats. Just wanted to clarify that this is not affected. @bruno-garcia, what do you think? Should we keep it or remove it?

Co-authored-by: Manoel Aranda Neto <5731772+marandaneto@users.noreply.github.com>
Co-authored-by: Fiona <61481573+PeloWriter@users.noreply.github.com>
@philipphofmann philipphofmann enabled auto-merge (squash) March 25, 2021 10:36
@philipphofmann philipphofmann merged commit b91eb66 into master Mar 25, 2021
@philipphofmann philipphofmann deleted the feat/max-cache-items branch March 25, 2021 10:40
@github-actions github-actions bot locked and limited conversation to collaborators Apr 10, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document MaxCacheItems for Apple, Java and .NET

3 participants