https://github.com/kasianov-mikhail/scout
CloudKit as a Log Storage
https://github.com/kasianov-mikhail/scout
analytics cloudkit monitoring performance swift swift-logging swift-metrics swift-package-manager swift-testing swiftui
Last synced: 8 months ago
JSON representation
CloudKit as a Log Storage
- Host: GitHub
- URL: https://github.com/kasianov-mikhail/scout
- Owner: kasianov-mikhail
- License: mit
- Created: 2024-11-12T03:41:39.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-01-13T18:40:58.000Z (over 1 year ago)
- Last Synced: 2025-01-13T19:37:56.773Z (over 1 year ago)
- Topics: analytics, cloudkit, monitoring, performance, swift, swift-logging, swift-metrics, swift-package-manager, swift-testing, swiftui
- Language: Swift
- Homepage:
- Size: 99.6 KB
- Stars: 8
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- fucking-awesome-swift - Scout - Production-grade logging SDK for iOS apps using CloudKit as a backend. (Libs / Analytics)
- awesome-swift - Scout - Production-grade logging SDK for iOS apps using CloudKit as a backend. (Libs / Analytics)
- awesome-swift - Scout - Production-grade logging and analytics SDK using CloudKit. (Data and Storage)
README
## Description
Scout is a robust logging framework designed to provide comprehensive logging capabilities for your applications. It supports various logging levels, output formats, and destinations, making it easy to integrate and customize according to your needs. Whether you are developing a small project or a large-scale system, Scout ensures that you have detailed and organized logs to help you monitor and debug your applications effectively.
## Table of Contents
- [CloudKit Integration](#cloudkit-integration)
- [Logging & Metrics](#logging--metrics)
- [Installation](#installation)
- [Visualizing the Logs](#visualizing-the-logs)
- [Example Project](#example-project)
- [License](#license)
## CloudKit Integration
Scout offers seamless integration with [CloudKit](https://developer.apple.com/icloud/cloudkit/), allowing you to store and manage your logs in the cloud effortlessly. By leveraging [CloudKit](https://developer.apple.com/icloud/cloudkit/), you can:
- **📊 Centralize Logs**: Store logs from multiple devices and applications in a single, centralized location.
- **⏱️ Real-time Access**: Access your logs in real-time from anywhere, ensuring you can monitor your applications' performance and issues promptly.
- **📈 Scalability**: Benefit from [CloudKit](https://developer.apple.com/icloud/cloudkit/)'s scalability to handle large volumes of log data without compromising performance.
- **🔒 Security**: Ensure your logs are securely stored and transmitted, adhering to industry-standard security practices.
## Logging & Metrics
Scout builds on Apple’s observability facades:
- [swift-log](https://github.com/apple/swift-log) for structured logging
- [swift-metrics](https://github.com/apple/swift-metrics) for counters, gauges, and timers
Benefits:
- **📏 Standardization**: Use unified, community-adopted APIs for logs and metrics.
- **🔧 Flexibility**: Customize log handlers and formats to suit your specific needs.
- **🔍 Correlation**: Share labels/metadata to jump from a metric spike to the exact log events.
- **⚡ Insight + Performance**: Keep metrics lightweight on hot paths; use logs for rich context when needed.
Together, logs answer “what happened?” while metrics quantify “how often?” and “how fast?”.
## Installation
For detailed installation instructions, please refer to the [Installation Guide](https://github.com/kasianov-mikhail/scout/wiki).
## Usage
```swift
import Logging
let logger = Logger(label: "SOME_LOGGER_LABEL")
logger.warning(
"event_to_know_about",
metadata: [
"description": .string(error.localizedDescription),
"ip": .string(ip),
]
)
```
## Visualizing the Logs
By integrating `HomeView` into your SwiftUI application, you can gain insights into your application's performance and issues through an intuitive and interactive interface.
```swift
HomeView(container: container)
```
> This should be done only in debug mode to avoid exposing sensitive log data in production environments.
| | | |
| ------------- | ------------- | ------------- |
|  |  |  |
## Example Project
You can find an example project demonstrating the integration of Scout with CloudKit in the [Scout IP repository](https://github.com/kasianov-mikhail/scout-ip). This project provides a comprehensive example of how to set up and use Scout for logging in a real-world application.
## License
Scout is released under the MIT License. See [LICENSE](LICENSE) for details.