-
-
Notifications
You must be signed in to change notification settings - Fork 1.7k
feat: Set log level for Fetch/XHR breadcrumbs based on status code #13711
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
Merged
lforst
merged 9 commits into
getsentry:develop
from
Zen-cronic:update/breadcrumb-log-level
Sep 23, 2024
Merged
Changes from 6 commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
e70d1b3
fix(core): Set log level for Fetch/XHR breadcrumbs based on status code
Zen-cronic c141bd8
chore(typo): Fix typo in `Scope.addBreadcrumb`
Zen-cronic fbcc140
Remove extra optional chain
Zen-cronic 80efec1
test(core): Add unit test for the updated log level function
Zen-cronic 3100ead
fix(core): Apply breadcrumb log level function in packages where `add…
Zen-cronic 7cea142
fix(core): Revert to original `addBreadcrumb` code
Zen-cronic a71e07e
test(browser): Add sample integration test for breadcrumb log level
Zen-cronic bfa9caf
fix(core): Add log level only to 4xx/5xx codes
Zen-cronic e5e33ee
Clean up
lforst File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
import type { SeverityLevel } from '@sentry/types'; | ||
|
||
/** | ||
* Determine a breadcrumb's log level based on the response status code | ||
* @param statusCode | ||
*/ | ||
export function getBreadcrumbLogLevel(statusCode: number | undefined): SeverityLevel { | ||
if (statusCode === undefined) { | ||
return 'info'; | ||
} else if (statusCode >= 400 && statusCode < 500) { | ||
return 'warning'; | ||
} else if (statusCode >= 500) { | ||
return 'error'; | ||
} else { | ||
return 'info'; | ||
} | ||
} |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
import type { SeverityLevel } from '@sentry/types'; | ||
import { getBreadcrumbLogLevel } from '../../../src/utils/breadcrumbsUtils'; | ||
|
||
describe('getBreadcrumbLogLevel()', () => { | ||
it.each([ | ||
['warning', '4xx', 403], | ||
['error', '5xx', 500], | ||
['info', '3xx', 307], | ||
['info', '2xx', 200], | ||
['info', '1xx', 103], | ||
['info', 'undefined', undefined], | ||
] as [SeverityLevel, string, number | undefined][])('should return `%s` for %s', (output, _codeRange, input) => { | ||
expect(getBreadcrumbLogLevel(input)).toBe(output); | ||
}); | ||
}); |
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
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
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
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
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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For the
undefined
and other cases, the fallback level isinfo
. So, all the test cases for breadcrumbs inbrowser-integration-tests
must be updated, which is quite a lot.Is this behaviour needed? E.g., non-error request breadcrumb will have an additional property
level: 'info'
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Currently many tests are failing b/c of the default property. Maybe we shouldn't set it if the response has a non-error status code. Otherwise, it's a handful to fix those tests (though it's simply just adding the property).
Any thoughts?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For now, i've left out the default value (
info
) to not break the many other tests. But other sdks use a default value: getsentry/sentry-php@d12482a. So we should consider it.