hgdemandimport/tracing.py
author Augie Fackler <augie@google.com>
Wed, 12 Jun 2019 19:01:37 -0400
changeset 42476 d0b8a3cfd732
parent 39397 452790284a15
child 42477 e658ac39fe41
permissions -rw-r--r--
tracing: extract tracing-active logic to separate function I'm about to add support for counters, and want to avoid duplicating this logic. Differential Revision: https://phab.mercurial-scm.org/D6525
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
39254
284440041141 tracing: new module to make tracing events in hg easier
Augie Fackler <augie@google.com>
parents:
diff changeset
     1
# Support code for event tracing in Mercurial. Lives in demandimport
284440041141 tracing: new module to make tracing events in hg easier
Augie Fackler <augie@google.com>
parents:
diff changeset
     2
# so it can also be used in demandimport.
284440041141 tracing: new module to make tracing events in hg easier
Augie Fackler <augie@google.com>
parents:
diff changeset
     3
#
284440041141 tracing: new module to make tracing events in hg easier
Augie Fackler <augie@google.com>
parents:
diff changeset
     4
# Copyright 2018 Google LLC.
284440041141 tracing: new module to make tracing events in hg easier
Augie Fackler <augie@google.com>
parents:
diff changeset
     5
#
284440041141 tracing: new module to make tracing events in hg easier
Augie Fackler <augie@google.com>
parents:
diff changeset
     6
# This software may be used and distributed according to the terms of the
284440041141 tracing: new module to make tracing events in hg easier
Augie Fackler <augie@google.com>
parents:
diff changeset
     7
# GNU General Public License version 2 or any later version.
284440041141 tracing: new module to make tracing events in hg easier
Augie Fackler <augie@google.com>
parents:
diff changeset
     8
from __future__ import absolute_import
284440041141 tracing: new module to make tracing events in hg easier
Augie Fackler <augie@google.com>
parents:
diff changeset
     9
284440041141 tracing: new module to make tracing events in hg easier
Augie Fackler <augie@google.com>
parents:
diff changeset
    10
import contextlib
284440041141 tracing: new module to make tracing events in hg easier
Augie Fackler <augie@google.com>
parents:
diff changeset
    11
import os
284440041141 tracing: new module to make tracing events in hg easier
Augie Fackler <augie@google.com>
parents:
diff changeset
    12
284440041141 tracing: new module to make tracing events in hg easier
Augie Fackler <augie@google.com>
parents:
diff changeset
    13
_pipe = None
284440041141 tracing: new module to make tracing events in hg easier
Augie Fackler <augie@google.com>
parents:
diff changeset
    14
_checked = False
284440041141 tracing: new module to make tracing events in hg easier
Augie Fackler <augie@google.com>
parents:
diff changeset
    15
42476
d0b8a3cfd732 tracing: extract tracing-active logic to separate function
Augie Fackler <augie@google.com>
parents: 39397
diff changeset
    16
def _isactive():
39254
284440041141 tracing: new module to make tracing events in hg easier
Augie Fackler <augie@google.com>
parents:
diff changeset
    17
    global _pipe, _session, _checked
284440041141 tracing: new module to make tracing events in hg easier
Augie Fackler <augie@google.com>
parents:
diff changeset
    18
    if _pipe is None:
284440041141 tracing: new module to make tracing events in hg easier
Augie Fackler <augie@google.com>
parents:
diff changeset
    19
        if _checked:
42476
d0b8a3cfd732 tracing: extract tracing-active logic to separate function
Augie Fackler <augie@google.com>
parents: 39397
diff changeset
    20
            return False
39254
284440041141 tracing: new module to make tracing events in hg easier
Augie Fackler <augie@google.com>
parents:
diff changeset
    21
        _checked = True
284440041141 tracing: new module to make tracing events in hg easier
Augie Fackler <augie@google.com>
parents:
diff changeset
    22
        if 'HGCATAPULTSERVERPIPE' not in os.environ:
42476
d0b8a3cfd732 tracing: extract tracing-active logic to separate function
Augie Fackler <augie@google.com>
parents: 39397
diff changeset
    23
            return False
39254
284440041141 tracing: new module to make tracing events in hg easier
Augie Fackler <augie@google.com>
parents:
diff changeset
    24
        _pipe = open(os.environ['HGCATAPULTSERVERPIPE'], 'w', 1)
