getsentry/sentry-apple-swift-log

Installation

Swift Package Manager

Add the following dependencies to your Package.swift or Xcode package dependencies:

dependencies: [
    .package(url: "https://github.com/getsentry/sentry-apple-swift-log", from: "9.0.0")
]

Then add the SentrySwiftLog product to your target:

.target(
    name: "MyApp",
    dependencies: [
        .product(name: "SentrySwiftLog", package: "sentry-apple-swift-log")
    ]
)

Quick Start

import Logging
import Sentry
import SentrySwiftLog

SentrySDK.start { options in
    options.dsn = "YOUR_DSN"
}

var handler = SentryLogHandler(logLevel: .info)
handler.metadata["app_version"] = "1.0.0"
handler.metadata["environment"] = "production"

LoggingSystem.bootstrap { _ in handler }

let logger = Logger(label: "com.example.app")

logger.info("User logged in", metadata: ["userId": "12345"])
logger.error("Payment failed", metadata: ["errorCode": 500])
logger.warning("API rate limit approaching", metadata: ["remaining": 10])

logger.info("User action", metadata: [
    "userId": "12345",
    "action": "purchase"
])

Configuration

Log Level Threshold

Set the minimum log level for messages to be sent to Sentry. Messages below the configured threshold will be filtered out and not sent to Sentry.

let handler = SentryLogHandler(logLevel: .trace)

Handler Metadata

Add metadata that will be included with all log entries. Handler metadata is merged with call-site metadata, with call-site metadata taking precedence.

var handler = SentryLogHandler(logLevel: .info)
handler.metadata["app_version"] = "1.0.0"
handler.metadata["environment"] = "production"

You can also access metadata using subscript syntax:

handler[metadataKey: "app_version"] = "1.0.0"
let version = handler[metadataKey: "app_version"]

Log Level Mapping

swift-log levels are automatically mapped to Sentry log levels:

| swift-log Level | Sentry Log Level | | --------------- | ---------------- | | .trace | .trace | | .debug | .debug | | .info | .info | | .notice | .info | | .warning | .warn | | .error | .error | | .critical | .fatal |

Metadata Handling

The handler supports all swift-log metadata types including strings, dictionaries, arrays, and string convertible types (numbers, booleans, etc.). All metadata is automatically prefixed with swift-log. in Sentry attributes (e.g., swift-log.userId, swift-log.user.id). See the Quick Start section above for examples of each metadata type.

Automatic Attributes

The handler automatically includes the following attributes with every log entry:

• sentry.origin: "auto.logging.swift-log"
• swift-log.level: The original swift-log level
• swift-log.source: The log source
• code.file.path: The source file name
• code.function.name: The function name
• code.line.number: The line number

Documentation

• Sentry Cocoa SDK Documentation
• Sentry Logs Documentation
• SwiftLog Repo
• Sentry Conventions

License

This integration follows the same license as the Sentry Cocoa SDK. See the LICENSE file for details.

Package Metadata

Repository: getsentry/sentry-apple-swift-log

Default branch: main

README: README.md