Skip to content
This repository was archived by the owner on Aug 2, 2023. It is now read-only.

Commit f4dd048

Browse files
author
chrwend
committed
Merge tag '4.1.0' into develop
4.1.0
2 parents 90259dc + c66340a commit f4dd048

File tree

5 files changed

+105
-30
lines changed

5 files changed

+105
-30
lines changed

‎HockeySDK-Mac.podspec

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
Pod::Spec.new do |s|
22
s.name = 'HockeySDK-Mac'
3-
s.version = '4.1.0-beta.4'
3+
s.version = '4.1.0'
44

55
s.summary = 'Collect live crash reports, get feedback from your users, distribute your betas, and get usage data.'
66
s.description = <<-DESC

‎README.md

Lines changed: 38 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
[![Build Status](https://travis-ci.org/bitstadium/HockeySDK-iOS.svg?branch=develop)](https://travis-ci.org/bitstadium/HockeySDK-Mac)
22

3-
## Version 4.1.0-beta.4
3+
## Version 4.1.0
44

5-
- [Changelog](http://www.hockeyapp.net/help/sdk/mac/4.1.0-beta.4/docs/docs/Changelog.html)
5+
- [Changelog](http://www.hockeyapp.net/help/sdk/mac/4.1.0/docs/docs/Changelog.html)
66

77
**NOTE:** With the release of HockeySDK 4.0.0-alpha.1 a bug was introduced which lead to the exclusion of the Application Support folder from iCloud and iTunes backups.
88

@@ -16,7 +16,7 @@ The following feature is currently supported:
1616

1717
1. **Collect crash reports:** If you app crashes, a crash log with the same format as from the Apple Crash Reporter is written to the device's storage. If the user starts the app again, he is asked to submit the crash report to HockeyApp. This works for both beta and live apps, i.e. those submitted to the App Store!
1818

19-
2. **User Metrics:** Understand user behavior to improve your app. Track usage through daily and monthly active users, monitor crash impacted users, as well as customer engagement through session count. If you are part of [Preseason](hockeyapp.net/preseason), you can now track Custom Events in your app, understand user actions and see the aggregates on the HockeyApp portal.
19+
2. **User Metrics:** Understand user behavior to improve your app. Track usage through daily and monthly active users, monitor crash impacted users, as well as customer engagement through session count. You can now track Custom Events in your app, understand user actions and see the aggregates on the HockeyApp portal.
2020

2121
3. **Feedback:** Collect feedback from your users from within your app and communicate directly with them using the HockeyApp backend.
2222

@@ -273,7 +273,7 @@ HockeyApp automatically provides you with nice, intelligible, and informative me
273273

274274
- **Sessions**: A new session is tracked by the SDK whenever the containing app is restarted (this refers to a 'cold start', i.e. when the app has not already been in memory prior to being launched) or whenever it becomes active again after having been in the background for 20 seconds or more.
275275
- **Users**: The SDK anonymously tracks the users of your app by creating a random UUID that is then securely stored in the iOS keychain. Because this anonymous ID is stored in the keychain it persists across reinstallations.
276-
- **Custom Events**: If you are part of [Preseason](https://www.hockeyapp.net/preseason/), you can now track Custom Events in your app, understand user actions and see the aggregates on the HockeyApp portal.
276+
- **Custom Events**: You can now track Custom Events in your app, understand user actions and see the aggregates on the HockeyApp portal.
277277

278278
Just in case you want to opt-out of the automatic collection of anonymous users and sessions statistics, there is a way to turn this functionality off at any time:
279279

@@ -309,7 +309,39 @@ metricsManager.trackEventWithName(eventName)
309309
- Accepted characters for tracking events are: [a-zA-Z0-9_. -]. If you use other than the accepted characters, your events will not show up in the HockeyApp web portal.
310310
- There is currently a limit of 300 unique event names per app per week.
311311
- There is _no_ limit on the number of times an event can happen.
312-
312+
313+
#### 3.3.2 Attaching custom properties and measurements to a custom event
314+
315+
It's possible to attach porperties and/or measurements to a custom event.
316+
317+
- Properties have to be a string.
318+
- Measurements have to be of a numeric type.
319+
320+
**Objective-C**
321+
322+
```objectivec
323+
BITMetricsManager *metricsManager = [BITHockeyManager sharedHockeyManager].metricsManager;
324+
325+
NSDictionary *myProperties = @{@"Property 1" : @"Something",
326+
@"Property 2" : @"Other thing",
327+
@"Property 3" : @"Totally different thing"};
328+
NSDictionary *myMeasurements = @{@"Measurement 1" : @1,
329+
@"Measurement 2" : @2.34,
330+
@"Measurement 3" : @2000000};
331+
332+
[metricsManager trackEventWithName:eventName properties:myProperties measurements:myMeasurements]
333+
```
334+
335+
**Swift**
336+
337+
```swift
338+
let myProperties = ["Property 1": "Something", "Property 2": "Other thing", "Property 3" : "Totally different thing."]
339+
let myMeasurements = ["Measurement 1": 1, "Measurement 2": 2.3, "Measurement 3" : 30000]
340+
341+
let metricsManager = BITHockeyManager.sharedHockeyManager().metricsManager
342+
metricsManager.trackEventWithName(eventName, properties: myProperties, myMeasurements: measurements)
343+
```
344+
313345
<a name="feedback"></a>
314346
### 3.4 Feedback
315347

@@ -386,7 +418,7 @@ To check if data is send properly to HockeyApp and also see some additional SDK
386418
<a id="documentation"></a>
387419
## 4. Documentation
388420

389-
Our documentation can be found on [HockeyApp](http://hockeyapp.net/help/sdk/mac/4.1.0-beta.4/index.html).
421+
Our documentation can be found on [HockeyApp](http://hockeyapp.net/help/sdk/mac/4.1.0/index.html).
390422

391423
<a id="troubleshooting"></a>
392424
## 5.Troubleshooting

‎Support/buildnumber.xcconfig

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
#include "HockeySDK.xcconfig"
22

3-
BUILD_NUMBER = 56
4-
VERSION_STRING = 4.1.0-beta.4
3+
BUILD_NUMBER = 57
4+
VERSION_STRING = 4.1.0
55
GCC_PREPROCESSOR_DEFINITIONS = $(inherited) BITHOCKEY_VERSION="@\""$(VERSION_STRING)"\"" BITHOCKEY_BUILD="@\""$(BUILD_NUMBER)"\"" BITHOCKEY_C_VERSION="\""$(VERSION_STRING)"\"" BITHOCKEY_C_BUILD="\""$(BUILD_NUMBER)"\"" $(XCODEBUILD_GCC_PREPROCESSOR_DEFINITIONS)

‎docs/Changelog-template.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
## 4.1.0
2+
3+
[NEW] Add ability to track custom events
4+
[NEW] Additional API to track an event with properties and measurements.
5+
16
## 4.1.0-beta.4
27

38
Add a bugfix from version 4.0.3:

‎docs/Guide-Installation-Setup-template.md

Lines changed: 59 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
1-
## Version 4.1.0-beta.4
1+
## Version 4.1.0
22

3-
- [Changelog](http://www.hockeyapp.net/help/sdk/mac/4.1.0-beta.4/docs/docs/Changelog.html)
3+
- [Changelog](http://www.hockeyapp.net/help/sdk/mac/4.1.0/docs/docs/Changelog.html)
44

55
**NOTE:** With the release of HockeySDK 4.0.0-alpha.1 a bug was introduced which lead to the exclusion of the Application Support folder from iCloud and iTunes backups.
66

77
If you have been using one of the affected versions (4.0.0-alpha.2, Version 4.0.0-beta.1, 4.0.0, 4.1.0-alpha.1, 4.1.0-alpha.2, or Version 4.1.0-beta.1), please make sure to update to at least version 4.0.1 or 4.1.0-beta.2 of our SDK as soon as you can.
88

9+
910
## Introduction
1011

1112
This document contains the following sections:
@@ -76,7 +77,7 @@ From our experience, 3rd-party libraries usually reside inside a subdirectory (l
7677
2. Add the following line at the top of the file below your own `import` statements:
7778

7879
```objectivec
79-
@import HockeySDK
80+
@import HockeySDK;
8081
```
8182

8283
3. Search for the method `applicationDidFinishLaunching:`
@@ -235,38 +236,38 @@ The `BITCrashManagerDelegate` protocol (which is automatically included in `BITH
235236

236237
Make sure to implement the protocol
237238

238-
```objectivec
239-
@interface YourAppDelegate () <BITHockeyManagerDelegate> {}
240-
241-
@end
242-
```
239+
```objectivec
240+
@interface YourAppDelegate () <BITHockeyManagerDelegate> {}
241+
242+
@end
243+
```
243244

244245
and set the delegate:
245246

246-
```objectivec
247-
[[BITHockeyManager sharedHockeyManager] configureWithIdentifier:@"APP_IDENTIFIER"];
248-
249-
[[BITHockeyManager sharedHockeyManager] setDelegate: self];
250-
251-
[[BITHockeyManager sharedHockeyManager] startManager];
252-
```
253-
247+
```objectivec
248+
[[BITHockeyManager sharedHockeyManager] configureWithIdentifier:@"APP_IDENTIFIER"];
249+
250+
[[BITHockeyManager sharedHockeyManager] setDelegate: self];
251+
252+
[[BITHockeyManager sharedHockeyManager] startManager];
253+
```
254+
254255
<a name="user-metrics"></a>
255256
### 3.3 User Metrics
256257

257258
HockeyApp automatically provides you with nice, intelligible, and informative metrics about how your app is used and by whom.
258259

259260
- **Sessions**: A new session is tracked by the SDK whenever the containing app is restarted (this refers to a 'cold start', i.e. when the app has not already been in memory prior to being launched) or whenever it becomes active again after having been in the background for 20 seconds or more.
260261
- **Users**: The SDK anonymously tracks the users of your app by creating a random UUID that is then securely stored in the iOS keychain. Because this anonymous ID is stored in the keychain it persists across reinstallations.
261-
- **Custom Events**: If you are part of [Preseason](https://www.hockeyapp.net/preseason/), you can now track Custom Events in your app, understand user actions and see the aggregates on the HockeyApp portal.
262+
- **Custom Events**: You can now track Custom Events in your app, understand user actions and see the aggregates on the HockeyApp portal.
262263

263264
Just in case you want to opt-out of the automatic collection of anonymous users and sessions statistics, there is a way to turn this functionality off at any time:
264265

265266
```objectivec
266267
[BITHockeyManager sharedHockeyManager].disableMetricsManager = YES;
267268
```
268269

269-
#### 3.7.1 Custom Events
270+
#### 3.3.1 Custom Events
270271

271272
By tracking custom events, you can now get insight into how your customers use your app, understand their behavior and answer important business or user experience questions while improving your app.
272273

@@ -295,6 +296,38 @@ metricsManager.trackEventWithName(eventName)
295296
- There is currently a limit of 300 unique event names per app per week.
296297
- There is _no_ limit on the number of times an event can happen.
297298

299+
#### 3.3.2 Attaching custom properties and measurements to a custom event
300+
301+
It's possible to attach porperties and/or measurements to a custom event.
302+
303+
- Properties have to be a string.
304+
- Measurements have to be of a numeric type.
305+
306+
**Objective-C**
307+
308+
```objectivec
309+
BITMetricsManager *metricsManager = [BITHockeyManager sharedHockeyManager].metricsManager;
310+
311+
NSDictionary *myProperties = @{@"Property 1" : @"Something",
312+
@"Property 2" : @"Other thing",
313+
@"Property 3" : @"Totally different thing"};
314+
NSDictionary *myMeasurements = @{@"Measurement 1" : @1,
315+
@"Measurement 2" : @2.34,
316+
@"Measurement 3" : @2000000};
317+
318+
[metricsManager trackEventWithName:eventName properties:myProperties measurements:myMeasurements]
319+
```
320+
321+
**Swift**
322+
323+
```swift
324+
let myProperties = ["Property 1": "Something", "Property 2": "Other thing", "Property 3" : "Totally different thing."]
325+
let myMeasurements = ["Measurement 1": 1, "Measurement 2": 2.3, "Measurement 3" : 30000]
326+
327+
let metricsManager = BITHockeyManager.sharedHockeyManager().metricsManager
328+
metricsManager.trackEventWithName(eventName, properties: myProperties, myMeasurements: measurements)
329+
```
330+
298331
<a name="feedback"></a>
299332
### 3.4 Feedback
300333

@@ -371,7 +404,7 @@ To check if data is send properly to HockeyApp and also see some additional SDK
371404
<a id="documentation"></a>
372405
## 4. Documentation
373406

374-
Our documentation can be found on [HockeyApp](http://hockeyapp.net/help/sdk/mac/4.1.0-beta.4/index.html).
407+
Our documentation can be found on [HockeyApp](http://hockeyapp.net/help/sdk/mac/4.1.0/index.html).
375408

376409
<a id="troubleshooting"></a>
377410
## 5.Troubleshooting
@@ -402,12 +435,17 @@ We're looking forward to your contributions via pull requests.
402435
* [AppleDoc](https://github.com/tomaz/appledoc)
403436
* [Cocoapods](https://cocoapods.org/)
404437

438+
<a id="codeofconduct"></a>
439+
## 6.1 Code of Conduct
440+
441+
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
442+
405443
<a id="contributorlicense"></a>
406-
## 7. Contributor License
444+
## 6.2 Contributor License
407445

408446
You must sign a [Contributor License Agreement](https://cla.microsoft.com/) before submitting your pull request. To complete the Contributor License Agreement (CLA), you will need to submit a request via the [form](https://cla.microsoft.com/) and then electronically sign the CLA when you receive the email containing the link to the document. You need to sign the CLA only once to cover submission to any Microsoft OSS project.
409447

410448
<a id="contact"></a>
411-
## 8. Contact
449+
## 7. Contact
412450

413451
If you have further questions or are running into trouble that cannot be resolved by any of the steps here, feel free to open a Github issue here or contact us at [support@hockeyapp.net](mailto:support@hockeyapp.net)

0 commit comments

Comments
 (0)