Log Integrations: Add `SentrySwiftLog` Package #6941

denrase · 2025-12-01T15:52:26Z

#skip-changelog

📜 Description

Adds the SentrySwiftLog integration to the integrations/logs/sentry-swift-log folder
Skipping changelog as this is not available to users through this repo

💡 Motivation and Context

Closes #5372
Relates to #6902

💚 How did you test it?

Runs pure swift tests against the current Package.swift version
This loads pre-build artefacts, so we always test against already released versions.
Should we rather test against current source?

📝 Checklist

You have to check all boxes before merging:

I added tests to verify the changes.
No new PII added or SDK only sends newly added PII if sendDefaultPII is enabled.
I updated the docs if needed.
I updated the wizard if needed.
Review from the native team if needed.
No breaking change or entry added to the changelog.
No breaking change for hybrid SDKs or communicated to hybrid SDKs.

codecov · 2025-12-03T10:35:02Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 85.069%. Comparing base (929c622) to head (2077ce0).
✅ All tests successful. No failed tests found.

Additional details and impacted files

@@            Coverage Diff             @@
##              main     #6941    +/-   ##
==========================================
  Coverage   85.069%   85.069%            
==========================================
  Files          453       453            
  Lines        27681     27681            
  Branches     12166     12167     +1     
==========================================
  Hits         23548     23548            
- Misses        3874      4087   +213     
+ Partials       259        46   -213

see 36 files with indirect coverage changes

Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 929c622...2077ce0. Read the comment docs.

denrase · 2025-12-03T10:42:47Z

3rd-party-integrations/SwiftLog/Tests/SentryLogHandlerTests.swift

