Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/greensyntax/nimbus-monitor
iOS Developer Tool
https://github.com/greensyntax/nimbus-monitor
Last synced: 6 days ago
JSON representation
iOS Developer Tool
- Host: GitHub
- URL: https://github.com/greensyntax/nimbus-monitor
- Owner: greenSyntax
- License: mit
- Created: 2023-12-07T03:54:17.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-07-23T18:34:53.000Z (6 months ago)
- Last Synced: 2024-07-23T21:46:40.935Z (6 months ago)
- Language: Swift
- Size: 90.8 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Nimbus Monitor 🐝
Keeping an eye on network traffic is crucial for optimizing app performance and ensuring a seamless user experience. In this blog post, we introduce a powerful plug-and-play library for HTTP network traffic monitoring. Designed to be easy to integrate and use, this library not only helps you monitor network activity but also includes features for adding debug logs and tracking event analytics.
## Features
- [x] API Traffic Monitor
- [x] Analytics Instrumentation Tracking
- [x] Debug Console Logs
## Why Monitor HTTP Network Traffic?
Understanding your app’s network behavior is essential for diagnosing issues, optimizing performance, and improving overall user experience. By monitoring HTTP traffic, you can:
• Identify Bottlenecks: Spot slow or failing requests that could degrade app performance.
• Debug Issues: Gain insights into network-related bugs and errors.
• Optimize Usage: Analyze data usage patterns to optimize network efficiency.
• Enhance Security: Detect and respond to suspicious network activity.
## Installation
nimbus-sdk is available through [CocoaPods](https://cocoapods.org). To install
it, simply add the following line to your Podfile:
```ruby
pod 'NimbusMonitor', :git => '[email protected]:greenSyntax/nimbus-monitor.git', :tag => '1.0.9'
```
## Integration
You just need to write a single line of code -
```swift
NimbussService().monitor()
```
## Customization
You can write something similar,
```swift
import Foundation
import NimbusMonitor
import Alamofire
final class DebugMonitor {
private let nimbus = NimbussService()
static let shared = DebugMonitor()
private init() {
nimbus.monitor()
startNetworkTrafficMonitoring()
}
/// Log Analytics Data or Instrumentaion
/// - Parameters:
/// - eventName: EventName
/// - attributes: Attributes Payload
func logEvent(_ eventName: String, _ attributes: [String: Any]) {
#if DEBUG
nimbus.write(.instrumentation(InstrumentationLog(eventName, attributes)))
#endif
}
/// Log HTTP API Response
/// - Parameters:
/// - statusCode: HTTP Response
/// - httpVerb: HTTP Vern
/// - endpoint: API Endpoint
/// - queryParams: Request Query Params
/// - baseURL: Base URL
/// - headers: HTTP Headers
/// - responseData: HTTP Response Data in JSON
func logNetworkTraffic(statusCode: String, httpVerb: String, endpoint: String, queryParams: [String: Any], baseURL: String, headers: [String: String], responseData: Data ) {
#if DEBUG
nimbus.write(.network(NetworkLog(statusCode: statusCode, httpVerb: httpVerb, endpoint: endpoint, queryParams: queryParams, baseURL: baseURL, headers: headers, jsonRepsonse: responseData)))
#endif
}
/// Just Debug Logs which you want to watch
/// - Parameters:
/// - tag: TAG NAME like DEBUG, INFO, ERROR and WARNING
/// - title: Title Text
/// - content: Content Text
func debug(_ tag: String = "debug", _ title: String, _ content: String) {
#if DEBUG
nimbus.write(.debug(Log(tag: tag, title: title, body: content)))
#endif
}
}
extension DebugMonitor {
/// Monitor HTTP Traffic from Alamofire
func startNetworkTrafficMonitoring() {
NotificationCenter.default.addObserver(self, selector: #selector(processAlamofireResponseData), name: Alamofire.Request.didCompleteTaskNotification, object: nil)
}
@objc private func processAlamofireResponseData(_ notificatio: Notification) {
guard let request = notificatio.request as? DataRequest else { return }
self.logNetworkTraffic(statusCode: "\(request.response?.statusCode ?? 0)", httpVerb: request.request?.httpMethod ?? "NA", endpoint: request.request?.url?.lastPathComponent ?? "NA", queryParams: [:], baseURL: request.request?.url?.absoluteString ?? "NA", headers: request.request?.allHTTPHeaderFields ?? [:], responseData: request.data ?? Data())
}
}
```
## Author
Abhishek Ravi 🌵
## License
NimbusMonitor is available under the MIT license. See the LICENSE file for more info.