284440041141 tracing: new module to make tracing events in hg easier
Augie Fackler <augie@google.com>
parents:
diff changeset
    25
        _session = os.environ.get('HGCATAPULTSESSION', 'none')
42476
d0b8a3cfd732 tracing: extract tracing-active logic to separate function
Augie Fackler <augie@google.com>
parents: 39397
diff changeset
    26
    return True
d0b8a3cfd732 tracing: extract tracing-active logic to separate function
Augie Fackler <augie@google.com>
parents: 39397
diff changeset
    27
d0b8a3cfd732 tracing: extract tracing-active logic to separate function
Augie Fackler <augie@google.com>
parents: 39397
diff changeset
    28
@contextlib.contextmanager
d0b8a3cfd732 tracing: extract tracing-active logic to separate function
Augie Fackler <augie@google.com>
parents: 39397
diff changeset
    29
def log(whencefmt, *whenceargs):
d0b8a3cfd732 tracing: extract tracing-active logic to separate function
Augie Fackler <augie@google.com>
parents: 39397
diff changeset
    30
    if not _isactive():
d0b8a3cfd732 tracing: extract tracing-active logic to separate function
Augie Fackler <augie@google.com>
parents: 39397
diff changeset
    31
        yield
d0b8a3cfd732 tracing: extract tracing-active logic to separate function
Augie Fackler <augie@google.com>
parents: 39397
diff changeset
    32
        return
39254
284440041141 tracing: new module to make tracing events in hg easier
Augie Fackler <augie@google.com>
parents:
diff changeset
    33
    whence = whencefmt % whenceargs
284440041141 tracing: new module to make tracing events in hg easier
Augie Fackler <augie@google.com>
parents:
diff changeset
    34
    try:
39397
452790284a15 tracing: ignore any IOErrors when writing to pipe
Augie Fackler <augie@google.com>
parents: 39254
diff changeset
    35
        # Both writes to the pipe are wrapped in try/except to ignore
452790284a15 tracing: ignore any IOErrors when writing to pipe
Augie Fackler <augie@google.com>
parents: 39254
diff changeset
    36
        # errors, as we can see mysterious errors in here if the pager
452790284a15 tracing: ignore any IOErrors when writing to pipe
Augie Fackler <augie@google.com>
parents: 39254
diff changeset
    37
        # is active. Presumably other conditions could trigger
452790284a15 tracing: ignore any IOErrors when writing to pipe
Augie Fackler <augie@google.com>
parents: 39254
diff changeset
    38
        # problems too.
452790284a15 tracing: ignore any IOErrors when writing to pipe
Augie Fackler <augie@google.com>
parents: 39254
diff changeset
    39
        try:
452790284a15 tracing: ignore any IOErrors when writing to pipe
Augie Fackler <augie@google.com>
parents: 39254
diff changeset
    40
            _pipe.write('START %s %s\n' % (_session, whence))
452790284a15 tracing: ignore any IOErrors when writing to pipe
Augie Fackler <augie@google.com>
parents: 39254
diff changeset
    41
        except IOError:
452790284a15 tracing: ignore any IOErrors when writing to pipe
Augie Fackler <augie@google.com>
parents: 39254
diff changeset
    42
            pass
39254
284440041141 tracing: new module to make tracing events in hg easier
Augie Fackler <augie@google.com>
parents:
diff changeset
    43
        yield
284440041141 tracing: new module to make tracing events in hg easier
Augie Fackler <augie@google.com>
parents:
diff changeset
    44
    finally:
39397
452790284a15 tracing: ignore any IOErrors when writing to pipe
Augie Fackler <augie@google.com>
parents: 39254
diff changeset
    45
        try:
452790284a15 tracing: ignore any IOErrors when writing to pipe
Augie Fackler <augie@google.com>
parents: 39254
diff changeset
    46
            _pipe.write('END %s %s\n' % (_session, whence))
452790284a15 tracing: ignore any IOErrors when writing to pipe
Augie Fackler <augie@google.com>
parents: 39254
diff changeset
    47
        except IOError:
452790284a15 tracing: ignore any IOErrors when writing to pipe
Augie Fackler <augie@google.com>
parents: 39254
diff changeset
    48
            pass