Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/bugfender/BugfenderSDK-iOS

Bugfender SDK for iOS, a remote logger tailor-made for mobile
https://github.com/bugfender/BugfenderSDK-iOS

bugfender cocoapods ios ios-swift logging objective-c sdk

Last synced: 30 days ago
JSON representation

Bugfender SDK for iOS, a remote logger tailor-made for mobile

Lists

README 

        
Bugfender SDK for iOS [![Build Status](https://travis-ci.com/bugfender/BugfenderSDK-iOS.svg?branch=master)](https://travis-ci.com/bugfender/BugfenderSDK-iOS) [![Docs](https://img.shields.io/badge/docs-%E2%9C%93-blue.svg)](https://bugfender.github.io/BugfenderSDK-iOS/)

===================



Bugfender is a cloud service to collect mobile application logs. Developers can control log sending programmatically and manually for each device. Logs are available at the [Bugfender dashboard](https://dashboard.bugfender.com/). You'll need an account.



Supported iOS versions:

 * BugfenderSDK 1.12 works for iOS 11.0 and newer.

 * For iOS 10 support you can use BugfenderSDK 1.10.6.

 * For iOS 8 support you can use BugfenderSDK 1.8.



# Installing the SDK

First of all you will need to add the framework to your project.



## Using CocoaPods



1. Create a Podfile if you don't have one: `pod init`

2. Add Bugfender to your Podfile:

   ```

   pod 'BugfenderSDK', '~> 1.12'

   ```

3. Save the file and run: `pod install`. This creates an `.xcworkspace` file for your app. Use this file for all future development on your application.



## Using Swift Package Manager



1. In Xcode go to the target's `General` tab and press on the icon to add a new library

![](readme-images/spm/spm1.png)



2. In the popover choose `Add Other` and then `Add Package Dependency...`

![](readme-images/spm/spm2.png)



3. Paste the GitHub url from the Bugfender iOS repository `https://github.com/bugfender/BugfenderSDK-iOS` in the textfield and press `Next`

![](readme-images/spm/spm3.png)



4. Leave the first option checked and press `Next`

![](readme-images/spm/spm4.png)



5. Xcode will download the Bugfender files and you will be prompted with the following menu. Ensure BugfenderSDK is selected and press Finish

![](readme-images/spm/spm5.png)



6. Import `SystemConfiguration.framework`, `Security.framework`, `CoreServices.framework`, `CoreGraphics.framework` and `libc++.tbd` as well.



## Using Carthage

1. Update to at least Carthage 0.38.0

2. Add to your Cartfile:

   ```

   github "bugfender/BugfenderSDK-iOS" ~>1.12

   ```

3. Save the file and run `carthage update --use-xcframeworks`

4. Import `Carthage/Build/BugfenderSDK.xcframework` to your `Linked Frameworks and Libraries` (or drag-n-drop the file to your project).

5. Make sure to select the option "Embed framework" (or list the framework in `input.xcfilelist`).

6. Import `SystemConfiguration.framework`, `Security.framework`, `CoreServices.framework`, `CoreGraphics.framework` and `libc++.tbd` as well.



## Manual



If you prefer to install the SDK manually you can use the provided xcframework in the corresponding [release](https://github.com/bugfender/BugfenderSDK-iOS/releases).



1. Go to your **Project** > **Your Target** > **General** > **Frameworks, Libraries, and Embedded Content** and drag `BugfenderSDK.xcframework` there.

2. Make sure to select the option "Embed framework"

3. Make sure you have `SystemConfiguration.framework`, `Security.framework`, `CoreServices.framework`, `CoreGraphics.framework` and `libc++.tbd` there as well.



# Using Bugfender

Once you have the framework in your project, using it is as easy as using `BFLog()` instead of `NSLog()` or `bfprint()` instead `print()`.



## Swift



If your application uses SwiftUI and doesn't have an AppDelegate, you might need to create one like this:



```Swift

@main

struct YourAppNameApp: App {



    @UIApplicationDelegateAdaptor(AppDelegate.self) var appDelegate



    var body: some Scene {

        WindowGroup {

            ContentView()

        }

    }

}



class AppDelegate: NSObject, UIApplicationDelegate {

    func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey : Any]? = nil) -> Bool {

        // your Bugfender init code here



        return true

    }

}

```



In your AppDelegate class:



```Swift

@_exported import BugfenderSDK

```



And add the following to `application(_:didFinishLaunchingWithOptions:)`:



```Swift

Bugfender.activateLogger("YOUR_APP_KEY")

Bugfender.enableNSLogLogging() // optional, capture logs printed to console automatically

Bugfender.enableUIEventLogging() // optional, log user interactions automatically

Bugfender.enableCrashReporting() // optional, log crashes automatically

bfprint("Hello world!") // use bfprint() as you would use print()

```



Then you may use `BFLog` as you would normally use `NSLog` or `print`.



You may also want to specify a logging level by using the following helper functions:



- `Bugfender.print(...)`: Default log.

- `Bugfender.warning(...)`: Warning log.

- `Bugfender.error(...)`: Error log.



## Objective-C



Make Bugfender available project-wide by adding the following line to the `.pch` file:



```objective-c

#import 

```



Get an API key from the [Bugfender console](https://app.bugfender.com/). In your `AppDelegate` call [activateLogger](http://cocoadocs.org/docsets/BugfenderSDK/0.3.9/Classes/Bugfender.html#//api/name/activateLogger:) when the application starts, like this:



```objective-c

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions

{

    ...

    // Activate the remote logger with an App Key.

    [Bugfender activateLogger:@"YOUR_APP_KEY"];

    [Bugfender enableNSLogLogging]; // optional, capture logs printed to console automatically

    [Bugfender enableUIEventLogging]; // optional, log user interactions automatically

    [Bugfender enableCrashReporting]; // optional, log crashes automatically

    BFLog("Hello world!") // use BFLog as you would use NSLog

    ...

}

```



You may use `BFLog` as you would normally use `NSLog`.



You may also want to specify a logging level by using the following macros:



- `BFLogFatal(...)`: Fatal log.

- `BFLogErr(...)`: Error log.

- `BFLogWarn(...)`: Warning log.

- `BFLogInfo(...)`: Info log.

- `BFLog(...)`: Default (debug) log.

- `BFLogTrace(...)`: Trace log.



# Advanced features



## Sending issues



Bugfender allows you to send issues to the server. An issue is similar to a session but they are showed in the `issues` section and you can send issues any time from the app, even if the device is not enabled in the system. Issues are useful to keep track of important errors that you can detect in your code.



For sending an issue you can use the following function:



```swift

Bugfender.sendIssueReturningUrl(withTitle: "Issue title", text: "Description of the issue")



```



*Nothice that `text` supports Markdown notation on the server. You can add some style to the text.*



```swift

Bugfender.sendIssueReturningUrl(withTitle: "App Error", text: "We have found an **Error**, we need to check it")

```

Send issue returns an URL pointing to the issue in the Dashboard of Bugfender. You can use that URL to create automations.



## Having your app decide when to send logs



In some special circumstances you may want to send logs, regardless of the enabled state of the device in the Bugfender console, for example in a custom exception handler. Use `forceSendOnce` to force sending the logs once, and use `setForceEnabled:` to force it for some period of time.



## Device associated data

You can associate information to a device as if it were a dictionary:



```swift

Bugfender.setDeviceString("value", forKey: "key")

```



You can find more information in our blog post [Associated device information](https://bugfender.com/blog/associated-device-information/).



## Log buffer size



Bugfender keeps up to 5 MB worth of log data in the device. This way Bugfender can work offline, and you can get some log data from the past when enabling a device. You can change that limit with `setMaximumLocalStorageSize`.



```swift

// Setting maximum cache size to 1 Mb

Bugfender.setMaximumLocalStorageSize(1024*1024)

```



## Get Device Link



Sometimes you want to integrate Bugfender with a third party tool. For this purpose, the SDK provides a method that returns the URL for the current device. You can send it to the third party tool and easily navigate back to the logs of the device from the other tool.



```swift

Bugfender.deviceIdentifierUrl();

```



## Get Session Link



Sometimes you want to integrate Bugfender with a third party tool. For this purpose, the SDK provides a method that returns the URL for the session. You can send it to the third party tool to easily go to the logs of the current session from the other tool.



```objective-c

Bugfender.sessionIdentifierUrl();

```



# Collecting User feedback



Getting feedback from the final users is one of the most important things for an app developer. Good user feedback allows you detect errors in your app and helps you to understand better your product.



Starting from version 1.6, Bugfender provides a new feature to easily collect app feedback from final users. It takes only two minutes and a few lines of code to integrate. You can think about the User Feedback as a special kind of Issue, every time your users submit their feedback you will get a new issue in Bugfender.



![](https://raw.githubusercontent.com/bugfender/BugfenderSDK-iOS/master/docs/User-feedback-default.png)



The easiest way to implement Bugfender User Feedback is using the customizable User Feedback View Controller. It provides a convenient view controller with two text fields, one short for the subject and another bigger for the feedback. Both text fields grow autommatically.



## Using the default UI



Using the convenient UI provided by Bugfender requires only creating a new View Controller and presenting it modally. All you need is to call the following method and complete the required parameters with the title and placeholders for your UI.



```swift

// Instantiate new User Feedback



let nvc = Bugfender.userFeedbackViewController(withTitle: "Navigation bar title",

                                               hint: "Give some instructions to your users",

                                               subjectPlaceholder: "Placeholder for subject textfield",

                                               messagePlaceholder: "Placeholder for message textfield",

                                               sendButtonTitle: "Send",

                                               cancelButtonTitle: "Cancel") { (feedbackSent, url) in

    if (feedbackSent) {

        // Say thanks!

        // url is a direct link to the dashboard

        // Use it to create automations or send it to your server

    } else {

        // User decided to not send feedback

    }

}



// Present modally

self.present(nvc, animated: true, completion: nil)

```



Additionally, if you require more customization you can configure the view controller prior to presenting it.



*Please note BFUserFeedbackNavigationController is a subclass of navigation controller. You need to access the view controller using the public property feedbackViewController.*



```swift

// Access the root view controller.

let feedbackViewController: BFUserFeedbackViewController = nvc.feedbackViewController



// Change the background colors

feedbackViewController.mainBackgroundColor = UIColor.lightGray

feedbackViewController.secondaryBackgroundColor = UIColor.white



// Change the font of the hint text

feedbackViewController.hintFont = UIFont(name: "Avenir", size: 14)!

```

![](https://raw.githubusercontent.com/bugfender/BugfenderSDK-iOS/master/docs/User-feedback-custom.png)



For a complete list of customizable attributes you can inspect "BFUserFeedbackViewController.h" or [read the docs](http://bugfender.github.io/BugfenderSDK-iOS/).



## Using SwiftUI



Here is an example using the `BFUserFeedbackNavigationController` in SwiftUI:



```swift

struct SwiftUIView: View {

    @State private var showFeedbackScreen = false



    var body: some View {

        VStack {

            Text("Hello World!")

            Button("Show Feedback screen") {

                showFeedbackScreen = true

            }

        }.sheet(isPresented: $showFeedbackScreen) {

            FeedbackView() { sent, feedbackUrl in

                if sent == true,

                    let url = feedbackUrl{

                    BFLog("Sent feedback to URL: \(url.absoluteString)")

                } else {

                    BFLog("User rejected to send feedback")

                }

            }

        }.navigationBarTitle(Text("Swift UI Test"))

    }

}



struct SwiftUIView_Previews: PreviewProvider {

    static var previews: some View {

        SwiftUIView()

    }

}



struct FeedbackView: UIViewControllerRepresentable {

    typealias UIViewControllerType = BFUserFeedbackNavigationController



    let completion: (_ feedbackSent: Bool, _ feedbackUrl: URL?) -> Void



    func makeUIViewController(context: Context) -> BFUserFeedbackNavigationController {

        BFUserFeedbackNavigationController.userFeedbackViewController(

            withTitle: "This title",

            hint: "This hint",

            subjectPlaceholder: "This subject",

            messagePlaceholder: "This message",

            sendButtonTitle: "Send",

            cancelButtonTitle: "Cancel") { sent, feedbackUrl in

                completion(sent, feedbackUrl)

            }

    }



    func updateUIViewController(_ uiViewController: BFUserFeedbackNavigationController, context: Context) {}

}

```



## Using a custom UI



If you need further customization than provided by BFUserFeedbackViewController you can implement your own UI. All you have to do is collect your user feedback as you wish and send it to Bugfender using `sendUserFeedback`:



```swift

let feedbackUrl = Bugfender.sendUserFeedbackReturningUrl(withSubject: "Title of the feedback", message: "message of the feedback")

```

The returned URL is a direct link to the Bugfender's dashboard. Use it to create automations or to keep a reference in your servers.



## Updating from BugfenderSDK prior to 1.8 and ObjC only projects



BugfenderSDK is now a dynamic framework and you will need to check the "embed framework" option when adding it to your project manually or using Carthage.


 Additionally, the Bugfender.swift helper class is not needed anymore and can be safely deleted, however, Swift must be available in your project. If you are installing Bugfender manually or using Carthage ensure that *Build Settings -> Always Embed Swift Standard Libraries* is set to *YES*.



# Symbolicating crash reports

Bugfender provides a script is able to upload dSYM bundles to [Bugfender](https://bugfender.com).



## Obtain the script

The script is distributed if you are using Cocoapods or Swift Package Manager.



If you are using any other installation method you can download [the script](https://raw.githubusercontent.com/bugfender/BugfenderSDK-iOS/master/xcode-upload-symbols/upload-symbols.sh) and copy it into a location inside your project.



## Set up Xcode to automatically upload dSYM bundles

Use the [following instructions](https://github.com/bugfender/BugfenderSDK-iOS/blob/master/xcode-upload-symbols/README.md) to configure your project.