SparkleProject/sparkle-project.github.io
1
0
Fork 0
mirror of https://github.com/sparkle-project/sparkle-project.github.io.git synced 2025-11-01 15:35:08 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update profiling

Browse Source
This commit is contained in:
Kornel Lesiński
2017-03-09 14:10:59 +00:00
parent a8404e3476
commit bd6f2b8d22
1 changed files with 5 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files
documentation/system-profiling/index.md
+5 -5
View File
@@ -5,14 +5,14 @@ title: System Profiling
---
## System Profiling
Thanks to the work of [Tom Harrington](http://atomicbird.com/), Sparkle now supports optionally sending anonymous information about the user's system with their update. Developers can use this information to better decide what platforms and hardware to support.
Sparkle supports optionally sending anonymous information about the user's system when checking for updates. Developers can use this information to better decide what platforms and hardware to support.
### Collected data
* macOS version
* CPU type/subtype (see mach/machine.h for decoder information on this data)
* Mac model
* Number of CPUs (or CPU cores, in the case of something like a Core Duo)
* Number of CPUs/CPU cores,
* 32-bit vs. 64-bit
* CPU speed
* RAM size
@@ -21,7 +21,7 @@ Thanks to the work of [Tom Harrington](http://atomicbird.com/), Sparkle now supp
* User's preferred language
* Anything else you'd like to send along (via a delegate method; see [Customizing Sparkle](/documentation/customization/))
This information will be provided via GET, so if your feed URL is `http://you.org/app.xml`, the request will be made to `http://you.org/app.xml?cpusubtype=4&ncpu=2&appName=App.app&cpuFreqMHz=1830[...]`.
This information will be provided via GET, so if your feed URL is `https://example.org/app.xml`, the request will be made to `https://example.org/app.xml?cpusubtype=4&ncpu=2&appName=App.app&cpuFreqMHz=1830[...]`.
**Note:** In order to standardize the statistics across a userbase with varying update check intervals, Sparkle submits profiling information only once per week.
@@ -29,9 +29,9 @@ This information will be provided via GET, so if your feed URL is `http://you.or
First, you've got to tell Sparkle you want this data to be sent. You can do this by adding a `SUEnableSystemProfiling` key to your app's Info.plist and setting its value to YES.
Next, you've got to put something up server-side to collate and display the submitted information in a useful way. Tom Harrington has written a PHP-based backend; you can [download it here](/files/php_sparkle_stats_server.zip). Backends based on other server-side languages would be very welcome, though!
Next, you've got to put something up server-side to collate and display the submitted information in a useful way (see the list below).
Finally, set the SUFeedURL to your server-side script (eg. profileInfo.php) instead of the appcast. The script in turn should be set to link to the appcast.
Finally, set the `SUFeedURL` to your server-side script (eg. `https://example.org/profileInfo.php`) instead of the appcast. The script in turn should be set to link to the appcast.
### Known Backends