[PATCH V2] profiling: allow logging profile to the blackbox

[Durham Goode]

On 9/9/15, 7:41 AM, "Augie Fackler" <raf at durin42.com> wrote:

>On Tue, Sep 08, 2015 at 11:41:47AM -0700, Durham Goode wrote:
>> # HG changeset patch
>> # User Durham Goode <durham at fb.com>
>> # Date 1441737592 25200
>> #      Tue Sep 08 11:39:52 2015 -0700
>> # Node ID a8eeffb15ed4bf1e55bc3b36baa64c8f2b5d0739
>> # Parent  2cd61d6e66c1034c97b7095fdf1d7908dd437b26
>> profiling: allow logging profile to the blackbox
>
>Queued, but I have a question below that might lead me to write a
>quick followup.
>
>>
>> This allows specifying '--config profiling.output=blackbox' which will log the
>> profile output to the blackbox (if enabled). This is useful for doing profiling
>> on the server since it allows us to record the command, it's result, any
>> exceptions, and it's profile, all in one spot.  And we get log rotation for
>> free.
>>
>> diff --git a/mercurial/dispatch.py b/mercurial/dispatch.py
>> --- a/mercurial/dispatch.py
>> +++ b/mercurial/dispatch.py
>> @@ -1021,7 +1021,10 @@ def _runcommand(ui, options, cmd, cmdfun
>>
>>          output = ui.config('profiling', 'output')
>>
>> -        if output:
>> +        if output == 'blackbox':
>> +            import StringIO
>> +            fp = StringIO.StringIO()
>> +        elif output:
>>              path = ui.expandpath(output)
>>              fp = open(path, 'wb')
>>          else:
>> @@ -1036,6 +1039,12 @@ def _runcommand(ui, options, cmd, cmdfun
>>                  return statprofile(ui, checkargs, fp)
>>          finally:
>>              if output:
>> +                if output == 'blackbox':
>> +                    val = "Profile:\n%s" % fp.getvalue()
>> +                    # ui.log treats the input as a format string,
>> +                    # so we need to escape any % signs.
>
>Oh, I see. This is actually documented only in blackbox.py - should we
>document that on ui.log itself as part of the API contract?
>
>(I'm happy to do that, it was just surprising.)

That sounds reasonable.  For some reason I thought this was the behavior for all of the ui.status/warn/note commands, but I guess I was wrong.  I think we did it this way because most users don't have the blackbox or any ui.log extensions enabled, so this avoids them having to do the string formatting.