Structured Logs: Add `SentrySwiftLog` Integration #6286

denrase · 2025-09-25T14:24:47Z

📜 Description

The Sentry swift-log integration.

Setup

Adds SentrySwiftLog as a target to Sentry target
Adds SentrySwiftLog to Package.swift
Add a sample call to the iOS15-SwiftUi app so you can play around with it

Implementation

Adds SentryLogHandler
sentry-log metadata is mapped to attributes and prefixed with swift-log
Other parameters of the log function are set as attributes and

Discussion

Here vs Own Repo

Added the integration to this repo, because it is easier for us to maintain.

On the swift-log repo integrations section is linking to the swift package index with search term swift-log. So for visibility, we'd need to have a separate swift-log-sentry repo.

https://github.com/apple/swift-log?tab=readme-ov-file#available-log-handler-backends
https://swiftpackageindex.com/search?query=swift-log

Distribution

Only distributed through SPM, as swift-log dropped support for CocoaPods. Also, we'll not be able to distribute this as a binary, as swift-log is not supporting that.

Module was not compiled with library evolution support; using it means binary compatibility for can't be guaranteed

💡 Motivation and Context

Closes #5372

💚 How did you test it?

Unit Tests
Sample App

📝 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-09-25T14:28:52Z

Codecov Report

❌ Patch coverage is 86.66667% with 6 lines in your changes missing coverage. Please review.
✅ Project coverage is 86.837%. Comparing base (7aaa0b6) to head (3d57dc6).
✅ All tests successful. No failed tests found.

Files with missing lines	Patch %	Lines
Sources/SentrySwiftLog/SentryLogHandler.swift	86.046%	6 Missing ⚠️

Additional details and impacted files

@@              Coverage Diff              @@
##              main     #6286       +/-   ##
=============================================
+ Coverage   86.818%   86.837%   +0.018%     
=============================================
  Files          438       439        +1     
  Lines        37311     37356       +45     
  Branches     17428     17429        +1     
=============================================
+ Hits         32393     32439       +46     
+ Misses        4874      4643      -231     
- Partials        44       274      +230

Files with missing lines	Coverage Δ
SentryTestUtils/ClearTestState.swift	`86.567% <100.000%> (+0.413%)`	⬆️
Sources/SentrySwiftLog/SentryLogHandler.swift	`86.046% <86.046%> (ø)`

... and 38 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 7aaa0b6...3d57dc6. Read the comment docs.

github-actions · 2025-09-25T15:14:00Z

Performance metrics 🚀

	Plain	With Sentry	Diff
Startup time	1227.86 ms	1255.65 ms	27.79 ms
Size	23.75 KiB	989.97 KiB	966.22 KiB

Baseline results on branch: main

Startup times

Revision	Plain	With Sentry	Diff
`2ec2700`	1238.28 ms	1258.82 ms	20.53 ms
`d0f70ce`	1226.54 ms	1247.04 ms	20.50 ms
`5bf2b17`	1213.53 ms	1238.54 ms	25.01 ms
`efab7d3`	1219.98 ms	1252.12 ms	32.14 ms
`e3ebff3`	1223.47 ms	1249.27 ms	25.80 ms
`7b3399c`	1193.35 ms	1227.38 ms	34.03 ms
`3133d0e`	1237.86 ms	1262.87 ms	25.01 ms
`22b6996`	1234.00 ms	1263.24 ms	29.24 ms
`43597ba`	1214.88 ms	1243.52 ms	28.65 ms
`fc6557e`	1226.40 ms	1249.88 ms	23.48 ms

App size

Revision	Plain	With Sentry	Diff
`2ec2700`	23.75 KiB	980.80 KiB	957.05 KiB
`d0f70ce`	23.75 KiB	913.09 KiB	889.34 KiB
`5bf2b17`	23.75 KiB	913.27 KiB	889.52 KiB
`efab7d3`	23.75 KiB	912.78 KiB	889.03 KiB
`e3ebff3`	23.75 KiB	878.48 KiB	854.73 KiB
`7b3399c`	23.75 KiB	946.68 KiB	922.94 KiB
`3133d0e`	23.74 KiB	976.79 KiB	953.04 KiB
`22b6996`	23.75 KiB	908.02 KiB	884.27 KiB
`43597ba`	23.75 KiB	880.32 KiB	856.58 KiB
`fc6557e`	23.75 KiB	866.68 KiB	842.93 KiB

Previous results on branch: denrase/swift-log-sentry-poc

Startup times

Revision	Plain	With Sentry	Diff
`0fd08ab`	1225.14 ms	1256.49 ms	31.35 ms

App size

Revision	Plain	With Sentry	Diff
`0fd08ab`	23.75 KiB	995.43 KiB	971.68 KiB

# Conflicts: # Package.swift # Sentry.xcodeproj/project.pbxproj

itaybre

Looks good, just a small comment

itaybre · 2025-10-10T20:52:23Z

.github/actions/prepare-package.swift/action.yml

+        # Clean up orphaned commas and fix syntax
+        sed -i '' '/^[[:space:]]*,$/d' $PACKAGE_FILE
+        sed -i '' 's/name: "Sentry\(-.*\)\?"$/name: "Sentry\1",/g' $PACKAGE_FILE
+        sed -i '' 's/platforms: \[\.iOS(\.v11), \.macOS(\.v10_13), \.tvOS(\.v11), \.watchOS(\.v4)\]$/platforms: [.iOS(.v11), .macOS(.v10_13), .tvOS(.v11), .watchOS(.v4)],/g' $PACKAGE_FILE


What is this trying to do?

One of the CI jobs is replacing dependencies with local build artefacts. This broke, as swift-log was added to our Package.swift. This code fixes those issues.

