Skip to content
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.

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

feat(doc): Update health-check inbound filter API documentation #52008

Merged
merged 2 commits into from
Jul 6, 2023

Conversation

RaduW
Copy link
Contributor

@RaduW RaduW commented Jun 30, 2023

Update API documentation for inbound filters to contain the health-check filter
fixes: #49089

@RaduW RaduW requested a review from a team as a code owner June 30, 2023 15:45
@github-actions github-actions bot added the Scope: Backend Automatically applied to PRs that change backend components label Jun 30, 2023
@RaduW RaduW requested a review from a team June 30, 2023 15:45
@codecov
Copy link

codecov bot commented Jun 30, 2023

Codecov Report

Merging #52008 (9bbf0e0) into master (893d45b) will increase coverage by 0.00%.
The diff coverage is n/a.

Additional details and impacted files
@@           Coverage Diff            @@
##           master   #52008    +/-   ##
========================================
  Coverage   79.31%   79.32%            
========================================
  Files        4899     4901     +2     
  Lines      204912   205114   +202     
  Branches    35024    35064    +40     
========================================
+ Hits       162519   162699   +180     
- Misses      37438    37455    +17     
- Partials     4955     4960     +5     
Impacted Files Coverage Δ
src/sentry/apidocs/parameters.py 100.00% <ø> (ø)

... and 52 files with indirect coverage changes

@schew2381 schew2381 self-requested a review June 30, 2023 19:11
@@ -237,6 +237,7 @@ class ProjectParams:
- `legacy-browser`: Filter out known errors from legacy browsers. Older browsers often give less
accurate information, and while they may report valid issues, the context to understand them is
incorrect or missing.
- `filtered-transaction`: Filter out transactions for healthcheck and ping endpoints.
Copy link
Contributor

Choose a reason for hiding this comment

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

How is filtered-transactions toggled? If it's done using the active query param, you must add it to the active strin explanation. Also this filter appears to be set behind a feature flag so is it available to all users by default?

Screenshot 2023-06-30 at 12 25 06 PM

Copy link
Contributor Author

@RaduW RaduW Jul 4, 2023

Choose a reason for hiding this comment

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

Thanks for the comment.
It uses the active flag, will update the doc.

There is a followup PR, #52099, that completely removes the Feature, it was initially intended only for business plans but then it was opened for everybody so the feature flag is no longer used ( and will be shortly removed)

@RaduW RaduW merged commit f9e82e0 into master Jul 6, 2023
@RaduW RaduW deleted the feat/doc/add-healthcheck-inbound-filter branch July 6, 2023 07:18
@github-actions github-actions bot locked and limited conversation to collaborators Jul 21, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Scope: Backend Automatically applied to PRs that change backend components
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update docs to include new filter
3 participants