Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/immobiliare/glider
✈️ Universal Logging - low overheaded simple & flexible for Swift (iOS, macOS, tvOS)
https://github.com/immobiliare/glider
logger logging-library swift swiftui swiftybeaver winston-logger
Last synced: about 2 months ago
JSON representation
✈️ Universal Logging - low overheaded simple & flexible for Swift (iOS, macOS, tvOS)
- Host: GitHub
- URL: https://github.com/immobiliare/glider
- Owner: immobiliare
- License: mit
- Created: 2022-04-12T10:34:34.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-01-29T11:36:46.000Z (11 months ago)
- Last Synced: 2024-10-29T21:06:16.704Z (about 2 months ago)
- Topics: logger, logging-library, swift, swiftui, swiftybeaver, winston-logger
- Language: Swift
- Homepage:
- Size: 3.54 MB
- Stars: 57
- Watchers: 6
- Forks: 6
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://img.shields.io/badge/Swift-5.3_5.4_5.5_5.6-Orange?style=flat-square)
[](#installation)
[](https://img.shields.io/badge/Swift_Package_Manager-compatible-orange?style=flat-square)
[](https://img.shields.io/cocoapods/v/GliderLogger.svg)
**Glider is the logger for just about everything!**
It's designed to be:
- **SIMPLE**: with a modular & extensible architecture, fully documented
- **PERFORMANT**: you can use Glider without the worry of impacting your app performances
- **UNIVERSAL**: it supports 14+ transports to satisfy every need; you can create your transport too!
# Why logging?
Logging and monitoring are fundamental parts of our job as engineers.
Especially in the mobile world (with very heterogeneous environments), you'll often find yourself in a situation where understanding how your software behaves in production is essential.
That's the right job for logging: logged data provide valuable information that would be difficult to gather otherwise, unveil unexpected behaviors and bugs, and even if the data was adequately anonymized, identify the sequences of actions of singular users.
# Feature highlights
We loved making this open-source package and would see engineers like you using this software.
Those are five reasons you will love Glider:
- 🧩 14+ built-in, fully customizable transports to store your data ([ELK](https://github.com/immobiliare/Glider-ELK), [HTTP](https://github.com/immobiliare/Glider/tree/main/Glider/Sources/Transports/HTTPTransport), [Logstash](https://github.com/immobiliare/Glider/tree/main/Glider/Sources/Transports/LogstashTransport), [SQLite](https://github.com/immobiliare/Glider/tree/main/Glider/Sources/Transports/SQLiteTransport), [WebSocket](https://github.com/immobiliare/Glider/tree/main/Glider/Sources/Transports/WebSocketTransport), [Console](https://github.com/immobiliare/Glider/tree/main/Glider/Sources/Transports/Console), [File/Rotating Files](https://github.com/immobiliare/Glider/tree/main/Glider/Sources/Transports/File), [POSIX](https://github.com/immobiliare/Glider/tree/main/Glider/Sources/Transports/File/POSIXTransports), [swift-log](https://github.com/immobiliare/Glider-AppleSwiftLog), [sentry.io](https://github.com/immobiliare/Glider-Sentry)...)
- ✏️ 7+ customizable formatters for log messages ([JSON](https://github.com/immobiliare/Glider/tree/main/Glider/Sources/Formatters/JSONFormatter), [Fields based](https://github.com/immobiliare/Glider/tree/main/Glider/Sources/Formatters/FieldsFormatter)), [MsgPack](https://github.com/immobiliare/Glider/tree/main/Glider/Sources/Formatters/MsgPackFormatter), [Syslog](https://github.com/malcommac/Glider/tree/main/Glider/Sources/Formatters/SysLogFormatter))...)
- 🚀 A simple API set with an extensible architecture to suit your need
- 📚 A fully documented code via Apple's DocC ([link](https://swiftpackageindex.com/immobiliare/Glider))
- ⚙️ An extensive unit test suite
# What you get
Creating a logger is simple.
Each logger is an instance of the `Log` class; typically, you need to specify one or more transports (where the data is stored).
```swift
let logger = Log {
$0.subsystem = "com.my-awesome-app"
$0.category = "ui-events"
$0.level = .info
$0.transports = [ConsoleTransport()]
}
```
The following logger shows received messages - only warning or more severe - in the console.
```swift
// Logs an error (including stack trace)
logger.error?.write("Unexpected error has occurred!",
extra: ["reason": error.localizedDescription, "info": extraInfoDict])
// Logs an event with a set of attached details
logger.info?.write {
$0.message = "User tapped Buy button"
$0.object = encodableProduct
$0.extra = ["price": price, "currency": currency]
$0.tags = ["productId", pID]
}
```
## Transports
This the list of transport services officially supported.
Third party transports are available into the following separate repositories:
- [Glider-ELK](https://github.com/immobiliare/Glider-ELK): library provides a logging transport for glider and [ELK](https://www.elastic.co/elastic-stack?ultron=B-Stack-Trials-EMEA-S-Exact&gambit=Stack-ELK&blade=adwords-s&hulk=paid&Device=c&thor=elk%20stack&gclid=Cj0KCQjwjIKYBhC6ARIsAGEds-I1kAzd4o5RdmCR0U4yXPL4QFQXBCn1bRn-MjwZV0fkSXuFIIJ6VcwaAo1AEALw_wcB) stacks.
- [Glider-Sentry](https://github.com/immobiliare/Glider-Sentry): provides support to post log on [sentry.io](https://sentry.io/welcome/) instances using the native swift sdk.
- [Glider-AppleSwiftLog](https://github.com/immobiliare/Glider-AppleSwiftLog) can also work as a backend for [apple/swift-log](https://github.com/apple/swift-log/).
A separate transport is able to capture automatically every network request and forward to other transports:
- [Glider-NetWatcher](https://github.com/immobiliare/Glider-NetWatcher) offers the ability to capture your app's network traffic (including requests/responses) and redirect them to a specific transport.
## APIs
Glider is fully documented at source-code level. You'll get autocomplete with doc inside XCode for free; moreover, you can read the full Apple's DoCC Documentation automatically generated by [**Swift Package Index**](https://swiftpackageindex.com) project from here:
👉 [API REFERENCE](https://swiftpackageindex.com/immobiliare/Glider/main/documentation/glider)
👉 [PROJECT PAGE](https://swiftpackageindex.com/immobiliare/Glider)
# Guide
The following manual will guide you through using Glider for your project.
## Introduction
- [The Logger](./Documentation/Logger.md#the-logger)
- [Writing messages](./Documentation/Logger.md#writing-messages)
- [Writing simple messages](./Documentation/Logger.md#writing-simple-messages)
- [Writing messages using closures](./Documentation/Logger.md#writing-messages-using-closures)
- [Writing message by passing `Event`](./Documentation/Logger.md#writing-message-by-passing-event)
- [Message text composition](./Documentation/Logger.md#message-text-composition)
- [Disabling a Logger](./Documentation/Logger.md#disabling-a-logger)
- [Severity Levels](#severity-levels)
- [Synchronous and Asynchronous Logging](./Documentation/Logger.md#synchronous-and-asynchronous-logging)
- [Synchronous Logging](./Documentation/Logger.md#synchronous-logging)
- [Asynchronous Logging](./Documentation/Logger.md#asynchronous-logging)
## Event Formatters
- [Formatters](./Documentation/Formatters.md#formatters)
- [Archiving](./Documentation/Formatters.md#archiving)
- [FieldsFormatter](./Documentation/Formatters.md#fieldsformatter)
- [JSONFormatter](./Documentation/Formatters.md#jsonformatter)
- [MsgPackDataFormatter](./Documentation/Formatters.md#msgpackdataformatter)
- [User Display (Console/Terminals)](./Documentation/Formatters.md#user-display-consoleterminals)
- [TableFormatter](./Documentation/Formatters.md#tableformatter)
- [TerminalFormatter](./Documentation/Formatters.md#terminalformatter)
- [XCodeFormatter](./Documentation/Formatters.md#xcodeformatter)
- [SysLogFormatter](./Documentation/Formatters.md#syslogformatter)
## Data Transports
- [Transports](./Documentation/Transports.md#transports)
- [Introduction](./Documentation/Transports.md#introduction)
- [Base Transports](./Documentation/Transports.md#base-transports)
- [AsyncTransport](./Documentation/Transports.md#asynctransport)
- [BufferedTransport](./Documentation/Transports.md#bufferedtransport)
- [ThrottledTransport](./Documentation/Transports.md#throttledtransport)
- [Built-in Transports](./Documentation/Transports.md#built-in-transports)
- [ConsoleTransport](./Documentation/Transports.md#consoletransport)
- [OSLogTransport](./Documentation/Transports.md#oslogtransport)
- [POSIXStreamTransport](./Documentation/Transports.md#posixstreamtransport)
- [FileTransport](./Documentation/Transports.md#filetransport)
- [SizeRotationFileTransport](./Documentation/Transports.md#sizerotationfiletransport)
- [HTTPTransport](./Documentation/Transports.md#httptransport)
- [RemoteTransport](./Documentation/Transports.md#remotetransport)
- [RemoteTransportServer](./Documentation/Transports.md#remotetransportserver)
- [SQLiteTransport](./Documentation/Transports.md#sqlitetransport)
- [WebSocketTransport](./Documentation/Transports.md#websockettransport)
- [WebSocketTransportClient](./Documentation/Transports.md#websockettransportclient)
- [WebSocketTransportServer](./Documentation/Transports.md#websockettransportserver)
# Test Suite
Glider offers an extensive suite of unit tests for Glider Core Logger and third-party packages under the `/Tests` folder.
Moreover, the entire package is powered by [SwiftLint](https://github.com/realm/SwiftLint) for better code quality.
# Contribute
If you want to join this project, we're maintaining a list of new features we would like to implement into the following versions of Glider.
Please open an issue and discuss one of them with us!
- [ ] GliderViewer: a macOS, iPad & iPhone app to view and interact with logged data
- [ ] New Transports: we would like to extend the list of supported transports; feel free to propose your third-party transports
- [ ] Increment our code coverage by writing more tests
# Requirements
Glider can be installed on any platform which supports:
- Swift 5.0
- iOS 10, macOS 10.14, macCatalyst, tvOS 13
- Xcode 13.2
> NOTE:
> The following transports require newer OSs versions (iOS 13+, tvOS 13+ and macOS 10.15+):
> RemoteTransportServer, RemoteTransportServerClient
# Installation
Our preferred installation method is SPM but we're still support CocoaPods.
## Swift Package Manager
The Swift Package Manager is a tool for automating the distribution of Swift code and is integrated into the swift compiler. It is in early development, but Glider does support its use on supported platforms.
Once you have your Swift package set up, adding Glider as a dependency is as easy as adding it to the dependencies value of your `Package.swift`.
```swift
dependencies: [
.package(url: "https://github.com/immobiliare/Glider.git")
]
```
Manifest also includes third-party packages for other transports, like ELK or Sentry.
The Glider core SDK is the `Glider` package.
## CocoaPods
CocoaPods is a dependency manager for Cocoa projects.
To integrate Glider into your project, specify it in your Podfile:
```ruby
source 'https://github.com/CocoaPods/Specs.git'
use_frameworks!
pod 'GliderLogger'
```
## Powered Apps
Glider was created by the amazing mobile team at [ImmobiliareLabs](http://labs.immobiliare.it), the Tech dept at Immobiliare.it.
We are currently using Glider for logging in to all of our products.
**If you are using Glider in your app [drop us a message](mailto:[email protected])**
## Support & Contribute
Made with ❤️ by [ImmobiliareLabs](https://github.com/orgs/immobiliare) & [Contributors](https://github.com/immobiliare/Glider/graphs/contributors)
We'd love for you to contribute to Glider!
If you have questions on using Glider, bugs, and enhancement, please feel free to reach out by opening a [GitHub Issue](https://github.com/immobiliare/Glider/issues).
