Track performance by app state using MetricKit
At a glance
| Item | Summary |
|---|---|
| Purpose | Collect performance metrics, diagnostic reports, and experiment data related to your app’s current state using the MetricKit framework. |
| App architecture | A Swift sample with the source-visible chain MetricKitSampleApp → MainTabView → DashboardViewModel → SwiftUI / SwiftData APIs. |
| Main patterns | Model-View-ViewModel, Delegate or data-source callbacks, Coordinator |
| Project style | 27 scanned source file(s) across Swift, organized around ranked entry, type, and file boundaries. |
| Execution model | Source-visible boundaries: @MainActor, Task, await suspension point, MainActor.run, Sendable or @Sendable; none alone proves a background thread. |
| State/event model | Source-visible mechanisms: @Observable, SwiftUI state property wrapper. |
| Key frameworks/packages | SwiftUI, SwiftData, Foundation, OSLog, StateReporting; these are source dependencies, not architecture labels. |
Project structure
Source bundle/
└── MetricKit-Sample/
├── MetricKitSampleApp.swift
├── View Models/
│ ├── DashboardViewModel.swift
│ └── ExpenseReportViewModel.swift
├── ReportableMetadata.swift
└── Views/
├── DocumentCameraView.swift
├── MainTabView.swift
├── CrashReportAnnotationView.swift
├── Dashboard/
│ └── DashboardView.swift
└── Expenses/
├── ExpenseCardView.swift
├── ExpenseDetailView.swift
├── ExpenseFormView.swift
└── ExpenseRowView.swift
Structure observations
- Architecturally prominent files are ranked from entry points and role-named declarations; resource-only paths are omitted.
- Primary languages: Swift.
- The verified tree contains 5 project/configuration file(s) and 39 source declaration(s).
Overall architecture
flowchart LR
N1["MetricKitSampleApp"]
N2["MainTabView"]
N3["DashboardViewModel"]
N4["SwiftUI / SwiftData APIs"]
N1 --> N2
N2 --> N3
N3 --> N4
Reference code
MetricKit-Sample/MetricKitSampleApp.swift:11 — architecture anchor
@main
struct MetricKitSampleApp: App {
// ...
private let metricsCollector = MetricsCollector()
// ...
}Interpretation
The arrows summarize the source-visible entry, role-named types or folders, and framework direction; when nodes come from structural folders, the sequence is a high-level interpretation rather than proof that every adjacent node calls the next. Ownership is claimed only where the next section cites a stored property or assignment. The diagram is intentionally limited to the dominant path into MetricKit.
Ownership and state
classDiagram
MetricKitSampleApp *-- MetricsCollector : metricsCollector
CategorySpend o-- ExpenseCategory : category
CategorySpend *-- Double : total
CategoryAverage o-- ExpenseCategory : category
Ownership evidence
MetricKit-Sample/MetricKitSampleApp.swift:16 — stored dependency or nearest verified ownership anchor
@main
struct MetricKitSampleApp: App {
// ...
private let metricsCollector = MetricsCollector()
// ...
}| Owner | Object or state | Relationship | Mutation authority |
|---|---|---|---|
MetricKitSampleApp |
MetricsCollector (metricsCollector) |
creates and retains | Initialized by the owner; the binding is immutable |
CategorySpend |
ExpenseCategory (category) |
stores or receives | Initialized by the owner; the binding is immutable |
CategorySpend |
Double (total) |
owns value state | Initialized by the owner; the binding is immutable |
CategoryAverage |
ExpenseCategory (category) |
stores or receives | Initialized by the owner; the binding is immutable |
Composition arrows indicate a source-visible construction expression or locally owned value state; aggregation means the owner stores or receives a dependency without proving exclusive lifetime ownership.
Concurrency, scheduling, and thread safety
Evidence limit: actor isolation, async/await, or Task creation does not by itself prove background-thread execution; Sendable conformance alone does not prove thread-safe mutation.
| Concern | Source mechanism | Verified placement or handoff | Evidence |
|---|---|---|---|
| Main isolation | @MainActor |
The cited annotation marks its attached declaration or closure as main-actor isolated. | MetricKit-Sample/MetricsCollector.swift:21 |
| Task creation | Task |
The source creates an unstructured task; surrounding context determines inherited actor isolation. | MetricKit-Sample/MetricsCollector.swift:113 |
| Suspension boundary | await suspension point |
The source declares or crosses an asynchronous boundary; it does not by itself establish background execution. | MetricKit-Sample/MetricsCollector.swift:118 |
| Main isolation | MainActor.run |
The cited operation explicitly enters a main-actor-isolated region. | MetricKit-Sample/MetricsCollector.swift:236 |
| Transfer contract | Sendable or @Sendable |
The source declares a sendability boundary; this alone does not synchronize mutable state. | MetricKit-Sample/Model/CrashReportSummary.swift:15 |
@MainActor/MainActor.run, DispatchQueue.main, and RunLoop.main are reported as distinct isolation, queue, and event-loop mechanisms. A plain Task is kept separate from Task.detached; neither is labeled as a background thread.
Reference code
MetricKit-Sample/MetricsCollector.swift:21 — representative execution boundary
@MainActor
@Observable
class MetricsCollector {
private let logger = Logger.metricsCollector
// ...
}State propagation, frameworks, and dependencies
Evidence limit: an import proves a source-level compilation dependency at the cited line; it does not prove runtime use, architectural adoption, or whether a Swift package is a direct application dependency.
| Category | Mechanism or module | Verified role | Evidence |
|---|---|---|---|
| State propagation | @Observable |
Observation macro publishes source-visible changes. | MetricKit-Sample/MetricsCollector.swift:22 |
| State propagation | SwiftUI state property wrapper |
A SwiftUI property wrapper supplies or observes UI state. | MetricKit-Sample/Views/CrashReportAnnotationView.swift:12 |
| Source import | SwiftUI |
The cited file imports this module; runtime use and architectural role are not inferred. | MetricKit-Sample/MetricKitSampleApp.swift:8 |
| Source import | SwiftData |
The cited file imports this module; runtime use and architectural role are not inferred. | MetricKit-Sample/DataContainer.swift:9 |
| Source import | Foundation |
The cited file imports this module; runtime use and architectural role are not inferred. | MetricKit-Sample/DataContainer.swift:8 |
| Source import | OSLog |
The cited file imports this module; runtime use and architectural role are not inferred. | MetricKit-Sample/DataContainer.swift:10 |
| Source import | StateReporting |
The cited file imports this module; runtime use and architectural role are not inferred. | MetricKit-Sample/MetricsCollector.swift:11 |
| Source import | Charts |
The cited file imports this module; runtime use and architectural role are not inferred. | MetricKit-Sample/Views/Dashboard/AverageSpendChart.swift:9 |
receive(on:) describes downstream delivery scheduling, while subscribe(on:) describes upstream subscription/request/cancel scheduling. An import Combine alone establishes neither behavior nor a Store, reducer, Redux, or other application architecture.
Class and protocol design
MetricKit-Sample/MetricKitSampleApp.swift:12 — representative type boundary
@main
struct MetricKitSampleApp: App {
// ...
private let metricsCollector = MetricsCollector()
// ...
}| Type | Responsibility | Depends on or conforms to |
|---|---|---|
MetricKitSampleApp |
Application entry and top-level composition | App |
DashboardViewModel |
UI-facing state and feature coordination | Concrete collaborators/imported frameworks |
ExpenseReportViewModel |
UI-facing state and feature coordination | Concrete collaborators/imported frameworks |
DocumentCameraView |
User-interface presentation and input forwarding | UIViewControllerRepresentable |
Coordinator |
Cross-object flow or session coordination | NSObject, VNDocumentCameraViewControllerDelegate |
MainTabView |
User-interface presentation and input forwarding | View |
CrashReportAnnotationView |
User-interface presentation and input forwarding | View |
DashboardView |
User-interface presentation and input forwarding | View |
ExpenseCardView |
User-interface presentation and input forwarding | View |
ExpenseDetailView |
User-interface presentation and input forwarding | View |
No local protocol conformance is claimed as protocol-oriented design; external framework conformances are listed only as dependencies.
Access control
| Symbol | Access | Verified effect | Likely rationale |
|---|---|---|---|
defaultContainer (MetricKit-Sample/DataContainer.swift:26) |
private |
Use is restricted to the lexical declaration and same-file extensions allowed by Swift. | Inference: keep state mutation or dependency lifetime inside the owning implementation. |
previewContainer (MetricKit-Sample/DataContainer.swift:36) |
private |
Use is restricted to the lexical declaration and same-file extensions allowed by Swift. | Inference: keep state mutation or dependency lifetime inside the owning implementation. |
hasSeededKey (MetricKit-Sample/DataContainer.swift:55) |
private |
Use is restricted to the lexical declaration and same-file extensions allowed by Swift. | Inference: keep state mutation or dependency lifetime inside the owning implementation. |
sampleExpenses (MetricKit-Sample/DataContainer.swift:65) |
private |
Use is restricted to the lexical declaration and same-file extensions allowed by Swift. | Inference: keep state mutation or dependency lifetime inside the owning implementation. |
Reference code
MetricKit-Sample/DataContainer.swift:26 — representative boundary
private static let defaultContainer: ModelContainer = {
// ...
let modelContainer = try ModelContainer(for: ExpenseReport.self)
// ...
}()Swift declarations without a modifier are internal; explicit private, fileprivate, private(set), public, or open entries above are interpreted by language semantics. Objective-C/C samples instead rely on header and implementation boundaries, which are not equivalent to Swift lexical privacy.
Logic ownership and placement
| Logic | Owning type or file | Placement rationale |
|---|---|---|
| Application entry and top-level composition | MetricKitSampleApp |
The source’s App suffix makes this role explicit. |
| Cross-object flow or session coordination | Coordinator |
The source’s Coordinator suffix makes this role explicit. |
| User-interface presentation and input forwarding | CrashReportAnnotationView, DashboardView, DocumentCameraView, ExpenseCardView |
The source’s View suffix makes this role explicit. |
| UI-facing state and feature coordination | DashboardViewModel, ExpenseReportViewModel |
The source’s ViewModel suffix makes this role explicit. |
Design patterns
| Pattern | Source evidence | Purpose or tradeoff |
|---|---|---|
| Model-View-ViewModel | MetricKit-Sample/View Models/DashboardViewModel.swift:45 |
Role-named view models keep UI-facing state or coordination outside view declarations. |
| Delegate or data-source callbacks | MetricKit-Sample/Views/DocumentCameraView.swift:27 |
Callback protocols invert event delivery back into the sample’s owner. |
| Coordinator | MetricKit-Sample/Views/DocumentCameraView.swift:27 |
A role-named coordinator centralizes cross-object flow. |
Naming conventions
- Types: App: MetricKitSampleApp; Coordinator: Coordinator; View: CrashReportAnnotationView, DashboardView, DocumentCameraView, ExpenseCardView, ExpenseDetailView; ViewModel: DashboardViewModel, ExpenseReportViewModel.
- Protocols: no local protocol declaration in the scanned source.
- Methods:
computeSpendingValues,didScanImage,clearPendingImage,addReport,submitReport,revertToDraft,deleteExpenses,addExpense. - Files:
MetricKit-Sample/MetricKitSampleApp.swift,MetricKit-Sample/View Models/DashboardViewModel.swift,MetricKit-Sample/View Models/ExpenseReportViewModel.swift,MetricKit-Sample/Views/DocumentCameraView.swift,MetricKit-Sample/Views/MainTabView.swift,MetricKit-Sample/Views/CrashReportAnnotationView.swift.
Architecture takeaways
MetricKitSampleAppis the main source-visible entry or composition anchor for this sample.- Framework work reaches SwiftUI, SwiftData, StateReporting, Charts through a deliberately small high-level chain; the detailed API graph remains inside the cited implementation files.
- Stored-property evidence identifies lifecycle collaboration; it does not by itself prove exclusive object ownership.
- Access-control conclusions separate verified language visibility from the likely design rationale.
- The source does not justify labeling the design protocol-oriented.
Source map
| Source file | Relevant symbols |
|---|---|
MetricKit-Sample/MetricKitSampleApp.swift |
Cited implementation, MetricKitSampleApp, SwiftUI |
MetricKit-Sample/DataContainer.swift |
Cited implementation, SwiftData, Foundation, OSLog, DataContainer, SampleExpense |
MetricKit-Sample/View Models/DashboardViewModel.swift |
DashboardViewModel, CategorySpend, CategoryAverage, TimePeriod |
MetricKit-Sample/Views/DocumentCameraView.swift |
Cited implementation, Coordinator, DocumentCameraView |
MetricKit-Sample/MetricsCollector.swift |
@MainActor, Task, await suspension point, MainActor.run, @Observable, StateReporting, MetricsCollector |
MetricKit-Sample/Model/CrashReportSummary.swift |
Sendable or @Sendable, CrashReportSummary |
MetricKit-Sample/Views/CrashReportAnnotationView.swift |
SwiftUI state property wrapper, CrashReportAnnotationView |
MetricKit-Sample/Views/Dashboard/AverageSpendChart.swift |
Charts, AverageSpendChart |
MetricKit-Sample/View Models/ExpenseReportViewModel.swift |
ExpenseReportViewModel |
MetricKit-Sample/ReportableMetadata.swift |
ExperimentContext, Experiments, ExpenseDetailLayout, UserActivityMetadata, UserActivity, Mode |
MetricKit-Sample/Views/MainTabView.swift |
MainTabView, Tab |
MetricKit-Sample/Views/Dashboard/DashboardView.swift |
DashboardView |
MetricKit-Sample/Views/Expenses/ExpenseCardView.swift |
ExpenseCardView |
MetricKit-Sample/Views/Expenses/ExpenseDetailView.swift |
ExpenseDetailView |
MetricKit-Sample/Views/Expenses/ExpenseFormView.swift |
NewExpenseFormView |
MetricKit-Sample/Views/Expenses/ExpenseRowView.swift |
ExpenseRowView |