XNLogger is network logging framework, which can be easily extended and modified as per requirements. It can be formatted to log just url or complete network traffic details. It provides in-app logger UI for debugging and testing purpose. Logs can be written on files, print on Xcode console, send to network or use inbuild logger UI. Network logger UI appears in app with shake gesture on device and simulators.

Network loggers can generate huge data specially when binary data(like image, video, etc.) logging is enabled, this can increase memory usage and may result in app crash. To avoid such situation XNLogger is designed to use memory efficiently, it write logs on disk and only on requirement loads in memory.

Features

Screenshots

Network Log list	Request details	Response details

Share	Multimedia preview	Mini view mode(PIP)

Requirements

iOS 12.0 or later

Installation

Cocoapods

pod 'XNLogger'

To integrate with project only for debug configuration

pod 'XNLogger', :configurations => ['Debug']

Carthage

github "https://github.com/sunilsharma08/XNLogger"

Manually

Drag the folder "XNLogger" with the source files into your project.

Remove file called "Info.plist" inside folder "XNLogger", you might get error due to this.
Go to file "XNLoader.m" and replace import statement from "XNLogger/XNLogger-Swift.h" to <Your-app-target-name>-Swift.h. For example your app target name is AwesomeApp, then import statement will be

#import "AwesomeApp-Swift.h"

For more details on how to bridge swift code in Objectiv-C file check this apple doc - Importing Swift into Objective-C

Usage

Logging starts automatically after integration in project. Press CTRL + X or shake device/simulator(Device -> Shake) to see logs in app.

Start Logging manually

XNLogger.shared.startLogging()

Stop Logging

XNLogger.shared.stopLogging()

To use logger only for debug configuration wrap logger code in preprocessor macros #if DEBUG as

#if DEBUG
    XNLogger.shared.startLogging()
#endif

Show XNLogger UI

XNUIManager.shared.presentUI()

Hide XNLogger UI

XNUIManager.shared.dismissUI()

Clear logs

XNUIManager.shared.clearLogs()

Add predefined log handlers

Console handler

let consoleLogHandler = XNConsoleLogHandler.create()
XNLogger.shared.addLogHandlers([consoleLogHandler])

File handler

let fileLogHandler = XNFileLogHandler.create() //Default file name 'XNNetworkLog'
// File log handler can be created with filename
let fileLogHandler = XNFileLogHandler.create(fileName: "AppNetworkLogs")

XNLogger.shared.addLogHandlers([fileLogHandler])

Remove log handlers

XNLogger.shared.removeHandlers([consoleLogHandler])

Filters

Filters can be applied to loggers and handlers. Filters added to loggers will be applicable to all handlers and also requests does not pass through XNLogger whereas filters added to handlers will be recorded but will be logged to only applicable handlers. Filters added to one handler are not applicable on other handlers. Addings filters to logger is useful when it is required to skip all handlers or wanted to record/skip some specific urls.

Add filters to logger(universal filter)

let httpScheme = XNSchemeFilter(scheme: "https")
XNLogger.shared.addFilters([httpScheme])

Remove filters from logger(universal filter)

XNLogger.shared.removeFilters([httpScheme])

Add filters to handler

let host = XNHostFilter(host: "www.example.com")
consoleHandler.addFilters([host])

Remove filters from handler

consoleHandler.removeFilters([host])

Any filters can be inverted, so lets suppose all http scheme url should not appear in log then just update filter property invert to true as:

let httpScheme = XNSchemeFilter(scheme: "https")
httpScheme.invert = true

Formatters

By default logger logs all informations except binary data. These setting can be adjusted as per requirement. Formatter allows to control what fields to log and what to skip. Formatter class XNLogFormatter has following properties:

public var showRequest: Bool = true // Hide or show requests log.
public var showResponse: Bool = true // Hide or show response log.
public var showReqstWithResp: Bool = false // Show request with response, useful when `showRequest` is disabled.
public var showCurlWithReqst: Bool = true // Show curl request with request log.
public var showCurlWithResp: Bool = true // Show curl request when url request is displayed with response.
public var prettyPrintJSON: Bool = true // Log pretty printed json data .
public var logUnreadableRespBody: Bool = false // Show binary data like image, video, etc in response.
public var logUnreadableReqstBody: Bool = false // Show binary data like image, video, etc in request body.
public var showReqstMetaInfo: [XNRequestMetaInfo] = XNRequestMetaInfo.allCases // Details to be displayed in request log portion.
public var showRespMetaInfo: [XNResponseMetaInfo] = XNResponseMetaInfo.allCases // Details to be displayed in response log portion.
public var showReqstMetaInfoWithResp: [XNRequestMetaInfo] = XNRequestMetaInfo.allCases // Details to display for request when display as response portion.

Limitations

Does not log background url session tasks.
WKWebView urls will be not logged.

Trying to log background tasks and WKWebView urls without using any private API. These limitation may be removed in next releases.

Contribution

Feel free to raise PR for any bug fixes, features or enchancements. When you are done with changes raise PR to develop branch.

Another way to contribute to the project is to send a detailed issue when you encounter a problem. In bug detail please provide steps to reproduce and some other details like Swift version, url(if possible), URLSession configuration, etc.

License

XNLogger is available under the MIT license.

sunilsharma08 / xnlogger Goto Github PK

xnlogger's Introduction