A python script for extracting macOS Caching Server data
Cacher is a python script that will parse the OS X Caching Server debug logs and present you (to the best of its abilities) serving statistics.
Some of the things Cacher can display: - Total bandwidth served to clients - Total bandwidth requested from Apple - Total bandwidth requested from other Caching servers - Total IP Addresses - Total Unique IP Addresses. - Total iOS download requests including model type - Total OS download requests specified by type (iOS and macOS) - Total applications downloaded from Apple Configurator 2 devices - Total downloaded files - Total eBook (.epub) files - Total personal iCloud files - Total package (.pkg) files - Total iOS application (.ipad) files - Total Zip (.zip) files - Total unique downloaded files - Total unique eBook (.epub) files - Total unique personal iCloud files - Total unique package (.pkg) files - Total unique iOS application (.ipad) files - Total unique Zip (.zip) files
Cacher currently supports Server 5.2 and higher.
Usage: cacher.py [options]
Options: -h, --help show this help message and exit --targetdate=TARGETDATE Optional: Date to parse. Example: 2017-01-15. --logpath=LOGPATH Optional: Caching Log Path. Defaults to: /Library/Server/Caching/Logs --deviceids Optional: Use Device IDs (Ex: iPhone7,2). Defaults to: False --nostdout Optional: Do not print to standard out --configureserver Optional: Configure Server to log Client Data --serveralert Optional: Send Server Alert --slackalert Optional: Use Slack --slackwebhook=SLACKWEBHOOK Optional: Slack Webhook URL. Requires Slack Option. --slackusername=SLACKUSERNAME Optional: Slack username. Defaults to Cacher. Requires Slack Option. --slackchannel=SLACKCHANNEL Optional: Slack channel. Can be username or channel. Ex. #channel or @username. Requires Slack Option.
The following are optional features:
By default, the Caching service will not log the model and iOS/OS X version. In order to get true results from this script, run the following command (as root):
sudo cacher.py --configureserver
If successful, you will see the following output:
Caching Server settings are now: caching:LogClientIdentity = yes
By default, Cacher will use look for logs from the previous date. To target logs from a custom date, use the
cacher.py --targetdate "2016-11-28"
By default, Cacher will use look for logs from in /Library/Server/Caching/Logs. To target logs in a custom path, use the
cacher.py --logpath "/path/to/logs"
By default, Cacher will use the "Friendly Names" for iOS devices. To use the model Device ID, use the
Device IDs Example:
bash A total of 3513 iOS downloads were requested from the Caching Server yesterday consisting of: A total of 4 Apple TV downloads A total of 417 iPad downloads A total of 3075 iPhone downloads A total of 17 iPod downloads 4 AppleTV5,3 4 iPad2,1 7 iPad2,2 2 iPad2,3 5 iPad2,4
Friendly Names Example:
bash A total of 3513 iOS downloads were requested from the Caching Server yesterday consisting of: A total of 4 Apple TV downloads A total of 417 iPad downloads A total of 3075 iPhone downloads A total of 17 iPod downloads 4 5th Generation Apple TVs 5 iPad 2nd Generation [M2012 Wifi Revision] 2 iPad 2nd Generation [Wifi + CDMA] 7 iPad 2nd Generation [Wifi + GSM] 4 iPad 2nd Generation [Wifi]
By default, Cacher will print the results to standard out. To skip this use the
By default, Cacher will no longer send a server alert. To send a server alert, use the
Please note that this option requires root/sudo level permissions.
sudo cacher.py --serveralert
If you attempt to use this option without elevated permissions, Cacher will write the following note to standard out.
Did not send serverAlert - requires root
By default, Cacher will not send a server alert. To send a server alert, use the
The slack alert requires two other options to be passed: -
You can pass both an username or channel via the
--slackchanneloption: Examples: -
A slack webhook must be created. To create a webhook, please go here
cacher.py --slackalert \ --slackchannel "@egomez" \ --slackwebhook "https://hooks.slack.com/services/YOURURL"``