ref(filtering): Revamp SDK filtering docs #5804
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
lobsterkatie
force-pushed
the
kmclb-clean-up-filtering-nov-2022
branch
from
97b9081 to
6bf9f15
Compare
lobsterkatie
force-pushed
the
kmclb-clean-up-filtering-nov-2022
branch
from
6bf9f15 to
f523599
Compare
This adds the new `beforeSendTransaction` option to the docs, both on the options page and alongside `beforeSend` in many places in the text. Because you can't selectively turn certain phrases on and off for different platforms, I tried to indicate where I could that it's not universally supported. (Right now, I believe JS is in fact the only platform to support it, though I expect that to change in the near future.) It also does a tiny bit of wordsmithing of the text around the additions, courtesy of @lizokm and @imatwawana. Note that the one spot where updates haven't been done in this PR is the text of the Filtering page, as it's being worked on separately in #5804. Once the changes there are done, #5838 will add `beforeSendTransaction`.
|
This pull request has gone three weeks without activity. In another week, I will close it. But! If you comment or otherwise update it, I will reset the clock, and if you label it "A weed is but an unloved flower." ― Ella Wheeler Wilcox 🥀 |
imatwawana
left a comment
imatwawana
left a comment
There was a problem hiding this comment.
For Python, in the preview, there are two Hints pages under Filtering, so some cleanup is required there. I'm also not sure I understand the structure of the Filtering page now in terms of event processors/hints. I've left a question there. Otherwise, the wording looks good to me!
| - perl | ||
| --- | ||
|
|
||
| # Hints |
There was a problem hiding this comment.
Don't need this H1 as this is already taken care of by the page title
| # Hints |
| You can configure your SDK to filter events in a number of ways: | ||
|
|
||
| - by using the <PlatformIdentifier name="before-send" /> callback method | ||
| - by using event processors, |
There was a problem hiding this comment.
| - by using event processors, | |
| - by using event processors |
|
|
||
| - by using the <PlatformIdentifier name="before-send" /> callback method | ||
| - by using event processors, | ||
| - by configuring, enabling, or disabling integrations. |
There was a problem hiding this comment.
| - by configuring, enabling, or disabling integrations. | |
| - by configuring, enabling, or disabling integrations |
| </PlatformSection> | ||
|
|
||
| <PlatformSection notSupported={["native", "apple", "dotnet"]}> | ||
| ### Hints |
There was a problem hiding this comment.
This section doesn't seem to be about event processors. Is this supposed to undergo more changes?
|
This issue has gone three weeks without activity. In another week, I will close it. But! If you comment or otherwise update it, I will reset the clock, and if you remove the label "A weed is but an unloved flower." ― Ella Wheeler Wilcox 🥀 |
Note: Converting to draft now that it's clear this is going to be more work than I thought. See #5811 for somewhat of a todo list.
This is some general wordsmithing and reorganization of the SDK filtering page, specifically the
beforeSendand hints sections, extracted from a future PR addingbeforeSendTransactionto the docs.Key Changes:
Hintssection to avoid repetition.before-send-hintsnippet to not be identical to thebefore-send-fingerprintsnippet and instead match the other languages'before-send-hintsnippets. (UPDATE: Some other languages need this done, too.)Decluttering Sentryheading to something more descriptive.TODO: