Skip to content

feat(logs): Add experimental user-callable logging methods - #15442

Closed
colin-sentry wants to merge 36 commits into
developfrom
colin/log-api
Closed

feat(logs): Add experimental user-callable logging methods#15442
colin-sentry wants to merge 36 commits into
developfrom
colin/log-api

Conversation

@colin-sentry

@colin-sentrycolin-sentry commented Feb 18, 2025•
edited by AbhiPrasad
Loading

Copy link
Copy Markdown

This PR adds logging APIs to the SDK. At the moment this is only exposed in @sentry/core and @sentry/browser.

Logging is gated by an experimental option, _experiments.enableLogs.

Sentry.init({_experiments: {enableLogs: true,},});

These API are exposed in the Sentry._experiment_log namespace.

On the high level, there are functions for each of the logging severity levels fatal, error, warn, info, debug, trace. There is also a log function that is an alias to info.

Sentry._experiment_log.info('Adding item to cart',{item: 'sneakers'});

If you want to do structured logging, you'll need to use the fmt helper exposed in the Sentry._experiment_log namespace.

const{ fmt }=Sentry._experiment_log;Sentry._experiment_log.info(fmt`user ${username} just bought ${item}!`);

There is a buffer of logs that flushes every 5 seconds, or when you hit 25 logs, whichever comes first.

Frame 1 (5)

@github-actions

github-actionsBot commented Feb 18, 2025•
edited
Loading

Copy link
Copy Markdown
Contributor

size-limit report 📦

PathSize% ChangeChange
@sentry/browser23.89 KB+3.19%+755 B 🔺
@sentry/browser - with treeshaking flags23.69 KB+3.27%+766 B 🔺
@sentry/browser (incl. Tracing)36.88 KB+1.87%+690 B 🔺
@sentry/browser (incl. Tracing, Replay)74.05 KB+0.91%+677 B 🔺
@sentry/browser (incl. Tracing, Replay) - with treeshaking flags67.48 KB+1.03%+698 B 🔺
@sentry/browser (incl. Tracing, Replay with Canvas)78.69 KB+0.88%+697 B 🔺
@sentry/browser (incl. Tracing, Replay, Feedback)91.23 KB+0.73%+675 B 🔺
⛔️ @sentry/browser (incl. Feedback) (max: 41.02 KB)41.03 KB+1.82%+749 B 🔺
@sentry/browser (incl. sendFeedback)28.52 KB+2.66%+756 B 🔺
@sentry/browser (incl. FeedbackAsync)33.31 KB+2.25%+750 B 🔺
@sentry/react25.67 KB+2.83%+722 B 🔺
@sentry/react (incl. Tracing)38.8 KB+1.85%+720 B 🔺
@sentry/vue28.11 KB+2.61%+731 B 🔺
⛔️ @sentry/vue (incl. Tracing) (max: 38.57 KB)38.61 KB+1.89%+731 B 🔺
@sentry/svelte23.92 KB+3.2%+758 B 🔺
CDN Bundle24.36 KB--
CDN Bundle (incl. Tracing)36.26 KB--
CDN Bundle (incl. Tracing, Replay)71.27 KB--
CDN Bundle (incl. Tracing, Replay, Feedback)76.44 KB--
CDN Bundle - uncompressed71.19 KB--
CDN Bundle (incl. Tracing) - uncompressed107.57 KB--
CDN Bundle (incl. Tracing, Replay) - uncompressed218.84 KB--
CDN Bundle (incl. Tracing, Replay, Feedback) - uncompressed231.4 KB--
@sentry/nextjs (client)39.94 KB+1.7%+683 B 🔺
@sentry/sveltekit (client)37.31 KB+1.88%+703 B 🔺
@sentry/node142.88 KB+0.52%+746 B 🔺
@sentry/node - without tracing96.32 KB+0.79%+767 B 🔺
@sentry/aws-serverless120.64 KB+0.6%+735 B 🔺

View base workflow run

stephanie-anderson
stephanie-anderson reviewed Feb 19, 2025
View reviewed changes
Comment threadpackages/core/src/ourlogs.ts Outdated
stephanie-anderson
stephanie-anderson reviewed Feb 19, 2025
View reviewed changes
Comment threadpackages/core/src/types-hoist/envelope.ts Outdated
stephanie-anderson
stephanie-anderson reviewed Feb 19, 2025
View reviewed changes
Comment threadpackages/core/src/utils-hoist/envelope.ts
feedback: 'feedback',
span: 'span',
raw_security: 'security',
otel_log: 'log_item',

@stephanie-andersonstephanie-andersonFeb 19, 2025

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.

Will there be any other type than otel_log? If not in the foreseeable future, I'd suggest we change it to

Suggested change
otel_log: 'log_item',
log: 'log',

Again singular, as in span, or replay

@AbhiPrasadAbhiPrasadFeb 20, 2025

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.

This is done because it matches the code in relay for data categories (rate limiting and client outcomes) https://github.com/getsentry/relay/blob/e36886a98c89af645e5c0d2109657deafa25d902/relay-server/src/envelope.rs#L182

@AbhiPrasadAbhiPrasad self-assigned this Feb 19, 2025
@codecov

codecovBot commented Feb 20, 2025•
edited
Loading

Copy link
Copy Markdown

❌ 1 Tests Failed:

Tests completedFailedPassedSkipped
464814647324
View the top 1 failed test(s) by shortest run time
shouldreportANRwheneventloopblockedworkercanbestoppedandrestarted
Stack Traces | 15s run time
Error: thrown: "Exceededtimeoutof15000msforatest.
Usejest.setTimeout(newTimeout) toincreasethetimeoutvalue, ifthisisalong-runningtest."
at .../suites/anr/test.ts:204:3at_dispatchDescribe (.../jest-circus/build/index.js:98:26)
atdescribe (.../jest-circus/build/index.js:60:5)
atObject.<anonymous> (.../suites/anr/test.ts:109:1)
atRuntime._execModule (.../jest-runtime/build/index.js:1646:24)
atRuntime._loadModule (.../jest-runtime/build/index.js:1185:12)
atRuntime.requireModule (.../jest-runtime/build/index.js:1009:12)
atjestAdapter (.../build/legacy-code-todo-rewrite/jestAdapter.js:79:13)
atprocessTicksAndRejections (node:internal/process/task_queues:105:5)
atrunTestInternal (.../jest-runner/build/runTest.js:389:16)

To view more test analytics, go to the Test Analytics Dashboard
📋 Got 3 mins? Take this short survey to help us improve Test Analytics.

@AbhiPrasadAbhiPrasad changed the title feat(ourlogs): Add experimental user-callable logging methodsfeat(logs): Add experimental user-callable logging methodsFeb 20, 2025
colin-sentry
colin-sentry commented Feb 20, 2025
View reviewed changes
Comment threadpackages/core/src/log.ts Outdated
@AbhiPrasadAbhiPrasad mentioned this pull request Feb 20, 2025
Closed
k-fish
k-fish reviewed Feb 20, 2025
View reviewed changes
Comment threadpackages/core/src/log.ts
Comment on lines +17 to +23
trace: 1,
log: 2,
debug: 5,
info: 9,
warn: 13,
error: 17,
fatal: 21,

@k-fishk-fishFeb 20, 2025

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
trace: 1,
log: 2,
debug: 5,
info: 9,
warn: 13,
error: 17,
fatal: 21,
trace: 1,
debug: 5,
info: 9,
log: 10,
warn: 13,
error: 17,
fatal: 21,

@timfish

timfish commented Feb 25, 2025•
edited
Loading

Copy link
Copy Markdown
Collaborator

It's strange how this impacts bundle size. I would have expected the additional code to tree-shake out when it's not used!

Why is the _experiments.enableLogs option required? If users don't log anything via the new experimental API, logs wont be sent.

@AbhiPrasad

AbhiPrasad commented Feb 26, 2025

Copy link
Copy Markdown
Contributor

It's strange how this impacts bundle size. I would have expected the additional code to tree-shake out when it's not used!

Yeah that feels weird to me too. I wonder if it's because of the log buffer side effect.

Why is the _experiments.enableLogs option required? If users don't log anything via the new experimental API, logs wont be sent.

Because we'll eventually also forward the console calls as logs, and that will be gated by _experiments.enableLogs. This experimental option will also graduate to be a top-level option, but we're bikeshedding naming because logs is super overloaded 😄

colin-sentry
colin-sentry commented Mar 4, 2025
View reviewed changes
Comment threadpackages/core/src/log.ts Outdated
lforst
lforst reviewed Mar 5, 2025
View reviewed changes
Comment threadpackages/core/src/exports.ts
* fatal(fmt`user ${username} just bought ${item}!`);
* ```
*/
fatal: sendLog('fatal'),

@lforstlforstMar 5, 2025

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.

This is the side-effect y'all are probably looking for.

@AbhiPrasadAbhiPrasad mentioned this pull request Mar 5, 2025
Closed
@k-fish

k-fish commented Mar 5, 2025

Copy link
Copy Markdown
Member

@AbhiPrasad we have to change the typing on the parametrize values to allow all the possible js types, do we want to change it or just make another function?

@k-fish

k-fish commented Mar 5, 2025

Copy link
Copy Markdown
Member

@AbhiPrasad this #15600 maybe?

@HofmannZ

HofmannZ commented Mar 6, 2025

Copy link
Copy Markdown

How does this integrate with loggers like pino?

@AbhiPrasad

AbhiPrasad commented Mar 6, 2025

Copy link
Copy Markdown
Contributor

How does this integrate with loggers like pino?

For now the focus is on frontend logging, but we'll have integrations for popular logging frameworks. You can see getsentry/sentry-docs#12920 for more details how SDKs will work with logging frameworks.

@AbhiPrasadAbhiPrasad mentioned this pull request Mar 6, 2025
Closed
@joshdales

joshdales commented Mar 7, 2025•
edited
Loading

Copy link
Copy Markdown

Is there a reason that this couldn't be added to the Angular package as well?

Would be very nice if it could please 🥺

@AbhiPrasad

AbhiPrasad commented Mar 11, 2025

Copy link
Copy Markdown
Contributor

@joshdales the angular package re-exports everything from the browser sdk, so this is included there.

The plan is that all JavaScript SDKs will have support for logs as soon as we're ready for users to use it :)

@joshdales

joshdales commented Mar 11, 2025

Copy link
Copy Markdown

@AbhiPrasad thanks for the context, as it wasn't included in the release notes I wasn't aware. Very excited to try this out 😄

@AbhiPrasad

AbhiPrasad commented Mar 26, 2025

Copy link
Copy Markdown
Contributor

This can be closed, we split this PR up into multiple steps and merged it in accordingly: #15526

@AbhiPrasad
AbhiPrasad deleted the colin/log-api branch March 26, 2025 15:48
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@k-fishk-fishk-fish left review comments
@stephanie-andersonstephanie-andersonstephanie-anderson left review comments
@AbhiPrasadAbhiPrasadAwaiting requested review from AbhiPrasad
+1 more reviewer
@lforstlforstlforst left review comments
Reviewers whose approvals may not affect merge requirements

Assignees

@AbhiPrasadAbhiPrasad

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

8 participants

@colin-sentry@timfish@AbhiPrasad@k-fish@HofmannZ@joshdales@stephanie-anderson@lforst
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
feat(logs): Add experimental user-callable logging methods by colin-sentry · Pull Request #15442 · getsentry/sentry-javascript · GitHub
Skip to content
feat(logs): Add experimental user-callable logging methods - #15442
Closed
colin-sentry wants to merge 36 commits into
developfrom 
colin/log-api
Closed
feat(logs): Add experimental user-callable logging methods#15442
colin-sentry wants to merge 36 commits into
developfrom 
colin/log-api
Conversation
@colin-sentry
@colin-sentrycolin-sentry
commented
Feb 18, 2025•

edited by AbhiPrasad

Loading

Copy link


Copy Markdown

This PR adds logging APIs to the SDK. At the moment this is only exposed in @sentry/core and @sentry/browser.
Logging is gated by an experimental option, _experiments.enableLogs.
Sentry.init({_experiments: {enableLogs: true,},});
These API are exposed in the Sentry._experiment_log namespace.
On the high level, there are functions for each of the logging severity levels fatal, error, warn, info, debug, trace. There is also a log function that is an alias to info.
Sentry._experiment_log.info('Adding item to cart',{item: 'sneakers'});
If you want to do structured logging, you'll need to use the fmt helper exposed in the Sentry._experiment_log namespace.
const{ fmt }=Sentry._experiment_log;Sentry._experiment_log.info(fmt`user ${username} just bought ${item}!`);
There is a buffer of logs that flushes every 5 seconds, or when you hit 25 logs, whichever comes first.
Frame 1 (5)
@github-actions
github-actionsBot
commented
Feb 18, 2025•

edited

Loading

Copy link


Copy Markdown

Contributor
size-limit report 📦
PathSize% ChangeChange
@sentry/browser23.89 KB+3.19%+755 B 🔺
@sentry/browser - with treeshaking flags23.69 KB+3.27%+766 B 🔺
@sentry/browser (incl. Tracing)36.88 KB+1.87%+690 B 🔺
@sentry/browser (incl. Tracing, Replay)74.05 KB+0.91%+677 B 🔺
@sentry/browser (incl. Tracing, Replay) - with treeshaking flags67.48 KB+1.03%+698 B 🔺
@sentry/browser (incl. Tracing, Replay with Canvas)78.69 KB+0.88%+697 B 🔺
@sentry/browser (incl. Tracing, Replay, Feedback)91.23 KB+0.73%+675 B 🔺
⛔️ @sentry/browser (incl. Feedback) (max: 41.02 KB)41.03 KB+1.82%+749 B 🔺
@sentry/browser (incl. sendFeedback)28.52 KB+2.66%+756 B 🔺
@sentry/browser (incl. FeedbackAsync)33.31 KB+2.25%+750 B 🔺
@sentry/react25.67 KB+2.83%+722 B 🔺
@sentry/react (incl. Tracing)38.8 KB+1.85%+720 B 🔺
@sentry/vue28.11 KB+2.61%+731 B 🔺
⛔️ @sentry/vue (incl. Tracing) (max: 38.57 KB)38.61 KB+1.89%+731 B 🔺
@sentry/svelte23.92 KB+3.2%+758 B 🔺
CDN Bundle24.36 KB--
CDN Bundle (incl. Tracing)36.26 KB--
CDN Bundle (incl. Tracing, Replay)71.27 KB--
CDN Bundle (incl. Tracing, Replay, Feedback)76.44 KB--
CDN Bundle - uncompressed71.19 KB--
CDN Bundle (incl. Tracing) - uncompressed107.57 KB--
CDN Bundle (incl. Tracing, Replay) - uncompressed218.84 KB--
CDN Bundle (incl. Tracing, Replay, Feedback) - uncompressed231.4 KB--
@sentry/nextjs (client)39.94 KB+1.7%+683 B 🔺
@sentry/sveltekit (client)37.31 KB+1.88%+703 B 🔺
@sentry/node142.88 KB+0.52%+746 B 🔺
@sentry/node - without tracing96.32 KB+0.79%+767 B 🔺
@sentry/aws-serverless120.64 KB+0.6%+735 B 🔺
View base workflow run
stephanie-anderson
stephanie-anderson
reviewed
Feb 19, 2025
View reviewed changes
Comment threadpackages/core/src/ourlogs.ts
Outdated

stephanie-anderson
stephanie-anderson
reviewed
Feb 19, 2025
View reviewed changes
Comment threadpackages/core/src/types-hoist/envelope.ts
Outdated

stephanie-anderson
stephanie-anderson
reviewed
Feb 19, 2025
View reviewed changes
Comment threadpackages/core/src/utils-hoist/envelope.ts
 feedback: 'feedback',
 span: 'span',
 raw_security: 'security',
 otel_log: 'log_item',
@stephanie-andersonstephanie-andersonFeb 19, 2025

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.

Will there be any other type than otel_log? If not in the foreseeable future, I'd suggest we change it to

Suggested change

otel_log: 'log_item',
log: 'log',
Again singular, as in span, or replay
@AbhiPrasadAbhiPrasadFeb 20, 2025

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.

This is done because it matches the code in relay for data categories (rate limiting and client outcomes) https://github.com/getsentry/relay/blob/e36886a98c89af645e5c0d2109657deafa25d902/relay-server/src/envelope.rs#L182
@AbhiPrasadAbhiPrasad
self-assigned this
Feb 19, 2025
@codecov
codecovBot
commented
Feb 20, 2025•

edited

Loading

Copy link


Copy Markdown

❌ 1 Tests Failed:
Tests completedFailedPassedSkipped
464814647324
View the top 1 failed test(s) by shortest run time
shouldreportANRwheneventloopblockedworkercanbestoppedandrestarted
Stack Traces | 15s run time
Error: thrown: "Exceededtimeoutof15000msforatest.
Usejest.setTimeout(newTimeout) toincreasethetimeoutvalue, ifthisisalong-runningtest."
at .../suites/anr/test.ts:204:3at_dispatchDescribe (.../jest-circus/build/index.js:98:26)
atdescribe (.../jest-circus/build/index.js:60:5)
atObject.<anonymous> (.../suites/anr/test.ts:109:1)
atRuntime._execModule (.../jest-runtime/build/index.js:1646:24)
atRuntime._loadModule (.../jest-runtime/build/index.js:1185:12)
atRuntime.requireModule (.../jest-runtime/build/index.js:1009:12)
atjestAdapter (.../build/legacy-code-todo-rewrite/jestAdapter.js:79:13)
atprocessTicksAndRejections (node:internal/process/task_queues:105:5)
atrunTestInternal (.../jest-runner/build/runTest.js:389:16)
To view more test analytics, go to the Test Analytics Dashboard
📋 Got 3 mins? Take this short survey to help us improve Test Analytics.
@AbhiPrasadAbhiPrasad
changed the title
feat(ourlogs): Add experimental user-callable logging methodsfeat(logs): Add experimental user-callable logging methodsFeb 20, 2025
colin-sentry
colin-sentry
commented
Feb 20, 2025
View reviewed changes
Comment threadpackages/core/src/log.ts
Outdated

@AbhiPrasadAbhiPrasad
mentioned this pull request
Feb 20, 2025
 Closed

k-fish
k-fish
reviewed
Feb 20, 2025
View reviewed changes
Comment threadpackages/core/src/log.ts

Comment on lines

+17
 to 
+23

 trace: 1,
 log: 2,
 debug: 5,
 info: 9,
 warn: 13,
 error: 17,
 fatal: 21,
@k-fishk-fishFeb 20, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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


Suggested change

trace: 1,
log: 2,
debug: 5,
info: 9,
warn: 13,
error: 17,
fatal: 21,
trace: 1,
debug: 5,
info: 9,
log: 10,
warn: 13,
error: 17,
fatal: 21,
@timfish
timfish
commented
Feb 25, 2025•

edited

Loading

Copy link


Copy Markdown

Collaborator
It's strange how this impacts bundle size. I would have expected the additional code to tree-shake out when it's not used!
Why is the _experiments.enableLogs option required? If users don't log anything via the new experimental API, logs wont be sent.
@AbhiPrasad
AbhiPrasad
commented
Feb 26, 2025

Copy link


Copy Markdown

Contributor
It's strange how this impacts bundle size. I would have expected the additional code to tree-shake out when it's not used!
Yeah that feels weird to me too. I wonder if it's because of the log buffer side effect.
Why is the _experiments.enableLogs option required? If users don't log anything via the new experimental API, logs wont be sent.
Because we'll eventually also forward the console calls as logs, and that will be gated by _experiments.enableLogs. This experimental option will also graduate to be a top-level option, but we're bikeshedding naming because logs is super overloaded 😄
colin-sentry
colin-sentry
commented
Mar 4, 2025
View reviewed changes
Comment threadpackages/core/src/log.ts
Outdated

lforst
lforst
reviewed
Mar 5, 2025
View reviewed changes
Comment threadpackages/core/src/exports.ts
 * fatal(fmt`user ${username} just bought ${item}!`);
 * ```
 */
 fatal: sendLog('fatal'),
@lforstlforstMar 5, 2025

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.

This is the side-effect y'all are probably looking for.
@AbhiPrasadAbhiPrasad
mentioned this pull request
Mar 5, 2025
 Closed

@k-fish
k-fish
commented
Mar 5, 2025

Copy link


Copy Markdown

Member
@AbhiPrasad we have to change the typing on the parametrize values to allow all the possible js types, do we want to change it or just make another function?
@k-fish
k-fish
commented
Mar 5, 2025

Copy link


Copy Markdown

Member
@AbhiPrasad this #15600 maybe?
@HofmannZ
HofmannZ
commented
Mar 6, 2025

Copy link


Copy Markdown

How does this integrate with loggers like pino?
@AbhiPrasad
AbhiPrasad
commented
Mar 6, 2025

Copy link


Copy Markdown

Contributor
How does this integrate with loggers like pino?
For now the focus is on frontend logging, but we'll have integrations for popular logging frameworks. You can see getsentry/sentry-docs#12920 for more details how SDKs will work with logging frameworks.
@AbhiPrasadAbhiPrasad
mentioned this pull request
Mar 6, 2025
 Closed

@joshdales
joshdales
commented
Mar 7, 2025•

edited

Loading

Copy link


Copy Markdown

Is there a reason that this couldn't be added to the Angular package as well?
Would be very nice if it could please 🥺
@AbhiPrasad
AbhiPrasad
commented
Mar 11, 2025

Copy link


Copy Markdown

Contributor
@joshdales the angular package re-exports everything from the browser sdk, so this is included there.
The plan is that all JavaScript SDKs will have support for logs as soon as we're ready for users to use it :)
@joshdales
joshdales
commented
Mar 11, 2025

Copy link


Copy Markdown

@AbhiPrasad thanks for the context, as it wasn't included in the release notes I wasn't aware. Very excited to try this out 😄
@AbhiPrasad
AbhiPrasad
commented
Mar 26, 2025

Copy link


Copy Markdown

Contributor
This can be closed, we split this PR up into multiple steps and merged it in accordingly: #15526
@AbhiPrasad
AbhiPrasad
deleted the

colin/log-api

branch
March 26, 2025 15:48
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@k-fishk-fishk-fish left review comments
@stephanie-andersonstephanie-andersonstephanie-anderson left review comments
@AbhiPrasadAbhiPrasadAwaiting requested review from AbhiPrasad

+1 more reviewer

@lforstlforstlforst left review comments
Reviewers whose approvals may not affect merge requirements

Assignees

@AbhiPrasadAbhiPrasad

Labels


None yet


Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

8 participants

@colin-sentry@timfish@AbhiPrasad@k-fish@HofmannZ@joshdales@stephanie-anderson@lforst

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
feat(logs): Add experimental user-callable logging methods by colin-sentry · Pull Request #15442 · getsentry/sentry-javascript · GitHub
Skip to content
feat(logs): Add experimental user-callable logging methods - #15442
Closed
colin-sentry wants to merge 36 commits into
developfrom 
colin/log-api
Closed
feat(logs): Add experimental user-callable logging methods#15442
colin-sentry wants to merge 36 commits into
developfrom 
colin/log-api
Conversation
@colin-sentry
@colin-sentrycolin-sentry
commented
Feb 18, 2025•

edited by AbhiPrasad

Loading

Copy link


Copy Markdown

This PR adds logging APIs to the SDK. At the moment this is only exposed in @sentry/core and @sentry/browser.
Logging is gated by an experimental option, _experiments.enableLogs.
Sentry.init({_experiments: {enableLogs: true,},});
These API are exposed in the Sentry._experiment_log namespace.
On the high level, there are functions for each of the logging severity levels fatal, error, warn, info, debug, trace. There is also a log function that is an alias to info.
Sentry._experiment_log.info('Adding item to cart',{item: 'sneakers'});
If you want to do structured logging, you'll need to use the fmt helper exposed in the Sentry._experiment_log namespace.
const{ fmt }=Sentry._experiment_log;Sentry._experiment_log.info(fmt`user ${username} just bought ${item}!`);
There is a buffer of logs that flushes every 5 seconds, or when you hit 25 logs, whichever comes first.
Frame 1 (5)
@github-actions
github-actionsBot
commented
Feb 18, 2025•

