Glider is the logger for just about everything; it's like winston.js but for mobile!

Glider is designed to be a simple, performant, universal logging library supporting multiple transports.
A transport is essentially a storage device for your logs.

Each logger can have multiple transports configured at different levels; you can also customize how the messages are formatted.

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, HTTP, Logstash, SQLite, WebSocket, Console, File/Rotating Files, POSIX, swift-log, sentry.io...)
✏️ 7+ customizable formatters for log messages (JSON, Fields based), MsgPack, Syslog)...)
🚀 A simple API set with an extensible architecture to suit your need
📚 A fully documented code (check out our DoCC site!)
⚙️ An extensive unit test suite

One Line Implementation

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).

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.

// Logs an error (including stack trace)
logger.error?.write("Unexpected error has occurred!", 
                    extra: ["reason": error.localizedDescription, "info": extraInfoDict])

logger.info?.write { // Logs an event with a set of attached details
  $0.message = "User tapped Buy button"
  $0.object = encodableProduct
  $0.extra = ["price": price, "currency": currency]
  $0.tags = ["productId", pID]
}

APIs Documentation

APIs are thoroughly documented using Apple DoCC.
Click here to read it.

Guide

The following manual will guide you through using Glider for your project.

Introduction

Event Formatters

Data Transports

Network Sniffer

NetWatcher package offers the ability to capture your app's network traffic (including requests/responses) and redirect them to a specific transport.
It's fully integrated with Glider and simple to use.

Network Sniffer
- Introduction
- Installation
- Capture Taffic
  - NetWatcherDelegate
- Transports
  - NetSparseFilesTransport
  - NetArchiveTransport

Help Us!

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

Installation

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.

dependencies: [
    .package(url: "https://github.com/malcommac/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:

source 'https://github.com/CocoaPods/Specs.git'
use_frameworks!

pod 'GliderLogger'

Powered Apps

Glider was created by the amazing mobile team at ImmobiliareLabs, 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, we'll add below.

Support & Contribute

Made with ❤️ by ImmobiliareLabs & 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.

License

itsyoshio/Glider

ErrorLooks like something went wrong!

About

Resources

License

Uh oh!

Stars

Watchers

Forks

Releases

Packages 0

Languages

Error
Looks like something went wrong!

Packages