+        SentrySDK.start { options in
+            options.dsn = "https://[email protected]/123456"
+            options.enableLogs = true
+            options.beforeSendLog = { [weak self] log in


Just use public SDK API for testing. That way we don't need any kind of test helpers from the main repo, keeping it completely separate and easily transferable to a downstream repo.

cursor · 2025-12-03T10:49:31Z

.github/workflows/test.yml

+      - name: Run CI Diagnostics
+        if: failure()
+        run: ./scripts/ci-diagnostics.sh
+


Bug: New test job missing from required-check dependencies

The new swiftlog-integration-unit-tests job is not included in the unit-tests-required-check job's needs array. Since unit-tests-required-check is the required status check that gates merging, failures in the swiftlog integration tests won't block the PR from merging. The job runs but its result is never validated by the required check.

This is relevant!

github-actions · 2025-12-03T11:05:04Z

Performance metrics 🚀

	Plain	With Sentry	Diff
Startup time	1212.46 ms	1242.20 ms	29.74 ms
Size	24.14 KiB	1.02 MiB	1016.90 KiB

Baseline results on branch: main

Startup times

Revision	Plain	With Sentry	Diff
`0ede342`	1233.47 ms	1262.29 ms	28.82 ms
`d05d866`	1211.78 ms	1230.96 ms	19.18 ms
`bbe6658`	1221.00 ms	1248.51 ms	27.51 ms
`bc0a04c`	1226.83 ms	1255.04 ms	28.21 ms
`15a6325`	1209.43 ms	1233.43 ms	24.00 ms
`25d9b58`	1233.76 ms	1267.92 ms	34.16 ms
`532bde4`	1210.63 ms	1256.24 ms	45.61 ms
`f83dcc4`	1210.88 ms	1246.22 ms	35.35 ms
`449d185`	1216.31 ms	1251.94 ms	35.62 ms
`dad68ad`	1229.15 ms	1261.98 ms	32.83 ms

App size

Revision	Plain	With Sentry	Diff
`0ede342`	23.75 KiB	928.15 KiB	904.40 KiB
`d05d866`	23.75 KiB	878.60 KiB	854.85 KiB
`bbe6658`	23.75 KiB	908.02 KiB	884.27 KiB
`bc0a04c`	23.75 KiB	933.32 KiB	909.57 KiB
`15a6325`	23.75 KiB	933.33 KiB	909.58 KiB
`25d9b58`	24.15 KiB	1.01 MiB	1014.91 KiB
`532bde4`	24.15 KiB	1.01 MiB	1014.89 KiB
`f83dcc4`	23.75 KiB	1.02 MiB	1019.11 KiB
`449d185`	23.75 KiB	980.81 KiB	957.06 KiB
`dad68ad`	23.75 KiB	912.37 KiB	888.63 KiB

Previous results on branch: feat/add-swift-log-integration

Startup times

Revision	Plain	With Sentry	Diff
`587a9b5`	1213.80 ms	1250.94 ms	37.14 ms
`e39cfe2`	1196.87 ms	1216.73 ms	19.87 ms

App size

Revision	Plain	With Sentry	Diff
`587a9b5`	24.14 KiB	1.02 MiB	1016.89 KiB
`e39cfe2`	24.14 KiB	1.02 MiB	1016.90 KiB

philprime · 2025-12-03T15:32:27Z

.github/file-filters.yml

  - "SentryTestUtils/**"
  - "SentryTestUtilsDynamic/**"
  - "SentryTestUtilsTests/**"
+  - "integrations/**"


h: make sure the naming of the directory is aligned with our decision in #6902

philprime · 2025-12-03T15:33:22Z

.github/workflows/test.yml

            device: "Apple TV"
            scheme: "Sentry"

+  swiftlog-integration-unit-tests:


m: We should consider adding a new workflow file for integrations separate to the main SDK tests, and to not further extend it

philprime · 2025-12-03T15:33:45Z

.github/workflows/test.yml

+      - name: Run CI Diagnostics
+        if: failure()
+        run: ./scripts/ci-diagnostics.sh
+


This is relevant!

philprime · 2025-12-03T15:35:08Z

3rd-party-integrations/SwiftLog/.gitignore

@@ -0,0 +1,8 @@
+.DS_Store


l: Let's consider these best-practices gitignores:

https://github.com/github/gitignore/blob/main/Swift.gitignore

https://github.com/github/gitignore/blob/main/Global/macOS.gitignore

https://github.com/github/gitignore/blob/main/Global/Xcode.gitignore

I usually concatenate them like this:

https://github.com/techprimate/Flinky/blob/main/.gitignore

philprime · 2025-12-03T15:36:39Z

3rd-party-integrations/SwiftLog/README.md

+
+```swift
+dependencies: [
+    .package(url: "https://github.com/getsentry/sentry-cocoa", from: "9.0.0"),


m: Is this one really necessary? Wouldn't it be resolve as a transitive dependency anyways?

philprime · 2025-12-03T15:38:30Z

3rd-party-integrations/SwiftLog/README.md

@@ -0,0 +1,187 @@
+# Sentry Swift-Log Integration
+
+A `swift-log` handler that forwards log entries to Sentry's structured logging system, automatically capturing application logs with full context including metadata, source location, and log levels.


m: Let's add an alert here already stating that this integration is mirrored from this repository as decided in #6902

That way when we build the mirror workflow, we don't have to patch the README

philprime · 2025-12-03T15:39:21Z

3rd-party-integrations/SwiftLog/Sources/SentryLogHandler.swift

+
+        var attributes: [String: Any] = [:]
+        attributes["sentry.origin"] = "auto.logging.swift-log"
+        attributes["swift-log.level"] = level.rawValue


m: Is the attribute namespacing standardized? Would it make sense to prefix with integration.?

github-actions · 2025-12-04T12:01:53Z

🚨 Detected changes in high risk code 🚨

High-risk code can easily blow up and is hard to test. We had severe bugs in the past. Be extra careful when changing these files, and have an extra careful look at these:

.github/file-filters.yml

denrase added 5 commits December 1, 2025 16:48

Add SenrtySwiftLog integration

8f396d4

Add default swift package init .gitignore

2e79d06

Merge branch 'main' into feat/add-swift-log-integration

c3a610e

Add ci job to run test

9fdbc39

Add files-changed gate

b096852

denrase commented Dec 3, 2025

View reviewed changes

denrase added the ready-to-merge Use this label to trigger all PR workflows label Dec 3, 2025

denrase marked this pull request as ready for review December 3, 2025 10:45

denrase requested review from itaybre, noahsmartin, philipphofmann and philprime as code owners December 3, 2025 10:45

denrase changed the title ~~Add SentrySwiftLog Package~~ Log Integrations: Add SentrySwiftLog Package Dec 3, 2025

cursor bot reviewed Dec 3, 2025

View reviewed changes

philprime reviewed Dec 3, 2025

View reviewed changes

denrase added 3 commits December 4, 2025 11:50

Merge branch 'main' into feat/add-swift-log-integration

d1851a8

update folder structure

5a72187

update name

2077ce0

denrase mentioned this pull request Dec 4, 2025

docs: Add integrations documentation to developer-docs section #6902

Merged

5 tasks

		@@ -0,0 +1,187 @@
		# Sentry Swift-Log Integration

		A `swift-log` handler that forwards log entries to Sentry's structured logging system, automatically capturing application logs with full context including metadata, source location, and log levels.

Uh oh!

Log Integrations: Add SentrySwiftLog Package #6941

Are you sure you want to change the base?

Log Integrations: Add SentrySwiftLog Package #6941

Uh oh!

Conversation

denrase commented Dec 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

📜 Description

💡 Motivation and Context

💚 How did you test it?

📝 Checklist

Uh oh!

codecov bot commented Dec 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

denrase Dec 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

cursor bot Dec 3, 2025

Choose a reason for hiding this comment

Bug: New test job missing from required-check dependencies

Uh oh!

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Dec 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Performance metrics 🚀

Baseline results on branch: main

Startup times

App size

Previous results on branch: feat/add-swift-log-integration

Startup times

App size

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Dec 4, 2025

🚨 Detected changes in high risk code 🚨

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Log Integrations: Add `SentrySwiftLog` Package #6941

Log Integrations: Add `SentrySwiftLog` Package #6941

denrase commented Dec 1, 2025 •

edited

Loading

codecov bot commented Dec 3, 2025 •

edited

Loading

denrase Dec 3, 2025 •

edited

Loading

github-actions bot commented Dec 3, 2025 •

edited

Loading