edited

Loading

Copy link


Copy Markdown

Contributor
size-limit report 📦
PathSize% ChangeChange
@sentry/browser23.89 KB+3.19%+755 B 🔺
@sentry/browser - with treeshaking flags23.69 KB+3.27%+766 B 🔺
@sentry/browser (incl. Tracing)36.88 KB+1.87%+690 B 🔺
@sentry/browser (incl. Tracing, Replay)74.05 KB+0.91%+677 B 🔺
@sentry/browser (incl. Tracing, Replay) - with treeshaking flags67.48 KB+1.03%+698 B 🔺
@sentry/browser (incl. Tracing, Replay with Canvas)78.69 KB+0.88%+697 B 🔺
@sentry/browser (incl. Tracing, Replay, Feedback)91.23 KB+0.73%+675 B 🔺
⛔️ @sentry/browser (incl. Feedback) (max: 41.02 KB)41.03 KB+1.82%+749 B 🔺
@sentry/browser (incl. sendFeedback)28.52 KB+2.66%+756 B 🔺
@sentry/browser (incl. FeedbackAsync)33.31 KB+2.25%+750 B 🔺
@sentry/react25.67 KB+2.83%+722 B 🔺
@sentry/react (incl. Tracing)38.8 KB+1.85%+720 B 🔺
@sentry/vue28.11 KB+2.61%+731 B 🔺
⛔️ @sentry/vue (incl. Tracing) (max: 38.57 KB)38.61 KB+1.89%+731 B 🔺
@sentry/svelte23.92 KB+3.2%+758 B 🔺
CDN Bundle24.36 KB--
CDN Bundle (incl. Tracing)36.26 KB--
CDN Bundle (incl. Tracing, Replay)71.27 KB--
CDN Bundle (incl. Tracing, Replay, Feedback)76.44 KB--
CDN Bundle - uncompressed71.19 KB--
CDN Bundle (incl. Tracing) - uncompressed107.57 KB--
CDN Bundle (incl. Tracing, Replay) - uncompressed218.84 KB--
CDN Bundle (incl. Tracing, Replay, Feedback) - uncompressed231.4 KB--
@sentry/nextjs (client)39.94 KB+1.7%+683 B 🔺
@sentry/sveltekit (client)37.31 KB+1.88%+703 B 🔺
@sentry/node142.88 KB+0.52%+746 B 🔺
@sentry/node - without tracing96.32 KB+0.79%+767 B 🔺
@sentry/aws-serverless120.64 KB+0.6%+735 B 🔺
View base workflow run
stephanie-anderson
stephanie-anderson
reviewed
Feb 19, 2025
View reviewed changes
Comment threadpackages/core/src/ourlogs.ts
Outdated

stephanie-anderson
stephanie-anderson
reviewed
Feb 19, 2025
View reviewed changes
Comment threadpackages/core/src/types-hoist/envelope.ts
Outdated

stephanie-anderson
stephanie-anderson
reviewed
Feb 19, 2025
View reviewed changes
Comment threadpackages/core/src/utils-hoist/envelope.ts
 feedback: 'feedback',
 span: 'span',
 raw_security: 'security',
 otel_log: 'log_item',
@stephanie-andersonstephanie-andersonFeb 19, 2025

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.

Will there be any other type than otel_log? If not in the foreseeable future, I'd suggest we change it to

Suggested change

otel_log: 'log_item',
log: 'log',
Again singular, as in span, or replay
@AbhiPrasadAbhiPrasadFeb 20, 2025

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.

This is done because it matches the code in relay for data categories (rate limiting and client outcomes) https://github.com/getsentry/relay/blob/e36886a98c89af645e5c0d2109657deafa25d902/relay-server/src/envelope.rs#L182
@AbhiPrasadAbhiPrasad
self-assigned this
Feb 19, 2025
@codecov
codecovBot
commented
Feb 20, 2025•

edited

Loading

Copy link


Copy Markdown

❌ 1 Tests Failed:
Tests completedFailedPassedSkipped
464814647324
View the top 1 failed test(s) by shortest run time
shouldreportANRwheneventloopblockedworkercanbestoppedandrestarted
Stack Traces | 15s run time
Error: thrown: "Exceededtimeoutof15000msforatest.
Usejest.setTimeout(newTimeout) toincreasethetimeoutvalue, ifthisisalong-runningtest."
at .../suites/anr/test.ts:204:3at_dispatchDescribe (.../jest-circus/build/index.js:98:26)
atdescribe (.../jest-circus/build/index.js:60:5)
atObject.<anonymous> (.../suites/anr/test.ts:109:1)
atRuntime._execModule (.../jest-runtime/build/index.js:1646:24)
atRuntime._loadModule (.../jest-runtime/build/index.js:1185:12)
atRuntime.requireModule (.../jest-runtime/build/index.js:1009:12)
atjestAdapter (.../build/legacy-code-todo-rewrite/jestAdapter.js:79:13)
atprocessTicksAndRejections (node:internal/process/task_queues:105:5)
atrunTestInternal (.../jest-runner/build/runTest.js:389:16)
To view more test analytics, go to the Test Analytics Dashboard
📋 Got 3 mins? Take this short survey to help us improve Test Analytics.
@AbhiPrasadAbhiPrasad
changed the title
feat(ourlogs): Add experimental user-callable logging methodsfeat(logs): Add experimental user-callable logging methodsFeb 20, 2025
colin-sentry
colin-sentry
commented
Feb 20, 2025
View reviewed changes
Comment threadpackages/core/src/log.ts
Outdated

@AbhiPrasadAbhiPrasad
mentioned this pull request
Feb 20, 2025
 Closed

k-fish
k-fish
reviewed
Feb 20, 2025
View reviewed changes
Comment threadpackages/core/src/log.ts

Comment on lines

+17
 to 
+23

 trace: 1,
 log: 2,
 debug: 5,
 info: 9,
 warn: 13,
 error: 17,
 fatal: 21,
@k-fishk-fishFeb 20, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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


Suggested change

trace: 1,
log: 2,
debug: 5,
info: 9,
warn: 13,
error: 17,
fatal: 21,
trace: 1,
debug: 5,
info: 9,
log: 10,
warn: 13,
error: 17,
fatal: 21,
@timfish
timfish
commented
Feb 25, 2025•

edited

Loading

Copy link


Copy Markdown

Collaborator
It's strange how this impacts bundle size. I would have expected the additional code to tree-shake out when it's not used!
Why is the _experiments.enableLogs option required? If users don't log anything via the new experimental API, logs wont be sent.
@AbhiPrasad
AbhiPrasad
commented
Feb 26, 2025

Copy link


Copy Markdown

Contributor
It's strange how this impacts bundle size. I would have expected the additional code to tree-shake out when it's not used!
Yeah that feels weird to me too. I wonder if it's because of the log buffer side effect.
Why is the _experiments.enableLogs option required? If users don't log anything via the new experimental API, logs wont be sent.
Because we'll eventually also forward the console calls as logs, and that will be gated by _experiments.enableLogs. This experimental option will also graduate to be a top-level option, but we're bikeshedding naming because logs is super overloaded 😄
colin-sentry
colin-sentry
commented
Mar 4, 2025
View reviewed changes
Comment threadpackages/core/src/log.ts
Outdated

