https://github.com/bugfender/bugfendersdk-macos
[BETA] Bugfender SDK for macOS, remotely access your application logs
https://github.com/bugfender/bugfendersdk-macos
Last synced: 3 months ago
JSON representation
[BETA] Bugfender SDK for macOS, remotely access your application logs
- Host: GitHub
- URL: https://github.com/bugfender/bugfendersdk-macos
- Owner: bugfender
- License: other
- Created: 2017-07-21T10:20:07.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2019-04-09T14:17:38.000Z (about 6 years ago)
- Last Synced: 2025-01-08T16:02:42.274Z (5 months ago)
- Language: Objective-C
- Size: 824 KB
- Stars: 0
- Watchers: 5
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
Bugfender SDK for macOS [](http://cocoadocs.org/docsets/BugfenderSDK/)
===================
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 console](https://app.bugfender.com/). You'll need an account.
BugfenderSDK works for iOS 8.0 and better.
# Installing the SDK
First of all you will need to add the framework to your project.
## Manual
If you prefer to install the SDK manually:
1. Go to your **Project** > **Your Target** > **General** > **Linked Frameworks and Libraries** and drag `BugfenderSDK.framework` there.
1. Make sure you have `SystemConfiguration.framework` and `MobileCoreServices.framework` there as well.
1. [Add -ObjC to your linker flags](https://developer.apple.com/library/mac/qa/qa1490/_index.html).
1. _(If using Swift)_ Import [Bugfender.swift](https://raw.githubusercontent.com/bugfender/BugfenderSDK-iOS/master/swift/Bugfender.swift) helper file to your project. Add an `import BugfenderSDK` statement at the top.
# Using Bugfender
Once you have the framework in your project, here is how to use it.
## Swift
In your AppDelegate class:
```Swift
import BugfenderSDK
```
And add the following to `application(_:didFinishLaunchingWithOptions:)`:
```Swift
Bugfender.activateLogger("YOUR_APP_KEY")
Bugfender.enableUIEventLogging() // optional, log user interactions automatically
BFLog("Hello world!") // use BFLog as you would use NSLog
```
Then you may use `BFLog` as you would normally use `NSLog`.
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 enableUIEventLogging]; // optional, log user interactions automatically
BFLog("Hello world!") // use BFLog as you would use NSLog
...
}
```
Then you may use `BFLog` as you would normally use `NSLog`.
You may also want to specify a logging level by using the following macros:
- `BFLog(...)`: Default log.
- `BFLogWarn(...)`: Warning log.
- `BFLogErr(...)`: Error log.
# Advanced features
Check out the full documentation at [CocoaDocs](http://cocoadocs.org/docsets/BugfenderSDK/).
## 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:
```objective-c
+(void)sendIssueWithTitle:(NSString*)title text:(NSString*)text;
```
*The `text` parameter has Markdown notation support on the server, so you can add some style to the text being sent.*
Here you have an example on how to send an issue using Markdown for the text:
```objective-c
[Bugfender sendIssueWithTitle:@"App Error" text:@"We have found an **Error**, we need to check it"];
```
## 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:
```objective-c
[Bugfender setDeviceString:@"[email protected]" forKey:@"user email"];
```
You can find more information in our blog post [Associated device information](https://bugfender.com/blog/associated-device-information/).
## Device identifier
Bugfender automatically generates an identifier for the application install in a device. You can retrieve it to show in your UI or send to your server:
```objective-c
NSString *bugfenderDeviceIdentifier = [Bugfender deviceIdentifier];
```
To help your users find the device identifier, one easy way to do it is adding it to the app's user defaults, so it shows up in the app's section inside the device Settings.
```objective-c
// Displaying the device identifier in the app's settings.
[[NSUserDefaults standardUserDefaults] setObject:[Bugfender deviceIdentifier] forKey:@"bugfenderDeviceIDKey"];
[[NSUserDefaults standardUserDefaults] synchronize];
```
## 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`.
```objective-c
// Setting maximum cache size to 1 Mb
[Bugfender setMaximumLocalStorageSize:1024*1024];
```