Does this only happen because of swift-log or should we do the fix in a separate PR?

philprime · 2025-10-20T11:38:27Z

Package.swift

    .library(name: "SentrySwiftUI", targets: ["Sentry", "SentrySwiftUI", "SentryCppHelper"]),
-    .library(name: "SentryDistribution", targets: ["SentryDistribution"])
+    .library(name: "SentryDistribution", targets: ["SentryDistribution"]),
+    .library(name: "SentrySwiftLog", targets: ["Sentry", "SentrySwiftLog"])


m: I don't fully understand why this is another target. Is this only here because swift-log is a new dependency? Shouldn't we add it as a dependency to Sentry instead?

philprime · 2025-10-20T11:42:06Z

Package.swift

    platforms: [.iOS(.v15), .macOS(.v12), .tvOS(.v15), .watchOS(.v8)],
    products: products,
+    dependencies: [
+        .package(url: "https://github.com/apple/swift-log", from: "1.6.0")


h: So I think this is going to be a problem as soon as new swift-log version becomes available. AFAIK the SPM doesn't support peer-dependencies, so if someone uses swift-log with a version not being 1.6.0, while we depend on it, Xcode will not build because it doesn't support the same dependency with different versions like NPM.

So basically this will lock our SDK users into exactly the swift-log version we declare, requiring us to release a new SDK version with every update of swift-log, furthermore requiring users to update the Sentry SDK even though they just want a new version of swift-log. At this point I do not have a proposal how to fix this other than asking the user to "inject" their swift-log version by making it conform to a Sentry-included protocol

philprime · 2025-10-20T11:43:27Z

CHANGELOG.md


 Removes deprecated user feedback API, this is replaced with the new feedback API (#5591)
 Removes `enablePerformanceV2` option and makes this the default. The app start duration will now finish when the first frame is drawn instead of when the OS posts the UIWindowDidBecomeVisibleNotification. (#6008)
+Structured Logs: Move options out of experimental (#6359)


l: Why is one list with - and one without?

denrase added 7 commits September 25, 2025 13:24

POC: Add swift-log package

a72802e

Merge branch 'main' into denrase/swift-log-sentry-poc

7032e87

use trace instead of error in sample app

4b491c8

add tests, move sample to app with ios > 11

21dc2de

revert changes in sample app

59117a4

remove unused helper

2fcf8bb

no need for docs for swift-log methods

467f314

denrase added 4 commits September 25, 2025 16:28

fix typo

00559c2

no need to map level

249759b

fix typo

1c0a0d4

format package

39dc722

denrase added 4 commits September 30, 2025 14:03

Merge branch 'main' into denrase/swift-log-sentry-poc

3f82bb0

# Conflicts: # Package.swift # Sentry.xcodeproj/project.pbxproj

Rename to SentrySwiftLog

ce69ea1

remae target

825e5df

Add changelog

7139756

denrase changed the title ~~Structured Logs: swift-log Integration~~ Structured Logs: Add SentrySwiftLog Integration Sep 30, 2025

denrase added 8 commits September 30, 2025 14:40

disable lint warning, remove todo

2408a07

Exclude from SentryObjc

f9062d6

test SentrySwiftLog

f6bc914

Update prepare-package.swift

fd73f1e

Add shared scheme

fb07770

Merge branch 'main' into denrase/swift-log-sentry-poc

befdf40

fix old target names

45c8ed8

format

0779263

denrase marked this pull request as ready for review October 1, 2025 13:25

denrase requested review from noahsmartin, philipphofmann and philprime as code owners October 1, 2025 13:26

denrase requested a review from itaybre as a code owner October 1, 2025 13:26

This comment was marked as outdated.

Sign in to view

denrase added 3 commits October 6, 2025 09:58

Merge branch 'main' into denrase/swift-log-sentry-poc

601a5ae

Move example to iOS-Swift app

4e20b63

bump depolyment targets for senryswiftlog target

a607ccb

This comment was marked as outdated.

Sign in to view

add cl entry

3d57dc6

itaybre reviewed Oct 10, 2025

View reviewed changes

denrase requested a review from itaybre October 13, 2025 14:31

philprime reviewed Oct 20, 2025

View reviewed changes

Uh oh!

Structured Logs: Add SentrySwiftLog Integration #6286

Are you sure you want to change the base?

Structured Logs: Add SentrySwiftLog Integration #6286

Uh oh!

Conversation

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

Uh oh!

📜 Description

Setup

Implementation

Discussion

Here vs Own Repo

Distribution

💡 Motivation and Context

💚 How did you test it?

📝 Checklist

Uh oh!

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

Uh oh!

Codecov Report

Uh oh!

github-actions bot commented Sep 25, 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: denrase/swift-log-sentry-poc

Startup times

App size

Uh oh!

This comment was marked as outdated.

Uh oh!

This comment was marked as outdated.

Uh oh!

itaybre left a comment

Choose a reason for hiding this comment

Uh oh!

itaybre Oct 10, 2025

Choose a reason for hiding this comment

Uh oh!

denrase Oct 13, 2025

Choose a reason for hiding this comment

Uh oh!

philprime Oct 20, 2025

Choose a reason for hiding this comment

Uh oh!

philprime Oct 20, 2025

Choose a reason for hiding this comment

Uh oh!

philprime Oct 20, 2025

Choose a reason for hiding this comment

Uh oh!

philprime Oct 20, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Structured Logs: Add `SentrySwiftLog` Integration #6286

Structured Logs: Add `SentrySwiftLog` Integration #6286

denrase commented Sep 25, 2025 •

edited

Loading

codecov bot commented Sep 25, 2025 •

edited

Loading

github-actions bot commented Sep 25, 2025 •

edited

Loading