lforst
lforst
reviewed
Mar 5, 2025
View reviewed changes
Comment threadpackages/core/src/exports.ts
 * fatal(fmt`user ${username} just bought ${item}!`);
 * ```
 */
 fatal: sendLog('fatal'),
@lforstlforstMar 5, 2025

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.

This is the side-effect y'all are probably looking for.
@AbhiPrasadAbhiPrasad
mentioned this pull request
Mar 5, 2025
 Closed

@k-fish
k-fish
commented
Mar 5, 2025

Copy link


Copy Markdown

Member
@AbhiPrasad we have to change the typing on the parametrize values to allow all the possible js types, do we want to change it or just make another function?
@k-fish
k-fish
commented
Mar 5, 2025

Copy link


Copy Markdown

Member
@AbhiPrasad this #15600 maybe?
@HofmannZ
HofmannZ
commented
Mar 6, 2025

Copy link


Copy Markdown

How does this integrate with loggers like pino?
@AbhiPrasad
AbhiPrasad
commented
Mar 6, 2025

Copy link


Copy Markdown

Contributor
How does this integrate with loggers like pino?
For now the focus is on frontend logging, but we'll have integrations for popular logging frameworks. You can see getsentry/sentry-docs#12920 for more details how SDKs will work with logging frameworks.
@AbhiPrasadAbhiPrasad
mentioned this pull request
Mar 6, 2025
 Closed

@joshdales
joshdales
commented
Mar 7, 2025•

edited

Loading

Copy link


Copy Markdown

Is there a reason that this couldn't be added to the Angular package as well?
Would be very nice if it could please 🥺
@AbhiPrasad
AbhiPrasad
commented
Mar 11, 2025

Copy link


Copy Markdown

Contributor
@joshdales the angular package re-exports everything from the browser sdk, so this is included there.
The plan is that all JavaScript SDKs will have support for logs as soon as we're ready for users to use it :)
@joshdales
joshdales
commented
Mar 11, 2025

Copy link


Copy Markdown

@AbhiPrasad thanks for the context, as it wasn't included in the release notes I wasn't aware. Very excited to try this out 😄
@AbhiPrasad
AbhiPrasad
commented
Mar 26, 2025

Copy link


Copy Markdown

Contributor
This can be closed, we split this PR up into multiple steps and merged it in accordingly: #15526
@AbhiPrasad
AbhiPrasad
deleted the

colin/log-api

branch
March 26, 2025 15:48
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@k-fishk-fishk-fish left review comments
@stephanie-andersonstephanie-andersonstephanie-anderson left review comments
@AbhiPrasadAbhiPrasadAwaiting requested review from AbhiPrasad

+1 more reviewer

@lforstlforstlforst left review comments
Reviewers whose approvals may not affect merge requirements

Assignees

@AbhiPrasadAbhiPrasad

Labels


None yet


Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

8 participants

@colin-sentry@timfish@AbhiPrasad@k-fish@HofmannZ@joshdales@stephanie-anderson@lforst

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Highlight search terms from Google/DuckDuckGo/Bing referrer
(function() {
var ref = document.referrer;
var terms = [];
if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {
var url = new URL(ref);
var q = url.searchParams.get('q') || url.searchParams.get('p');
if (q) {
terms = q.split(/\s+/).filter(function(t) { return t.length > 2; });
}
}
if (terms.length === 0) return;
var style = document.createElement('style');
style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';
document.head.appendChild(style);
function highlight(node) {
if (node.nodeType === 3) { // text node
var text = node.textContent;
var found = false;
terms.forEach(function(term) {
var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi');
if (regex.test(text)) {
found = true;
var frag = document.createDocumentFragment();
var parts = text.split(regex);
parts.forEach(function(part, i) {
if (i % 2 === 0) {
frag.appendChild(document.createTextNode(part));
} else {
var span = document.createElement('span');
span.className = 'userscript-highlight';
span.textContent = part;
frag.appendChild(span);
}
});
node.parentNode.replaceChild(frag, node);
}
});
} else if (node.nodeType === 1 && node.childNodes) { // element
var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];
if (!skipTags.includes(node.tagName)) {
Array.from(node.childNodes).forEach(highlight);
}
}
}
highlight(document.body);
// Re-highlight on dynamic content
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1 || node.nodeType === 3) highlight(node);
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
feat(logs): Add experimental user-callable logging methods by colin-sentry · Pull Request #15442 · getsentry/sentry-javascript · GitHub
Skip to content
feat(logs): Add experimental user-callable logging methods - #15442
Closed
colin-sentry wants to merge 36 commits into
developfrom 
colin/log-api
Closed
feat(logs): Add experimental user-callable logging methods#15442
colin-sentry wants to merge 36 commits into
developfrom 
colin/log-api
Conversation
@colin-sentry
@colin-sentrycolin-sentry
commented
Feb 18, 2025•

edited by AbhiPrasad

Loading

Copy link


Copy Markdown

This PR adds logging APIs to the SDK. At the moment this is only exposed in @sentry/core and @sentry/browser.
Logging is gated by an experimental option, _experiments.enableLogs.
Sentry.init({_experiments: {enableLogs: true,},});
These API are exposed in the Sentry._experiment_log namespace.
On the high level, there are functions for each of the logging severity levels fatal, error, warn, info, debug, trace. There is also a log function that is an alias to info.
Sentry._experiment_log.info('Adding item to cart',{item: 'sneakers'});
If you want to do structured logging, you'll need to use the fmt helper exposed in the Sentry._experiment_log namespace.
const{ fmt }=Sentry._experiment_log;Sentry._experiment_log.info(fmt`user ${username} just bought ${item}!`);
There is a buffer of logs that flushes every 5 seconds, or when you hit 25 logs, whichever comes first.
Frame 1 (5)
@github-actions
github-actionsBot
commented
Feb 18, 2025•

edited

Loading

Copy link


Copy Markdown

Contributor
size-limit report 📦
PathSize% ChangeChange
@sentry/browser23.89 KB+3.19%+755 B 🔺
@sentry/browser - with treeshaking flags23.69 KB+3.27%+766 B 🔺
@sentry/browser (incl. Tracing)36.88 KB+1.87%+690 B 🔺
@sentry/browser (incl. Tracing, Replay)74.05 KB+0.91%+677 B 🔺
@sentry/browser (incl. Tracing, Replay) - with treeshaking flags67.48 KB+1.03%+698 B 🔺
@sentry/browser (incl. Tracing, Replay with Canvas)78.69 KB+0.88%+697 B 🔺
@sentry/browser (incl. Tracing, Replay, Feedback)91.23 KB+0.73%+675 B 🔺
⛔️ @sentry/browser (incl. Feedback) (max: 41.02 KB)41.03 KB+1.82%+749 B 🔺
@sentry/browser (incl. sendFeedback)28.52 KB+2.66%+756 B 🔺
@sentry/browser (incl. FeedbackAsync)33.31 KB+2.25%+750 B 🔺
@sentry/react25.67 KB+2.83%+722 B 🔺
@sentry/react (incl. Tracing)38.8 KB+1.85%+720 B 🔺
@sentry/vue28.11 KB+2.61%+731 B 🔺
⛔️ @sentry/vue (incl. Tracing) (max: 38.57 KB)38.61 KB+1.89%+731 B 🔺
@sentry/svelte23.92 KB+3.2%+758 B 🔺
CDN Bundle24.36 KB--
CDN Bundle (incl. Tracing)36.26 KB--
CDN Bundle (incl. Tracing, Replay)71.27 KB--
CDN Bundle (incl. Tracing, Replay, Feedback)76.44 KB--
CDN Bundle - uncompressed71.19 KB--
CDN Bundle (incl. Tracing) - uncompressed107.57 KB--
CDN Bundle (incl. Tracing, Replay) - uncompressed218.84 KB--
CDN Bundle (incl. Tracing, Replay, Feedback) - uncompressed231.4 KB--
@sentry/nextjs (client)39.94 KB+1.7%+683 B 🔺
@sentry/sveltekit (client)37.31 KB+1.88%+703 B 🔺
@sentry/node142.88 KB+0.52%+746 B 🔺
@sentry/node - without tracing96.32 KB+0.79%+767 B 🔺
@sentry/aws-serverless120.64 KB+0.6%+735 B 🔺
View base workflow run
stephanie-anderson
stephanie-anderson
reviewed
Feb 19, 2025
View reviewed changes
Comment threadpackages/core/src/ourlogs.ts
Outdated

stephanie-anderson
stephanie-anderson
reviewed
Feb 19, 2025
View reviewed changes
Comment threadpackages/core/src/types-hoist/envelope.ts
Outdated

stephanie-anderson
stephanie-anderson
reviewed
Feb 19, 2025
View reviewed changes
Comment threadpackages/core/src/utils-hoist/envelope.ts
 feedback: 'feedback',
 span: 'span',
 raw_security: 'security',
 otel_log: 'log_item',
@stephanie-andersonstephanie-andersonFeb 19, 2025

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.

Will there be any other type than otel_log? If not in the foreseeable future, I'd suggest we change it to

Suggested change

otel_log: 'log_item',
log: 'log',
Again singular, as in span, or replay
@AbhiPrasadAbhiPrasadFeb 20, 2025

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.

This is done because it matches the code in relay for data categories (rate limiting and client outcomes) https://github.com/getsentry/relay/blob/e36886a98c89af645e5c0d2109657deafa25d902/relay-server/src/envelope.rs#L182
@AbhiPrasadAbhiPrasad
self-assigned this
Feb 19, 2025
@codecov
codecovBot
commented
Feb 20, 2025•

edited

Loading

Copy link


Copy Markdown

❌ 1 Tests Failed:
Tests completedFailedPassedSkipped
464814647324
View the top 1 failed test(s) by shortest run time
shouldreportANRwheneventloopblockedworkercanbestoppedandrestarted
Stack Traces | 15s run time
Error: thrown: "Exceededtimeoutof15000msforatest.
Usejest.setTimeout(newTimeout) toincreasethetimeoutvalue, ifthisisalong-runningtest."
at .../suites/anr/test.ts:204:3at_dispatchDescribe (.../jest-circus/build/index.js:98:26)
atdescribe (.../jest-circus/build/index.js:60:5)
atObject.<anonymous> (.../suites/anr/test.ts:109:1)
atRuntime._execModule (.../jest-runtime/build/index.js:1646:24)
atRuntime._loadModule (.../jest-runtime/build/index.js:1185:12)
atRuntime.requireModule (.../jest-runtime/build/index.js:1009:12)
atjestAdapter (.../build/legacy-code-todo-rewrite/jestAdapter.js:79:13)
atprocessTicksAndRejections (node:internal/process/task_queues:105:5)
atrunTestInternal (.../jest-runner/build/runTest.js:389:16)
To view more test analytics, go to the Test Analytics Dashboard
📋 Got 3 mins? Take this short survey to help us improve Test Analytics.
@AbhiPrasadAbhiPrasad
changed the title
feat(ourlogs): Add experimental user-callable logging methodsfeat(logs): Add experimental user-callable logging methodsFeb 20, 2025
colin-sentry
colin-sentry
commented
Feb 20, 2025
View reviewed changes
Comment threadpackages/core/src/log.ts
Outdated

@AbhiPrasadAbhiPrasad
mentioned this pull request
Feb 20, 2025
 Closed

k-fish
k-fish
reviewed
Feb 20, 2025
View reviewed changes
Comment threadpackages/core/src/log.ts

Comment on lines

+17
 to 
+23

 trace: 1,
 log: 2,
 debug: 5,
 info: 9,
 warn: 13,
 error: 17,
 fatal: 21,
@k-fishk-fishFeb 20, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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


Suggested change

trace: 1,
log: 2,
debug: 5,
info: 9,
warn: 13,
error: 17,
fatal: 21,
trace: 1,
debug: 5,
info: 9,
log: 10,
warn: 13,
error: 17,
fatal: 21,
@timfish
timfish
commented
Feb 25, 2025•

edited

Loading

Copy link


Copy Markdown

Collaborator
It's strange how this impacts bundle size. I would have expected the additional code to tree-shake out when it's not used!
Why is the _experiments.enableLogs option required? If users don't log anything via the new experimental API, logs wont be sent.
@AbhiPrasad
AbhiPrasad
commented
Feb 26, 2025

Copy link


Copy Markdown

Contributor
It's strange how this impacts bundle size. I would have expected the additional code to tree-shake out when it's not used!
Yeah that feels weird to me too. I wonder if it's because of the log buffer side effect.
Why is the _experiments.enableLogs option required? If users don't log anything via the new experimental API, logs wont be sent.
Because we'll eventually also forward the console calls as logs, and that will be gated by _experiments.enableLogs. This experimental option will also graduate to be a top-level option, but we're bikeshedding naming because logs is super overloaded 😄
colin-sentry
colin-sentry
commented
Mar 4, 2025
View reviewed changes
Comment threadpackages/core/src/log.ts
Outdated

lforst
lforst
reviewed
Mar 5, 2025
View reviewed changes
Comment threadpackages/core/src/exports.ts
 * fatal(fmt`user ${username} just bought ${item}!`);
 * ```
 */
 fatal: sendLog('fatal'),
@lforstlforstMar 5, 2025

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.

This is the side-effect y'all are probably looking for.
@AbhiPrasadAbhiPrasad
mentioned this pull request
Mar 5, 2025
 Closed

@k-fish
k-fish
commented
Mar 5, 2025

Copy link


Copy Markdown

Member
@AbhiPrasad we have to change the typing on the parametrize values to allow all the possible js types, do we want to change it or just make another function?
@k-fish
k-fish
commented
Mar 5, 2025

Copy link


Copy Markdown

Member
@AbhiPrasad this #15600 maybe?
@HofmannZ
HofmannZ
commented
Mar 6, 2025

Copy link


Copy Markdown

How does this integrate with loggers like pino?
@AbhiPrasad
AbhiPrasad
commented
Mar 6, 2025

Copy link


Copy Markdown

Contributor
How does this integrate with loggers like pino?
For now the focus is on frontend logging, but we'll have integrations for popular logging frameworks. You can see getsentry/sentry-docs#12920 for more details how SDKs will work with logging frameworks.
@AbhiPrasadAbhiPrasad
mentioned this pull request
Mar 6, 2025
 Closed

@joshdales
joshdales
commented
Mar 7, 2025•

edited

Loading

Copy link


Copy Markdown

Is there a reason that this couldn't be added to the Angular package as well?
Would be very nice if it could please 🥺
@AbhiPrasad
AbhiPrasad
commented
Mar 11, 2025

Copy link


Copy Markdown

Contributor
@joshdales the angular package re-exports everything from the browser sdk, so this is included there.
The plan is that all JavaScript SDKs will have support for logs as soon as we're ready for users to use it :)
@joshdales
joshdales
commented
Mar 11, 2025

Copy link


Copy Markdown

@AbhiPrasad thanks for the context, as it wasn't included in the release notes I wasn't aware. Very excited to try this out 😄
@AbhiPrasad
AbhiPrasad
commented
Mar 26, 2025

Copy link


Copy Markdown

Contributor
This can be closed, we split this PR up into multiple steps and merged it in accordingly: #15526
@AbhiPrasad
AbhiPrasad
deleted the

colin/log-api

branch
March 26, 2025 15:48
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@k-fishk-fishk-fish left review comments
@stephanie-andersonstephanie-andersonstephanie-anderson left review comments
@AbhiPrasadAbhiPrasadAwaiting requested review from AbhiPrasad

+1 more reviewer

@lforstlforstlforst left review comments
Reviewers whose approvals may not affect merge requirements

Assignees

@AbhiPrasadAbhiPrasad

Labels


None yet


Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

8 participants

