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.

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

Jump to bottom

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

Merged
merged 2 commits into from
Jul 6, 2023
Merged

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

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a83c8b0
update health-check inbound filter API documentation
RaduW Jun 30, 2023
9bbf0e0
specify filtered-transaction parameters
RaduW Jul 4, 2023
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
3 changes: 2 additions & 1 deletion src/sentry/apidocs/parameters.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 •
edited
Loading

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)

""",
)

Expand All @@ -245,7 +246,7 @@ class ProjectParams:
location="query",
required=False,
type=bool,
description="Toggle the browser-extensions, localhost, or web-crawlers filter on or off.",
description="Toggle the browser-extensions, localhost, web-crawlers, or filtered-transaction filter on or off.",
)

BROWSER_SDK_VERSION = OpenApiParameter(
Expand Down