Awesome

<h1>EnalogSwift</h1>

Enalog for Swift is the Unofficial Swift Package made by <a href="https://twitter.com/mistermeenr">Joe Barbour</a> in collaboration with <a href="https://enalog.app/">Enalog & Enteka Software</a>.

<h3>Getting Started</h3> You can add this package to your project using Swift Package Manager. Enter the following url when adding it to your project package dependencies: <pre>https://github.com/thebarbican19/EnalogSwift</pre>

<h3>Introduction</h3> EnalogSwift requires an Enalog Account and an API Key which can all be created for free <a href="https://dash.enalog.app/organisation">here</a>. Once you have obtained an API Key and created a project in the Enalog Dashboard, you must specify these in the <code>info.plist</code> in your Swift application. To paste this directly into the <code>info.plist</code> right-click on the <code>info.plist</code> file in Xcode and choose Open As > Source Code

<key>EN_PROJECT_NAME</key>
<string>SprintDock</string>
<key>EN_API_KEY</key>
<string>$(SD_ENALOG_KEY)</string>

Declare the Library <code>import EnalogClient</code>

<h3>User Metadata</h3> For tracking each event in Enalog by user attributes it's important to call the user function. Here you can pass an UserID (required), Email Address & Name Additionally, you can also pass Any object that conforms to the <code>Codable</code> protocol.

struct UserObject:Codable {
    let id = "@MisterMeenr"
    let name = "Mojito Joe"
    let email = "joe@sprintdock.app"
    var plan:String
                                
}
                            
let user:UserObject = .init(plan: "PREMIUM")

EnalogManager.main.user(user.id, name: user.name, email: user.email, metadata: user)

<h3>Tracking Events</h3> Creating & Tracking events can be achieved by calling the <code>EnalogManager.main.ingest()</code> function. This function takes the following parameters... <li>Event ID (Enum)</li> <li>Description (String)</li> <li>Tags (Array<String>)</li> <li>Metadata (AnyObject)</li> <li>Channel (EnalogChannelObject)</li>

First, you must create an Enum with all your Event ID's. This can be named anything.

enum EnalogEvents:String {
    case myNewEvent = "new.event"
    case fatalErrors = "fatal.error"
    case purchaseEvent = "purchase.event"

}

Once you have added this, you can call... <code>EnalogManager.main.ingest(EnalogEvents.myNewEvent, description:"This is a description")</code> Additionally, you can add Tags by calling... <code>EnalogManager.main.ingest(EnalogEvents.myNewEvent, description:"This is a description", tags:["My Tag 1", "My Tag 2"])</code> And like when specifying User Metadata, you can specify additional Metadata with AnyObject the conforms to the codable protocol. <pre> struct PurchaseEvent:Codable { let product:String let cost:Double

}

let product:PurchaseEvent = .init(product:"SprintDock License", cost:95.00)

EnalogManager.main.ingest(EnalogEvents.purchaseEvent, description:"A product was purchased", metadata:product)</pre>

<h3>Crash Logging</h3> EnalogSwift can also notify you of crashes in your App. When enabled, additional metadata is sent which includes the reason. To enable crash logging, you call the <code>crash</code>. This takes an <code>enum</code> just like the <code>ingest</code> function. <pre> EnalogManager.main.crash(EnalogEvents.fatalError) EnalogManager.main.crash(EnalogEvents.fatalError, channel: .init(.slack, id:"MY CHANNEL")) </pre>

<h3>Throttling</h3> Throttling stops duplicate ingests and unnecessary requests to the server. By default, this is set to **10 requests per minute**. This limit can be changed by passing an <code>Int</code> the <code>throttle</code> function <code>EnalogManager.main.throttle(perMinute: 0)</code> This limit is capped at 20 ingest requests per second.

<h3>Disabling</h3> You can turn off all event tracking if you are running in a debug environment or running tests manually. <code>EnalogManager.main.disable(true)</code>

<h3>Logging & Debugging</h3> Logging & Debugging are available in EnalogSwift. This can be toggled on and off at any point by calling <code>EnalogManager.main.debug(true)</code>By default, this will output all logs in the Xcode console. For additional granularity, you can pass .fatal <code>EnalogManager.main.debug(true, logType:.fatal)</code>. This will call a FatalError exception whenever an error occurs.This should not be used in Production. Debug is automatically enabled when running in Xcode. <h3>Version Support</h3>

EnalogSwift runs on all Apple device architectures, including VisionOS!

MacOS 10.15+ (Silicon & Intel)
iOS 13.0+
watchOS 6.0+
tvOS 13.0+
visionOS 1.0+

Enalog also has official Libraries in <a href="https://enalog.app/docs/sdks/python/">Python</a> <a href="https://enalog.app/docs/sdks/node-js/">Node.js</a> & <a href="https://enalog.app/docs/sdks/go/">Go</a>. For more information, visit the <a href="https://enalog.app/docs/">official documentation</a>.