feat(uniffi): add logging callback for mobile observability #627
+822
−16
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
|
Great job! No new security vulnerabilities introduced in this pull request |
Contributor
🔍 SDK Breaking Change Detection StatusSDK Version: Results will be updated when workflow completes. View SDK workflow |
Codecov Report❌ Patch coverage is Additional details and impacted files@@ Coverage Diff @@
## main #627 +/- ##
==========================================
+ Coverage 78.87% 79.07% +0.19%
==========================================
Files 283 285 +2
Lines 29680 29805 +125
==========================================
+ Hits 23410 23568 +158
+ Misses 6270 6237 -33 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
addisonbeck
force-pushed
the
PM-27800-expose-sdk-tracing-flight-recorder
branch
6 times, most recently
from
cee9fbf to
b072562
Compare
addisonbeck
force-pushed
the
PM-27800-expose-sdk-tracing-flight-recorder
branch
2 times, most recently
from
2efef50 to
26a4f0a
Compare
Adds an optional LogCallback trait that mobile clients can implement to receive SDK log events for forwarding to Flight Recorder or other observability systems. The callback integrates with the existing tracing infrastructure from PM-26930 using a custom Layer that forwards INFO+ events to registered callbacks. The implementation includes CallbackLayer for event forwarding, MessageVisitor for extracting log data, and error handling to ensure callback failures don't crash the SDK. The callback parameter is optional to maintain backward compatibility with existing clients. Comprehensive test coverage includes unit tests and integration tests in separate processes to validate thread safety, error handling, and multi-level log forwarding without Once initialization conflicts.
Adds a reusable GitHub action that removes unused toolchains and packages before running tests on ubuntu-24.04 runners. The cleanup frees approximately 30GB by removing .NET SDKs, Android SDK, Swift toolchain, Java JDKs, and other pre-installed software not needed for Rust compilation. This prevents "No space left on device" errors that occur when compiling the integration test suite alongside the full SDK workspace. The action runs only on Linux runners since macOS and Windows have sufficient disk space.
addisonbeck
force-pushed
the
PM-27800-expose-sdk-tracing-flight-recorder
branch
from
26a4f0a to
68a6590
Compare
addisonbeck
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
🎟️ Tracking
📔 Objective
This PR introduces an optional UNIFFI logging callback that enables mobile clients to receive SDK trace events and forward them to Flight Recorder observability systems.
The changes add a new
LogCallbacktrait that allows mobile teams to register a callback duringClient::new()initialization. When registered, the SDK forwards all INFO+ log events through this callback alongside existing platform loggers (oslog, android_logger). The callback is completely optional - existing SDK clients continue functioning without code changes.Documentation
Please review
crates/bitwarden-uniffi/docs/logging-callback.mdfor comprehensive details including:The documentation is the authoritative reference for this feature. You can also find a tech breakdown linked in the Tracking section.
Side Effect: CI Disk Cleanup
This PR also adds a disk cleanup action for Ubuntu test runners (
.github/actions/free-ubuntu-runner-disk-space/). The integration test suite compiles 5 separate test binaries alongside the full SDK workspace, requiring a lot of disk space. Without cleanup, Ubuntu runners exhaust available disk during compilation.Demo
Also included is an example showing how to use the callback. It, alongside the tests, are the assertions that the whole thing works. Here is a screenshot showing the output of the example:
⏰ Reminders before review
team
🦮 Reviewer guidelines
:+1:) or similar for great changes:memo:) or ℹ️ (:information_source:) for notes or general info:question:) for questions:thinking:) or 💭 (:thought_balloon:) for more open inquiry that's not quite a confirmedissue and could potentially benefit from discussion
:art:) for suggestions / improvements:x:) or:warning:) for more significant problems or concerns needing attention:seedling:) or ♻️ (:recycle:) for future improvements or indications of technical debt:pick:) for minor or nitpick changes