Skip to content

Logs: Integrate in Sentry Client#2920

Merged
denrase merged 32 commits intofeat/logsfrom
feat/logs-client
May 13, 2025
Merged

Logs: Integrate in Sentry Client#2920
denrase merged 32 commits intofeat/logsfrom
feat/logs-client

Conversation

@denrase
Copy link
Copy Markdown
Collaborator

@denrase denrase commented May 7, 2025 •
edited by buenaflor
Loading

📜 Description

  • Adds captureLog to SentryClient
  • Adds enableLogs to SentryOptions
  • Adds BeforeSendLogCallback to SentryOptions

💡 Motivation and Context

Relates to #2915
Relates to #2919
Closes #2922

💚 How did you test it?

Unit tests

📝 Checklist

  • I reviewed submitted code
  • I added tests to verify changes
  • No new PII added or SDK only sends newly added PII if sendDefaultPii is enabled
  • I updated the docs if needed
  • All tests passing
  • No breaking changes

🔮 Next steps

Hub & New Loggers

@codecov
Copy link
Copy Markdown

codecov bot commented May 7, 2025 •
edited
Loading

Codecov Report

Attention: Patch coverage is 95.65217% with 2 lines in your changes missing coverage. Please review.

Project coverage is 87.74%. Comparing base (09f8959) to head (b7f74b3).
Report is 1 commits behind head on feat/logs.

Files with missing lines Patch % Lines
dart/lib/src/noop_log_batcher.dart 0.00% 2 Missing ⚠️
Additional details and impacted files 
@@              Coverage Diff              @@
##           feat/logs    #2920      +/-   ##
=============================================
+ Coverage      87.68%   87.74%   +0.05%     
=============================================
  Files            275      277       +2     
  Lines           9089     9133      +44     
=============================================
+ Hits            7970     8014      +44     
  Misses          1119     1119

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

denrase
denrase commented May 7, 2025
View reviewed changes
denrase
denrase commented May 7, 2025
View reviewed changes
denrase
denrase commented May 7, 2025
View reviewed changes
@denrase denrase changed the title Logs: Integrate in Sentry Client & Hub Logs: Integrate in Sentry Client May 8, 2025
@denrase denrase marked this pull request as ready for review May 8, 2025 08:37
buenaflor
buenaflor reviewed May 8, 2025
View reviewed changes
@denrase denrase requested a review from buenaflor May 12, 2025 08:46
buenaflor
buenaflor reviewed May 12, 2025
View reviewed changes
@denrase denrase requested a review from buenaflor May 12, 2025 09:51
buenaflor
buenaflor reviewed May 12, 2025
View reviewed changes
Copy link
Copy Markdown
Contributor

@buenaflor buenaflor left a comment

Choose a reason for hiding this comment

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

Got only one comment left but otherwise looks good

@buenaflor
Copy link
Copy Markdown
Contributor

buenaflor commented May 12, 2025

cc @philipphofmann

@denrase denrase requested a review from buenaflor May 12, 2025 12:21
buenaflor
buenaflor reviewed May 12, 2025
View reviewed changes
@denrase denrase requested a review from buenaflor May 13, 2025 09:02
buenaflor
buenaflor reviewed May 13, 2025
View reviewed changes
@denrase denrase requested a review from buenaflor May 13, 2025 09:57
buenaflor
buenaflor reviewed May 13, 2025
View reviewed changes
Copy link
Copy Markdown
Contributor

@buenaflor buenaflor left a comment

Choose a reason for hiding this comment

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

looks good, let's merge the batch PR and update this PR

@denrase denrase requested a review from buenaflor May 13, 2025 11:39
@denrase denrase merged commit 592c046 into feat/logs May 13, 2025
164 checks passed
@denrase denrase deleted the feat/logs-client branch May 13, 2025 13:10
stefanosiano
stefanosiano reviewed May 13, 2025
View reviewed changes
dart/lib/src/sentry_client.dart
}
if (processedLog != null) {
_options.logBatcher.addLog(processedLog);
}
Copy link
Copy Markdown
Contributor

@stefanosiano stefanosiano May 13, 2025

Choose a reason for hiding this comment

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

should we report a dropped log if null after the beforeSendLog?

stefanosiano
stefanosiano reviewed May 13, 2025
View reviewed changes
dart/lib/src/sentry_log_batcher.dart
void addLog(SentryLog log) {
_logBuffer.add(log);

_flushTimer?.cancel();
Copy link
Copy Markdown
Contributor

@stefanosiano stefanosiano May 13, 2025

Choose a reason for hiding this comment

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

canceling the timer here means that, in theory, if a log is added every 4 seconds, we will not flush them for several minutes
Is this the expectation?
Just fyi, Java sends every 5 seconds, regardless of how many logs are there

Copy link
Copy Markdown
Contributor

@stefanosiano stefanosiano May 13, 2025

Choose a reason for hiding this comment

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

i guess it's fine as per docs, just ensuring it's wanted

@buenaflor buenaflor mentioned this pull request May 15, 2025
Merged
14 tasks
buenaflor added a commit that referenced this pull request May 20, 2025
@denrase @buenaflor
Sentry Structured Logs (#2919)
9ef5d50 
* Logs: Models & Envelopes (#2916)

* Logs: Integrate in Sentry Client (#2920)

* [Structured Logs]: Expose Public API (#2940)

* update changelog entry

---------

Co-authored-by: Giancarlo Buenaflor <giancarlo_buenaflor@yahoo.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@buenaflor buenaflor buenaflor approved these changes

@krystofwoldrich krystofwoldrich Awaiting requested review from krystofwoldrich

+1 more reviewer

@stefanosiano stefanosiano stefanosiano left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@denrase @buenaflor @stefanosiano