|
|
| Line 1: |
Line 1: |
| | {{{hdr|==}}} PhoneHome Parameters {{{hdr|==}}} | | {{{hdr|==}}} PhoneHome Parameters {{{hdr|==}}} |
| − | PhoneHome means a program will check and report to the user if a new version is available. The program will also send a completion status back to the University of Michigan. This enables us to gather some usage statistics.
| + | See [[PhoneHome]] for more information on how PhoneHome and what it does. |
| − | | |
| − | | |
| − | PhoneHome is enabled by default, but will not happen on every run. Each run generates a random number (seeded by time). PhoneHome will only occur if the random number modulo 100 is less than the [[#Adjust the Frequency of PhoneHome (--phoneHomeThinning)|thinning parameter]].
| |
| − | | |
| − | PhoneHome can be completely disabled by using the [[#Turn off PhoneHome (--noPhoneHome)|<code>--noPhoneHome</code>]] option. | |
| − | | |
| − | Why do we want usage statistics?
| |
| − | * To show that our tools are being used (and justify our time spent)
| |
| − | * To see which tools/functions are most heavily utilized so we can appropriately focus our efforts
| |
| − | * To get feedback if users are often encountering errors
| |
| − | | |
| − | | |
| − | What gets sent to the University of Michigan?
| |
| − | Your program will hit one of our URLs providing the following information:
| |
| − | * program name - the name of the executable you are running (pathname is NOT included)
| |
| − | * argument names - the argument names you specified, but NOT any user specified value
| |
| − | * version number - the version of the tool you are running (hard coded at compile time)
| |
| − | * random number - a random number for this run (seeded by time), helps link the version check PhoneHome with the completion status PhoneHome
| |
| − | * [[#Adjust the Frequency of PhoneHome (--phoneHomeThinning)|thinning parameter]] - percentage of time the the tool is configured to report back (0-100), default is 50
| |
| − | * return status - 0 (success), Exception, or Error (it will not include a description of the exception/error)
| |
| − | | |
| − | | |
| − | For example if you run:
| |
| − | /home/mktrost/bamUtil_1.0.10/bin/bam convert --in myInFile.sam --out myOutFile.bam
| |
| − | | |
| − | It will pass something like these parameters back to us:
| |
| − | pgm=bam:convert&vsn=1.0.10&uniqNum=1448588715&thinning=50
| |
| − | and
| |
| − | pgm=bam:convert&vsn=1.0.10&uniqNum=1448588715&thinning=50&status=Exception
| |
| | | | |
| | {{{hdr|==}}}= Turn off PhoneHome (<code>--noPhoneHome</code>) {{{hdr|==}}}= | | {{{hdr|==}}}= Turn off PhoneHome (<code>--noPhoneHome</code>) {{{hdr|==}}}= |
PhoneHome Parameters
See PhoneHome for more information on how PhoneHome and what it does.
Turn off PhoneHome (--noPhoneHome)
Use the --noPhoneHome option to completely disable PhoneHome. PhoneHome is enabled by default based on the thinning parameter.
Adjust the Frequency of PhoneHome (--phoneHomeThinning)
By default, when PhoneHome is enabled (default), it only happens a certain percentage of the time.
Use --phoneHomeThinning to modify the percentage of the time that PhoneHome will run (0-100). By default, --phoneHomeThinning is set to 50.
PhoneHome will only occur if the run's random number modulo 100 is less than the --phoneHomeThinning value.
N/A if --noPhoneHome is set.