@colin-sentry@timfish@AbhiPrasad@k-fish@HofmannZ@joshdales@stephanie-anderson@lforst

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Strip utm_, fbclid, gclid, etc. from all links on page
(function() {
var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',
'ref', 'ref_src', 'source', 'medium', 'campaign'];
function cleanUrl(url) {
try {
var u = new URL(url, window.location.origin);
var changed = false;
trackingParams.forEach(function(p) {
if (u.searchParams.has(p)) {
u.searchParams.delete(p);
changed = true;
}
});
return changed ? u.toString() : url;
} catch (e) {
return url;
}
}
function cleanLinks() {
document.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
cleanLinks();
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1) {
if (node.tagName === 'A') cleanLinks();
node.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '
feat(logs): Add experimental user-callable logging methods by colin-sentry · Pull Request #15442 · getsentry/sentry-javascript · GitHub
Skip to content
feat(logs): Add experimental user-callable logging methods - #15442
Closed
colin-sentry wants to merge 36 commits into
developfrom 
colin/log-api
Closed
feat(logs): Add experimental user-callable logging methods#15442
colin-sentry wants to merge 36 commits into
developfrom 
colin/log-api
Conversation
@colin-sentry
@colin-sentrycolin-sentry
commented
Feb 18, 2025•

edited by AbhiPrasad

Loading

Copy link


Copy Markdown

This PR adds logging APIs to the SDK. At the moment this is only exposed in @sentry/core and @sentry/browser.
Logging is gated by an experimental option, _experiments.enableLogs.
Sentry.init({_experiments: {enableLogs: true,},});
These API are exposed in the Sentry._experiment_log namespace.
On the high level, there are functions for each of the logging severity levels fatal, error, warn, info, debug, trace. There is also a log function that is an alias to info.
Sentry._experiment_log.info('Adding item to cart',{item: 'sneakers'});
If you want to do structured logging, you'll need to use the fmt helper exposed in the Sentry._experiment_log namespace.
const{ fmt }=Sentry._experiment_log;Sentry._experiment_log.info(fmt`user ${username} just bought ${item}!`);
There is a buffer of logs that flushes every 5 seconds, or when you hit 25 logs, whichever comes first.
Frame 1 (5)
@github-actions
github-actionsBot
commented
Feb 18, 2025•

edited

Loading

Copy link


Copy Markdown

Contributor
size-limit report 📦
PathSize% ChangeChange
@sentry/browser23.89 KB+3.19%+755 B 🔺
@sentry/browser - with treeshaking flags23.69 KB+3.27%+766 B 🔺
@sentry/browser (incl. Tracing)36.88 KB+1.87%+690 B 🔺
@sentry/browser (incl. Tracing, Replay)74.05 KB+0.91%+677 B 🔺
@sentry/browser (incl. Tracing, Replay) - with treeshaking flags67.48 KB+1.03%+698 B 🔺
@sentry/browser (incl. Tracing, Replay with Canvas)78.69 KB+0.88%+697 B 🔺
@sentry/browser (incl. Tracing, Replay, Feedback)91.23 KB+0.73%+675 B 🔺
⛔️ @sentry/browser (incl. Feedback) (max: 41.02 KB)41.03 KB+1.82%+749 B 🔺
@sentry/browser (incl. sendFeedback)28.52 KB+2.66%+756 B 🔺
@sentry/browser (incl. FeedbackAsync)33.31 KB+2.25%+750 B 🔺
@sentry/react25.67 KB+2.83%+722 B 🔺
@sentry/react (incl. Tracing)38.8 KB+1.85%+720 B 🔺
@sentry/vue28.11 KB+2.61%+731 B 🔺
⛔️ @sentry/vue (incl. Tracing) (max: 38.57 KB)38.61 KB+1.89%+731 B 🔺
@sentry/svelte23.92 KB+3.2%+758 B 🔺
CDN Bundle24.36 KB--
CDN Bundle (incl. Tracing)36.26 KB--
CDN Bundle (incl. Tracing, Replay)71.27 KB--
CDN Bundle (incl. Tracing, Replay, Feedback)76.44 KB--
CDN Bundle - uncompressed71.19 KB--
CDN Bundle (incl. Tracing) - uncompressed107.57 KB--
CDN Bundle (incl. Tracing, Replay) - uncompressed218.84 KB--
CDN Bundle (incl. Tracing, Replay, Feedback) - uncompressed231.4 KB--
@sentry/nextjs (client)39.94 KB+1.7%+683 B 🔺
@sentry/sveltekit (client)37.31 KB+1.88%+703 B 🔺
@sentry/node142.88 KB+0.52%+746 B 🔺
@sentry/node - without tracing96.32 KB+0.79%+767 B 🔺
@sentry/aws-serverless120.64 KB+0.6%+735 B 🔺
View base workflow run
stephanie-anderson
stephanie-anderson
reviewed
Feb 19, 2025
View reviewed changes
Comment threadpackages/core/src/ourlogs.ts
Outdated

stephanie-anderson
stephanie-anderson
reviewed
Feb 19, 2025
View reviewed changes
Comment threadpackages/core/src/types-hoist/envelope.ts
Outdated

stephanie-anderson
stephanie-anderson
reviewed
Feb 19, 2025
View reviewed changes
Comment threadpackages/core/src/utils-hoist/envelope.ts
 feedback: 'feedback',
 span: 'span',
 raw_security: 'security',
 otel_log: 'log_item',
@stephanie-andersonstephanie-andersonFeb 19, 2025

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.

Will there be any other type than otel_log? If not in the foreseeable future, I'd suggest we change it to

Suggested change

otel_log: 'log_item',
log: 'log',
Again singular, as in span, or replay
@AbhiPrasadAbhiPrasadFeb 20, 2025

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.

This is done because it matches the code in relay for data categories (rate limiting and client outcomes) https://github.com/getsentry/relay/blob/e36886a98c89af645e5c0d2109657deafa25d902/relay-server/src/envelope.rs#L182
@AbhiPrasadAbhiPrasad
self-assigned this
Feb 19, 2025
@codecov
codecovBot
commented
Feb 20, 2025•

edited

Loading

Copy link


Copy Markdown

❌ 1 Tests Failed:
Tests completedFailedPassedSkipped
464814647324
View the top 1 failed test(s) by shortest run time
shouldreportANRwheneventloopblockedworkercanbestoppedandrestarted
Stack Traces | 15s run time
Error: thrown: "Exceededtimeoutof15000msforatest.
Usejest.setTimeout(newTimeout) toincreasethetimeoutvalue, ifthisisalong-runningtest."
at .../suites/anr/test.ts:204:3at_dispatchDescribe (.../jest-circus/build/index.js:98:26)
atdescribe (.../jest-circus/build/index.js:60:5)
atObject.<anonymous> (.../suites/anr/test.ts:109:1)
atRuntime._execModule (.../jest-runtime/build/index.js:1646:24)
atRuntime._loadModule (.../jest-runtime/build/index.js:1185:12)
atRuntime.requireModule (.../jest-runtime/build/index.js:1009:12)
atjestAdapter (.../build/legacy-code-todo-rewrite/jestAdapter.js:79:13)
atprocessTicksAndRejections (node:internal/process/task_queues:105:5)
atrunTestInternal (.../jest-runner/build/runTest.js:389:16)
To view more test analytics, go to the Test Analytics Dashboard
📋 Got 3 mins? Take this short survey to help us improve Test Analytics.
@AbhiPrasadAbhiPrasad
changed the title
feat(ourlogs): Add experimental user-callable logging methodsfeat(logs): Add experimental user-callable logging methodsFeb 20, 2025
colin-sentry
colin-sentry
commented
Feb 20, 2025
View reviewed changes
Comment threadpackages/core/src/log.ts
Outdated

@AbhiPrasadAbhiPrasad
mentioned this pull request
Feb 20, 2025
 Closed

k-fish
k-fish
reviewed
Feb 20, 2025
View reviewed changes
Comment threadpackages/core/src/log.ts

Comment on lines

+17
 to 
+23

 trace: 1,
 log: 2,
 debug: 5,
 info: 9,
 warn: 13,
 error: 17,
 fatal: 21,
@k-fishk-fishFeb 20, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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


Suggested change

trace: 1,
log: 2,
debug: 5,
info: 9,
warn: 13,
error: 17,
fatal: 21,
trace: 1,
debug: 5,
info: 9,
log: 10,
warn: 13,
error: 17,
fatal: 21,
@timfish
timfish
commented
Feb 25, 2025•

edited

Loading

Copy link


Copy Markdown

Collaborator
It's strange how this impacts bundle size. I would have expected the additional code to tree-shake out when it's not used!
Why is the _experiments.enableLogs option required? If users don't log anything via the new experimental API, logs wont be sent.
@AbhiPrasad
AbhiPrasad
commented
Feb 26, 2025

Copy link


Copy Markdown

Contributor
It's strange how this impacts bundle size. I would have expected the additional code to tree-shake out when it's not used!
Yeah that feels weird to me too. I wonder if it's because of the log buffer side effect.
Why is the _experiments.enableLogs option required? If users don't log anything via the new experimental API, logs wont be sent.
Because we'll eventually also forward the console calls as logs, and that will be gated by _experiments.enableLogs. This experimental option will also graduate to be a top-level option, but we're bikeshedding naming because logs is super overloaded 😄
colin-sentry
colin-sentry
commented
Mar 4, 2025
View reviewed changes
Comment threadpackages/core/src/log.ts
Outdated

lforst
lforst
reviewed
Mar 5, 2025
View reviewed changes
Comment threadpackages/core/src/exports.ts
 * fatal(fmt`user ${username} just bought ${item}!`);
 * ```
 */
 fatal: sendLog('fatal'),
@lforstlforstMar 5, 2025

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.

This is the side-effect y'all are probably looking for.
@AbhiPrasadAbhiPrasad
mentioned this pull request
Mar 5, 2025
 Closed

@k-fish
k-fish
commented
Mar 5, 2025

Copy link


Copy Markdown

Member
@AbhiPrasad we have to change the typing on the parametrize values to allow all the possible js types, do we want to change it or just make another function?
@k-fish
k-fish
commented
Mar 5, 2025

Copy link


Copy Markdown

Member
@AbhiPrasad this #15600 maybe?
@HofmannZ
HofmannZ
commented
Mar 6, 2025

Copy link


Copy Markdown

How does this integrate with loggers like pino?
@AbhiPrasad
AbhiPrasad
commented
Mar 6, 2025

Copy link


Copy Markdown

Contributor
How does this integrate with loggers like pino?
For now the focus is on frontend logging, but we'll have integrations for popular logging frameworks. You can see getsentry/sentry-docs#12920 for more details how SDKs will work with logging frameworks.
@AbhiPrasadAbhiPrasad
mentioned this pull request
Mar 6, 2025
 Closed

@joshdales
joshdales
commented
Mar 7, 2025•

edited

Loading

Copy link


Copy Markdown

Is there a reason that this couldn't be added to the Angular package as well?
Would be very nice if it could please 🥺
@AbhiPrasad
AbhiPrasad
commented
Mar 11, 2025

Copy link


Copy Markdown

Contributor
@joshdales the angular package re-exports everything from the browser sdk, so this is included there.
The plan is that all JavaScript SDKs will have support for logs as soon as we're ready for users to use it :)
@joshdales
joshdales
commented
Mar 11, 2025

Copy link


Copy Markdown

@AbhiPrasad thanks for the context, as it wasn't included in the release notes I wasn't aware. Very excited to try this out 😄
@AbhiPrasad
AbhiPrasad
commented
Mar 26, 2025

Copy link


Copy Markdown

Contributor
This can be closed, we split this PR up into multiple steps and merged it in accordingly: #15526
@AbhiPrasad
AbhiPrasad
deleted the

colin/log-api

branch
March 26, 2025 15:48
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@k-fishk-fishk-fish left review comments
@stephanie-andersonstephanie-andersonstephanie-anderson left review comments
@AbhiPrasadAbhiPrasadAwaiting requested review from AbhiPrasad

+1 more reviewer

@lforstlforstlforst left review comments
Reviewers whose approvals may not affect merge requirements

Assignees

@AbhiPrasadAbhiPrasad

Labels


None yet


Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

8 participants

@colin-sentry@timfish@AbhiPrasad@k-fish@HofmannZ@joshdales@stephanie-anderson@lforst

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
feat(logs): Add experimental user-callable logging methods by colin-sentry · Pull Request #15442 · getsentry/sentry-javascript · GitHub
Skip to content
feat(logs): Add experimental user-callable logging methods - #15442
Closed
colin-sentry wants to merge 36 commits into
developfrom 
colin/log-api
Closed
feat(logs): Add experimental user-callable logging methods#15442
colin-sentry wants to merge 36 commits into
developfrom 
colin/log-api
Conversation
@colin-sentry
@colin-sentrycolin-sentry
commented
Feb 18, 2025•

edited by AbhiPrasad

Loading

Copy link


Copy Markdown

This PR adds logging APIs to the SDK. At the moment this is only exposed in @sentry/core and @sentry/browser.
Logging is gated by an experimental option, _experiments.enableLogs.
Sentry.init({_experiments: {enableLogs: true,},});
These API are exposed in the Sentry._experiment_log namespace.
On the high level, there are functions for each of the logging severity levels fatal, error, warn, info, debug, trace. There is also a log function that is an alias to info.
Sentry._experiment_log.info('Adding item to cart',{item: 'sneakers'});
If you want to do structured logging, you'll need to use the fmt helper exposed in the Sentry._experiment_log namespace.
const{ fmt }=Sentry._experiment_log;Sentry._experiment_log.info(fmt`user ${username} just bought ${item}!`);
There is a buffer of logs that flushes every 5 seconds, or when you hit 25 logs, whichever comes first.
Frame 1 (5)
@github-actions
github-actionsBot
commented
Feb 18, 2025•

edited

Loading

Copy link


Copy Markdown

Contributor
size-limit report 📦
PathSize% ChangeChange
@sentry/browser23.89 KB+3.19%+755 B 🔺
@sentry/browser - with treeshaking flags23.69 KB+3.27%+766 B 🔺
@sentry/browser (incl. Tracing)36.88 KB+1.87%+690 B 🔺
@sentry/browser (incl. Tracing, Replay)74.05 KB+0.91%+677 B 🔺
@sentry/browser (incl. Tracing, Replay) - with treeshaking flags67.48 KB+1.03%+698 B 🔺
@sentry/browser (incl. Tracing, Replay with Canvas)78.69 KB+0.88%+697 B 🔺
@sentry/browser (incl. Tracing, Replay, Feedback)91.23 KB+0.73%+675 B 🔺
⛔️ @sentry/browser (incl. Feedback) (max: 41.02 KB)41.03 KB+1.82%+749 B 🔺
@sentry/browser (incl. sendFeedback)28.52 KB+2.66%+756 B 🔺
@sentry/browser (incl. FeedbackAsync)33.31 KB+2.25%+750 B 🔺
@sentry/react25.67 KB+2.83%+722 B 🔺
@sentry/react (incl. Tracing)38.8 KB+1.85%+720 B 🔺
@sentry/vue28.11 KB+2.61%+731 B 🔺
⛔️ @sentry/vue (incl. Tracing) (max: 38.57 KB)38.61 KB+1.89%+731 B 🔺
@sentry/svelte23.92 KB+3.2%+758 B 🔺
CDN Bundle24.36 KB--
CDN Bundle (incl. Tracing)36.26 KB--
CDN Bundle (incl. Tracing, Replay)71.27 KB--
CDN Bundle (incl. Tracing, Replay, Feedback)76.44 KB--
CDN Bundle - uncompressed71.19 KB--
CDN Bundle (incl. Tracing) - uncompressed107.57 KB--
CDN Bundle (incl. Tracing, Replay) - uncompressed218.84 KB--
CDN Bundle (incl. Tracing, Replay, Feedback) - uncompressed231.4 KB--
@sentry/nextjs (client)39.94 KB+1.7%+683 B 🔺
@sentry/sveltekit (client)37.31 KB+1.88%+703 B 🔺
@sentry/node142.88 KB+0.52%+746 B 🔺
@sentry/node - without tracing96.32 KB+0.79%+767 B 🔺
@sentry/aws-serverless120.64 KB+0.6%+735 B 🔺
View base workflow run
stephanie-anderson
stephanie-anderson
reviewed
Feb 19, 2025
View reviewed changes
Comment threadpackages/core/src/ourlogs.ts
Outdated

stephanie-anderson
stephanie-anderson
reviewed
Feb 19, 2025
View reviewed changes
Comment threadpackages/core/src/types-hoist/envelope.ts
Outdated

stephanie-anderson
stephanie-anderson
reviewed
Feb 19, 2025
View reviewed changes
Comment threadpackages/core/src/utils-hoist/envelope.ts
 feedback: 'feedback',
 span: 'span',
 raw_security: 'security',
 otel_log: 'log_item',
@stephanie-andersonstephanie-andersonFeb 19, 2025

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.

Will there be any other type than otel_log? If not in the foreseeable future, I'd suggest we change it to

Suggested change

otel_log: 'log_item',
log: 'log',
Again singular, as in span, or replay
@AbhiPrasadAbhiPrasadFeb 20, 2025

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.

This is done because it matches the code in relay for data categories (rate limiting and client outcomes) https://github.com/getsentry/relay/blob/e36886a98c89af645e5c0d2109657deafa25d902/relay-server/src/envelope.rs#L182
@AbhiPrasadAbhiPrasad
self-assigned this
Feb 19, 2025
@codecov
codecovBot
commented
Feb 20, 2025•

edited

Loading

Copy link


Copy Markdown

❌ 1 Tests Failed:
Tests completedFailedPassedSkipped
464814647324
View the top 1 failed test(s) by shortest run time
shouldreportANRwheneventloopblockedworkercanbestoppedandrestarted
Stack Traces | 15s run time
Error: thrown: "Exceededtimeoutof15000msforatest.
Usejest.setTimeout(newTimeout) toincreasethetimeoutvalue, ifthisisalong-runningtest."
at .../suites/anr/test.ts:204:3at_dispatchDescribe (.../jest-circus/build/index.js:98:26)
atdescribe (.../jest-circus/build/index.js:60:5)
atObject.<anonymous> (.../suites/anr/test.ts:109:1)
atRuntime._execModule (.../jest-runtime/build/index.js:1646:24)
atRuntime._loadModule (.../jest-runtime/build/index.js:1185:12)
atRuntime.requireModule (.../jest-runtime/build/index.js:1009:12)
atjestAdapter (.../build/legacy-code-todo-rewrite/jestAdapter.js:79:13)
atprocessTicksAndRejections (node:internal/process/task_queues:105:5)
atrunTestInternal (.../jest-runner/build/runTest.js:389:16)
To view more test analytics, go to the Test Analytics Dashboard
📋 Got 3 mins? Take this short survey to help us improve Test Analytics.
@AbhiPrasadAbhiPrasad
changed the title
feat(ourlogs): Add experimental user-callable logging methodsfeat(logs): Add experimental user-callable logging methodsFeb 20, 2025
colin-sentry
colin-sentry
commented
Feb 20, 2025
View reviewed changes
Comment threadpackages/core/src/log.ts
Outdated

@AbhiPrasadAbhiPrasad
mentioned this pull request
Feb 20, 2025
 Closed

k-fish
k-fish
reviewed
Feb 20, 2025
View reviewed changes
Comment threadpackages/core/src/log.ts

Comment on lines

+17
 to 
+23

 trace: 1,
 log: 2,
 debug: 5,
 info: 9,
 warn: 13,
 error: 17,
 fatal: 21,
@k-fishk-fishFeb 20, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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


Suggested change

trace: 1,
log: 2,
debug: 5,
info: 9,
warn: 13,
error: 17,
fatal: 21,
trace: 1,
debug: 5,
info: 9,
log: 10,
warn: 13,
error: 17,
fatal: 21,
@timfish
timfish
commented
Feb 25, 2025•

edited

Loading

Copy link


Copy Markdown

Collaborator
It's strange how this impacts bundle size. I would have expected the additional code to tree-shake out when it's not used!
Why is the _experiments.enableLogs option required? If users don't log anything via the new experimental API, logs wont be sent.
@AbhiPrasad
AbhiPrasad
commented
Feb 26, 2025

Copy link


Copy Markdown

Contributor
It's strange how this impacts bundle size. I would have expected the additional code to tree-shake out when it's not used!
Yeah that feels weird to me too. I wonder if it's because of the log buffer side effect.
Why is the _experiments.enableLogs option required? If users don't log anything via the new experimental API, logs wont be sent.
Because we'll eventually also forward the console calls as logs, and that will be gated by _experiments.enableLogs. This experimental option will also graduate to be a top-level option, but we're bikeshedding naming because logs is super overloaded 😄
colin-sentry
colin-sentry
commented
Mar 4, 2025
View reviewed changes
Comment threadpackages/core/src/log.ts
Outdated

lforst
lforst
reviewed
Mar 5, 2025
View reviewed changes
Comment threadpackages/core/src/exports.ts
 * fatal(fmt`user ${username} just bought ${item}!`);
 * ```
 */
 fatal: sendLog('fatal'),
@lforstlforstMar 5, 2025

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.

This is the side-effect y'all are probably looking for.
@AbhiPrasadAbhiPrasad
mentioned this pull request
Mar 5, 2025
 Closed

@k-fish
k-fish
commented
Mar 5, 2025

Copy link


Copy Markdown

Member
@AbhiPrasad we have to change the typing on the parametrize values to allow all the possible js types, do we want to change it or just make another function?
@k-fish
k-fish
commented
Mar 5, 2025

Copy link


Copy Markdown

Member
@AbhiPrasad this #15600 maybe?
@HofmannZ
HofmannZ
commented
Mar 6, 2025

Copy link


Copy Markdown

How does this integrate with loggers like pino?
@AbhiPrasad
AbhiPrasad
commented
Mar 6, 2025

Copy link


Copy Markdown

Contributor
How does this integrate with loggers like pino?
For now the focus is on frontend logging, but we'll have integrations for popular logging frameworks. You can see getsentry/sentry-docs#12920 for more details how SDKs will work with logging frameworks.
@AbhiPrasadAbhiPrasad
mentioned this pull request
Mar 6, 2025
 Closed

@joshdales
joshdales
commented
Mar 7, 2025•

edited

Loading

Copy link


Copy Markdown

Is there a reason that this couldn't be added to the Angular package as well?
Would be very nice if it could please 🥺
@AbhiPrasad
AbhiPrasad
commented
Mar 11, 2025

Copy link


Copy Markdown

Contributor
@joshdales the angular package re-exports everything from the browser sdk, so this is included there.
The plan is that all JavaScript SDKs will have support for logs as soon as we're ready for users to use it :)
@joshdales
joshdales
commented
Mar 11, 2025

Copy link


Copy Markdown

@AbhiPrasad thanks for the context, as it wasn't included in the release notes I wasn't aware. Very excited to try this out 😄
@AbhiPrasad
AbhiPrasad
commented
Mar 26, 2025

Copy link


Copy Markdown

Contributor
This can be closed, we split this PR up into multiple steps and merged it in accordingly: #15526
@AbhiPrasad
AbhiPrasad
deleted the

colin/log-api

branch
March 26, 2025 15:48
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@k-fishk-fishk-fish left review comments
@stephanie-andersonstephanie-andersonstephanie-anderson left review comments
@AbhiPrasadAbhiPrasadAwaiting requested review from AbhiPrasad

+1 more reviewer

@lforstlforstlforst left review comments
Reviewers whose approvals may not affect merge requirements

Assignees

@AbhiPrasadAbhiPrasad

Labels


None yet


Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

8 participants

@colin-sentry@timfish@AbhiPrasad@k-fish@HofmannZ@joshdales@stephanie-anderson@lforst

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
feat(logs): Add experimental user-callable logging methods by colin-sentry · Pull Request #15442 · getsentry/sentry-javascript · GitHub
Skip to content
feat(logs): Add experimental user-callable logging methods - #15442
Closed
colin-sentry wants to merge 36 commits into
developfrom 
colin/log-api
Closed
feat(logs): Add experimental user-callable logging methods#15442
colin-sentry wants to merge 36 commits into
developfrom 
colin/log-api
Conversation
@colin-sentry
@colin-sentrycolin-sentry
commented
Feb 18, 2025•

edited by AbhiPrasad

Loading

Copy link


Copy Markdown

This PR adds logging APIs to the SDK. At the moment this is only exposed in @sentry/core and @sentry/browser.
Logging is gated by an experimental option, _experiments.enableLogs.
Sentry.init({_experiments: {enableLogs: true,},});
These API are exposed in the Sentry._experiment_log namespace.
On the high level, there are functions for each of the logging severity levels fatal, error, warn, info, debug, trace. There is also a log function that is an alias to info.
Sentry._experiment_log.info('Adding item to cart',{item: 'sneakers'});
If you want to do structured logging, you'll need to use the fmt helper exposed in the Sentry._experiment_log namespace.
const{ fmt }=Sentry._experiment_log;Sentry._experiment_log.info(fmt`user ${username} just bought ${item}!`);
There is a buffer of logs that flushes every 5 seconds, or when you hit 25 logs, whichever comes first.
Frame 1 (5)
@github-actions
github-actionsBot
commented
Feb 18, 2025•

edited

Loading

Copy link


Copy Markdown

Contributor
size-limit report 📦
PathSize% ChangeChange
@sentry/browser23.89 KB+3.19%+755 B 🔺
@sentry/browser - with treeshaking flags23.69 KB+3.27%+766 B 🔺
@sentry/browser (incl. Tracing)36.88 KB+1.87%+690 B 🔺
@sentry/browser (incl. Tracing, Replay)74.05 KB+0.91%+677 B 🔺
@sentry/browser (incl. Tracing, Replay) - with treeshaking flags67.48 KB+1.03%+698 B 🔺
@sentry/browser (incl. Tracing, Replay with Canvas)78.69 KB+0.88%+697 B 🔺
@sentry/browser (incl. Tracing, Replay, Feedback)91.23 KB+0.73%+675 B 🔺
⛔️ @sentry/browser (incl. Feedback) (max: 41.02 KB)41.03 KB+1.82%+749 B 🔺
@sentry/browser (incl. sendFeedback)28.52 KB+2.66%+756 B 🔺
@sentry/browser (incl. FeedbackAsync)33.31 KB+2.25%+750 B 🔺
@sentry/react25.67 KB+2.83%+722 B 🔺
@sentry/react (incl. Tracing)38.8 KB+1.85%+720 B 🔺
@sentry/vue28.11 KB+2.61%+731 B 🔺
⛔️ @sentry/vue (incl. Tracing) (max: 38.57 KB)38.61 KB+1.89%+731 B 🔺
@sentry/svelte23.92 KB+3.2%+758 B 🔺
CDN Bundle24.36 KB--
CDN Bundle (incl. Tracing)36.26 KB--
CDN Bundle (incl. Tracing, Replay)71.27 KB--
CDN Bundle (incl. Tracing, Replay, Feedback)76.44 KB--
CDN Bundle - uncompressed71.19 KB--
CDN Bundle (incl. Tracing) - uncompressed107.57 KB--
CDN Bundle (incl. Tracing, Replay) - uncompressed218.84 KB--
CDN Bundle (incl. Tracing, Replay, Feedback) - uncompressed231.4 KB--
@sentry/nextjs (client)39.94 KB+1.7%+683 B 🔺
@sentry/sveltekit (client)37.31 KB+1.88%+703 B 🔺
@sentry/node142.88 KB+0.52%+746 B 🔺
@sentry/node - without tracing96.32 KB+0.79%+767 B 🔺
@sentry/aws-serverless120.64 KB+0.6%+735 B 🔺
View base workflow run
stephanie-anderson
stephanie-anderson
reviewed
Feb 19, 2025
View reviewed changes
Comment threadpackages/core/src/ourlogs.ts
Outdated

stephanie-anderson
stephanie-anderson
reviewed
Feb 19, 2025
View reviewed changes
Comment threadpackages/core/src/types-hoist/envelope.ts
Outdated

stephanie-anderson
stephanie-anderson
reviewed
Feb 19, 2025
View reviewed changes
Comment threadpackages/core/src/utils-hoist/envelope.ts
 feedback: 'feedback',
 span: 'span',
 raw_security: 'security',
 otel_log: 'log_item',
@stephanie-andersonstephanie-andersonFeb 19, 2025

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.

Will there be any other type than otel_log? If not in the foreseeable future, I'd suggest we change it to

Suggested change

otel_log: 'log_item',
log: 'log',
Again singular, as in span, or replay
@AbhiPrasadAbhiPrasadFeb 20, 2025

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.

This is done because it matches the code in relay for data categories (rate limiting and client outcomes) https://github.com/getsentry/relay/blob/e36886a98c89af645e5c0d2109657deafa25d902/relay-server/src/envelope.rs#L182
@AbhiPrasadAbhiPrasad
self-assigned this
Feb 19, 2025
@codecov
codecovBot
commented
Feb 20, 2025•

edited

Loading

Copy link


Copy Markdown

❌ 1 Tests Failed:
Tests completedFailedPassedSkipped
464814647324
View the top 1 failed test(s) by shortest run time
shouldreportANRwheneventloopblockedworkercanbestoppedandrestarted
Stack Traces | 15s run time
Error: thrown: "Exceededtimeoutof15000msforatest.
Usejest.setTimeout(newTimeout) toincreasethetimeoutvalue, ifthisisalong-runningtest."
at .../suites/anr/test.ts:204:3at_dispatchDescribe (.../jest-circus/build/index.js:98:26)
atdescribe (.../jest-circus/build/index.js:60:5)
atObject.<anonymous> (.../suites/anr/test.ts:109:1)
atRuntime._execModule (.../jest-runtime/build/index.js:1646:24)
atRuntime._loadModule (.../jest-runtime/build/index.js:1185:12)
atRuntime.requireModule (.../jest-runtime/build/index.js:1009:12)
atjestAdapter (.../build/legacy-code-todo-rewrite/jestAdapter.js:79:13)
atprocessTicksAndRejections (node:internal/process/task_queues:105:5)
atrunTestInternal (.../jest-runner/build/runTest.js:389:16)
To view more test analytics, go to the Test Analytics Dashboard
📋 Got 3 mins? Take this short survey to help us improve Test Analytics.
@AbhiPrasadAbhiPrasad
changed the title
feat(ourlogs): Add experimental user-callable logging methodsfeat(logs): Add experimental user-callable logging methodsFeb 20, 2025
colin-sentry
colin-sentry
commented
Feb 20, 2025
View reviewed changes
Comment threadpackages/core/src/log.ts
Outdated

@AbhiPrasadAbhiPrasad
mentioned this pull request
Feb 20, 2025
 Closed

k-fish
k-fish
reviewed
Feb 20, 2025
View reviewed changes
Comment threadpackages/core/src/log.ts

Comment on lines

+17
 to 
+23

 trace: 1,
 log: 2,
 debug: 5,
 info: 9,
 warn: 13,
 error: 17,
 fatal: 21,
@k-fishk-fishFeb 20, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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


Suggested change

trace: 1,
log: 2,
debug: 5,
info: 9,
warn: 13,
error: 17,
fatal: 21,
trace: 1,
debug: 5,
info: 9,
log: 10,
warn: 13,
error: 17,
fatal: 21,
@timfish
timfish
commented
Feb 25, 2025•

edited

Loading

Copy link


Copy Markdown

Collaborator
It's strange how this impacts bundle size. I would have expected the additional code to tree-shake out when it's not used!
Why is the _experiments.enableLogs option required? If users don't log anything via the new experimental API, logs wont be sent.
@AbhiPrasad
AbhiPrasad
commented
Feb 26, 2025

Copy link


Copy Markdown

Contributor
It's strange how this impacts bundle size. I would have expected the additional code to tree-shake out when it's not used!
Yeah that feels weird to me too. I wonder if it's because of the log buffer side effect.
Why is the _experiments.enableLogs option required? If users don't log anything via the new experimental API, logs wont be sent.
Because we'll eventually also forward the console calls as logs, and that will be gated by _experiments.enableLogs. This experimental option will also graduate to be a top-level option, but we're bikeshedding naming because logs is super overloaded 😄
colin-sentry
colin-sentry
commented
Mar 4, 2025
View reviewed changes
Comment threadpackages/core/src/log.ts
Outdated

lforst
lforst
reviewed
Mar 5, 2025
View reviewed changes
Comment threadpackages/core/src/exports.ts
 * fatal(fmt`user ${username} just bought ${item}!`);
 * ```
 */
 fatal: sendLog('fatal'),
@lforstlforstMar 5, 2025

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.

This is the side-effect y'all are probably looking for.
@AbhiPrasadAbhiPrasad
mentioned this pull request
Mar 5, 2025
 Closed

@k-fish
k-fish
commented
Mar 5, 2025

Copy link


Copy Markdown

Member
@AbhiPrasad we have to change the typing on the parametrize values to allow all the possible js types, do we want to change it or just make another function?
@k-fish
k-fish
commented
Mar 5, 2025

Copy link


Copy Markdown

Member
@AbhiPrasad this #15600 maybe?
@HofmannZ
HofmannZ
commented
Mar 6, 2025

Copy link


Copy Markdown

How does this integrate with loggers like pino?
@AbhiPrasad
AbhiPrasad
commented
Mar 6, 2025

Copy link


Copy Markdown

Contributor
How does this integrate with loggers like pino?
For now the focus is on frontend logging, but we'll have integrations for popular logging frameworks. You can see getsentry/sentry-docs#12920 for more details how SDKs will work with logging frameworks.
@AbhiPrasadAbhiPrasad
mentioned this pull request
Mar 6, 2025
 Closed

@joshdales
joshdales
commented
Mar 7, 2025•

edited

Loading

Copy link


Copy Markdown

Is there a reason that this couldn't be added to the Angular package as well?
Would be very nice if it could please 🥺
@AbhiPrasad
AbhiPrasad
commented
Mar 11, 2025

Copy link


Copy Markdown

Contributor
@joshdales the angular package re-exports everything from the browser sdk, so this is included there.
The plan is that all JavaScript SDKs will have support for logs as soon as we're ready for users to use it :)
@joshdales
joshdales
commented
Mar 11, 2025

Copy link


Copy Markdown

@AbhiPrasad thanks for the context, as it wasn't included in the release notes I wasn't aware. Very excited to try this out 😄
@AbhiPrasad
AbhiPrasad
commented
Mar 26, 2025

Copy link


Copy Markdown

Contributor
This can be closed, we split this PR up into multiple steps and merged it in accordingly: #15526
@AbhiPrasad
AbhiPrasad
deleted the

colin/log-api

branch
March 26, 2025 15:48
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@k-fishk-fishk-fish left review comments
@stephanie-andersonstephanie-andersonstephanie-anderson left review comments
@AbhiPrasadAbhiPrasadAwaiting requested review from AbhiPrasad

+1 more reviewer

@lforstlforstlforst left review comments
Reviewers whose approvals may not affect merge requirements

Assignees

@AbhiPrasadAbhiPrasad

Labels


None yet


Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

8 participants

@colin-sentry@timfish@AbhiPrasad@k-fish@HofmannZ@joshdales@stephanie-anderson@lforst

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Universal Dark Mode - works on any site
(function() {
var enabled = true;
function applyDarkMode() {
if (!enabled) return;
// Create style element if it doesn't exist
var style = document.getElementById('universal-dark-mode-style');
if (!style) {
style = document.createElement('style');
style.id = 'universal-dark-mode-style';
document.head.appendChild(style);
}
// Dark mode CSS - inverts colors but preserves images/video
style.textContent = '
/* Invert everything except media */
html {
filter: invert(1) hue-rotate(180deg) !important;
background: #1a1a2e !important;
}
/* Restore images, videos, iframes, canvas */
img, video, iframe, canvas, svg, picture, [style*="background-image"] {
filter: invert(1) hue-rotate(180deg) !important;
}
/* Preserve specific elements that should not be inverted */
.no-dark-mode, .no-dark-mode *,
[data-theme="light"], [data-theme="light"],
.ace_editor, .ace_editor *,
.CodeMirror, .CodeMirror *,
.monaco-editor, .monaco-editor *,
.markdown-body pre, .markdown-body pre *,
.highlight, .highlight *,
pre code, pre code * {
filter: none !important;
}
/* Fix common UI elements */
.modal, .popup, .dropdown-menu, .tooltip, .popover {
filter: invert(1) hue-rotate(180deg) !important;
background: #2d2d44 !important;
border-color: #444 !important;
}
/* Scrollbars */
::-webkit-scrollbar { background: #1a1a2e !important; }
::-webkit-scrollbar-thumb { background: #444 !important; }
::-webkit-scrollbar-thumb:hover { background: #555 !important; }
/* Selection */
::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
';
}
function removeDarkMode() {
var style = document.getElementById('universal-dark-mode-style');
if (style) style.remove();
}
// Toggle with Alt+Shift+D
document.addEventListener('keydown', function(e) {
if (e.altKey && e.shiftKey && e.key === 'D') {
e.preventDefault();
enabled = !enabled;
if (enabled) {
applyDarkMode();
console.log('[Universal Dark Mode] Enabled');
} else {
removeDarkMode();
console.log('[Universal Dark Mode] Disabled');
}
}
});
// Apply on load
applyDarkMode();
// Re-apply on dynamic content
var observer = new MutationObserver(function(mutations) {
if (enabled && !document.getElementById('universal-dark-mode-style')) {
applyDarkMode();
}
});
observer.observe(document.head, { childList: true });
console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');
})();
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();
feat(logs): Add experimental user-callable logging methods by colin-sentry · Pull Request #15442 · getsentry/sentry-javascript · GitHub
Skip to content
feat(logs): Add experimental user-callable logging methods - #15442
Closed
colin-sentry wants to merge 36 commits into
developfrom 
colin/log-api
Closed
feat(logs): Add experimental user-callable logging methods#15442
colin-sentry wants to merge 36 commits into
developfrom 
colin/log-api
Conversation
@colin-sentry
@colin-sentrycolin-sentry
commented
Feb 18, 2025•

edited by AbhiPrasad

Loading

Copy link


Copy Markdown

This PR adds logging APIs to the SDK. At the moment this is only exposed in @sentry/core and @sentry/browser.
Logging is gated by an experimental option, _experiments.enableLogs.
Sentry.init({_experiments: {enableLogs: true,},});
These API are exposed in the Sentry._experiment_log namespace.
On the high level, there are functions for each of the logging severity levels fatal, error, warn, info, debug, trace. There is also a log function that is an alias to info.
Sentry._experiment_log.info('Adding item to cart',{item: 'sneakers'});
If you want to do structured logging, you'll need to use the fmt helper exposed in the Sentry._experiment_log namespace.
const{ fmt }=Sentry._experiment_log;Sentry._experiment_log.info(fmt`user ${username} just bought ${item}!`);
There is a buffer of logs that flushes every 5 seconds, or when you hit 25 logs, whichever comes first.
Frame 1 (5)
@github-actions
github-actionsBot
commented
Feb 18, 2025•

edited

Loading

Copy link


Copy Markdown

Contributor
size-limit report 📦
PathSize% ChangeChange
@sentry/browser23.89 KB+3.19%+755 B 🔺
@sentry/browser - with treeshaking flags23.69 KB+3.27%+766 B 🔺
@sentry/browser (incl. Tracing)36.88 KB+1.87%+690 B 🔺
@sentry/browser (incl. Tracing, Replay)74.05 KB+0.91%+677 B 🔺
@sentry/browser (incl. Tracing, Replay) - with treeshaking flags67.48 KB+1.03%+698 B 🔺
@sentry/browser (incl. Tracing, Replay with Canvas)78.69 KB+0.88%+697 B 🔺
@sentry/browser (incl. Tracing, Replay, Feedback)91.23 KB+0.73%+675 B 🔺
⛔️ @sentry/browser (incl. Feedback) (max: 41.02 KB)41.03 KB+1.82%+749 B 🔺
@sentry/browser (incl. sendFeedback)28.52 KB+2.66%+756 B 🔺
@sentry/browser (incl. FeedbackAsync)33.31 KB+2.25%+750 B 🔺
@sentry/react25.67 KB+2.83%+722 B 🔺
@sentry/react (incl. Tracing)38.8 KB+1.85%+720 B 🔺
@sentry/vue28.11 KB+2.61%+731 B 🔺
⛔️ @sentry/vue (incl. Tracing) (max: 38.57 KB)38.61 KB+1.89%+731 B 🔺
@sentry/svelte23.92 KB+3.2%+758 B 🔺
CDN Bundle24.36 KB--
CDN Bundle (incl. Tracing)36.26 KB--
CDN Bundle (incl. Tracing, Replay)71.27 KB--
CDN Bundle (incl. Tracing, Replay, Feedback)76.44 KB--
CDN Bundle - uncompressed71.19 KB--
CDN Bundle (incl. Tracing) - uncompressed107.57 KB--
CDN Bundle (incl. Tracing, Replay) - uncompressed218.84 KB--
CDN Bundle (incl. Tracing, Replay, Feedback) - uncompressed231.4 KB--
@sentry/nextjs (client)39.94 KB+1.7%+683 B 🔺
@sentry/sveltekit (client)37.31 KB+1.88%+703 B 🔺
@sentry/node142.88 KB+0.52%+746 B 🔺
@sentry/node - without tracing96.32 KB+0.79%+767 B 🔺
@sentry/aws-serverless120.64 KB+0.6%+735 B 🔺
View base workflow run
stephanie-anderson
stephanie-anderson
reviewed
Feb 19, 2025
View reviewed changes
Comment threadpackages/core/src/ourlogs.ts
Outdated

stephanie-anderson
stephanie-anderson
reviewed
Feb 19, 2025
View reviewed changes
Comment threadpackages/core/src/types-hoist/envelope.ts
Outdated

stephanie-anderson
stephanie-anderson
reviewed
Feb 19, 2025
View reviewed changes
Comment threadpackages/core/src/utils-hoist/envelope.ts
 feedback: 'feedback',
 span: 'span',
 raw_security: 'security',
 otel_log: 'log_item',
@stephanie-andersonstephanie-andersonFeb 19, 2025

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.

Will there be any other type than otel_log? If not in the foreseeable future, I'd suggest we change it to

Suggested change

otel_log: 'log_item',
log: 'log',
Again singular, as in span, or replay
@AbhiPrasadAbhiPrasadFeb 20, 2025

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.

This is done because it matches the code in relay for data categories (rate limiting and client outcomes) https://github.com/getsentry/relay/blob/e36886a98c89af645e5c0d2109657deafa25d902/relay-server/src/envelope.rs#L182
@AbhiPrasadAbhiPrasad
self-assigned this
Feb 19, 2025
@codecov
codecovBot
commented
Feb 20, 2025•

edited

Loading

Copy link


Copy Markdown

❌ 1 Tests Failed:
Tests completedFailedPassedSkipped
464814647324
View the top 1 failed test(s) by shortest run time
shouldreportANRwheneventloopblockedworkercanbestoppedandrestarted
Stack Traces | 15s run time
Error: thrown: "Exceededtimeoutof15000msforatest.
Usejest.setTimeout(newTimeout) toincreasethetimeoutvalue, ifthisisalong-runningtest."
at .../suites/anr/test.ts:204:3at_dispatchDescribe (.../jest-circus/build/index.js:98:26)
atdescribe (.../jest-circus/build/index.js:60:5)
atObject.<anonymous> (.../suites/anr/test.ts:109:1)
atRuntime._execModule (.../jest-runtime/build/index.js:1646:24)
atRuntime._loadModule (.../jest-runtime/build/index.js:1185:12)
atRuntime.requireModule (.../jest-runtime/build/index.js:1009:12)
atjestAdapter (.../build/legacy-code-todo-rewrite/jestAdapter.js:79:13)
atprocessTicksAndRejections (node:internal/process/task_queues:105:5)
atrunTestInternal (.../jest-runner/build/runTest.js:389:16)
To view more test analytics, go to the Test Analytics Dashboard
📋 Got 3 mins? Take this short survey to help us improve Test Analytics.
@AbhiPrasadAbhiPrasad
changed the title
feat(ourlogs): Add experimental user-callable logging methodsfeat(logs): Add experimental user-callable logging methodsFeb 20, 2025
colin-sentry
colin-sentry
commented
Feb 20, 2025
View reviewed changes
Comment threadpackages/core/src/log.ts
Outdated

@AbhiPrasadAbhiPrasad
mentioned this pull request
Feb 20, 2025
 Closed

k-fish
k-fish
reviewed
Feb 20, 2025
View reviewed changes
Comment threadpackages/core/src/log.ts

Comment on lines

+17
 to 
+23

 trace: 1,
 log: 2,
 debug: 5,
 info: 9,
 warn: 13,
 error: 17,
 fatal: 21,
@k-fishk-fishFeb 20, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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


Suggested change

trace: 1,
log: 2,
debug: 5,
info: 9,
warn: 13,
error: 17,
fatal: 21,
trace: 1,
debug: 5,
info: 9,
log: 10,
warn: 13,
error: 17,
fatal: 21,
@timfish
timfish
commented
Feb 25, 2025•

edited

Loading

Copy link


Copy Markdown

Collaborator
It's strange how this impacts bundle size. I would have expected the additional code to tree-shake out when it's not used!
Why is the _experiments.enableLogs option required? If users don't log anything via the new experimental API, logs wont be sent.
@AbhiPrasad
AbhiPrasad
commented
Feb 26, 2025

Copy link


Copy Markdown

Contributor
It's strange how this impacts bundle size. I would have expected the additional code to tree-shake out when it's not used!
Yeah that feels weird to me too. I wonder if it's because of the log buffer side effect.
Why is the _experiments.enableLogs option required? If users don't log anything via the new experimental API, logs wont be sent.
Because we'll eventually also forward the console calls as logs, and that will be gated by _experiments.enableLogs. This experimental option will also graduate to be a top-level option, but we're bikeshedding naming because logs is super overloaded 😄
colin-sentry
colin-sentry
commented
Mar 4, 2025
View reviewed changes
Comment threadpackages/core/src/log.ts
Outdated

lforst
lforst
reviewed
Mar 5, 2025
View reviewed changes
Comment threadpackages/core/src/exports.ts
 * fatal(fmt`user ${username} just bought ${item}!`);
 * ```
 */
 fatal: sendLog('fatal'),
@lforstlforstMar 5, 2025

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.

This is the side-effect y'all are probably looking for.
@AbhiPrasadAbhiPrasad
mentioned this pull request
Mar 5, 2025
 Closed

@k-fish
k-fish
commented
Mar 5, 2025

Copy link


Copy Markdown

Member
@AbhiPrasad we have to change the typing on the parametrize values to allow all the possible js types, do we want to change it or just make another function?
@k-fish
k-fish
commented
Mar 5, 2025

Copy link


Copy Markdown

Member
@AbhiPrasad this #15600 maybe?
@HofmannZ
HofmannZ
commented
Mar 6, 2025

Copy link


Copy Markdown

How does this integrate with loggers like pino?
@AbhiPrasad
AbhiPrasad
commented
Mar 6, 2025

Copy link


Copy Markdown

Contributor
How does this integrate with loggers like pino?
For now the focus is on frontend logging, but we'll have integrations for popular logging frameworks. You can see getsentry/sentry-docs#12920 for more details how SDKs will work with logging frameworks.
@AbhiPrasadAbhiPrasad
mentioned this pull request
Mar 6, 2025
 Closed

@joshdales
joshdales
commented
Mar 7, 2025•

edited

Loading

Copy link


Copy Markdown

Is there a reason that this couldn't be added to the Angular package as well?
Would be very nice if it could please 🥺
@AbhiPrasad
AbhiPrasad
commented
Mar 11, 2025

Copy link


Copy Markdown

Contributor
@joshdales the angular package re-exports everything from the browser sdk, so this is included there.
The plan is that all JavaScript SDKs will have support for logs as soon as we're ready for users to use it :)
@joshdales
joshdales
commented
Mar 11, 2025

Copy link


Copy Markdown

@AbhiPrasad thanks for the context, as it wasn't included in the release notes I wasn't aware. Very excited to try this out 😄
@AbhiPrasad
AbhiPrasad
commented
Mar 26, 2025

Copy link


Copy Markdown

Contributor
This can be closed, we split this PR up into multiple steps and merged it in accordingly: #15526
@AbhiPrasad
AbhiPrasad
deleted the

colin/log-api

branch
March 26, 2025 15:48
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@k-fishk-fishk-fish left review comments
@stephanie-andersonstephanie-andersonstephanie-anderson left review comments
@AbhiPrasadAbhiPrasadAwaiting requested review from AbhiPrasad

+1 more reviewer

@lforstlforstlforst left review comments
Reviewers whose approvals may not affect merge requirements

Assignees

@AbhiPrasadAbhiPrasad

Labels


None yet


Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

8 participants

@colin-sentry@timfish@AbhiPrasad@k-fish@HofmannZ@joshdales@stephanie-anderson@lforst