mirror of
https://github.com/facebook/sapling.git
synced 2024-10-09 08:18:15 +03:00
e8908fa603
Summary: Some tools parse the output of hg, and the addition of the `connected to hostname` line breaks them. Fix this by changing the default behaviour of clienttelemetry to output to stderr, but only when plain and quiet are not set, and when stderr is a tty. Differential Revision: D7616326 fbshipit-source-id: 6eb329c75a7e8cf6e5ab43aa5ac36be82d1d2e7d
93 lines
3.1 KiB
Python
93 lines
3.1 KiB
Python
# Copyright 2018-present Facebook. All Rights Reserved.
|
|
#
|
|
# clienttelemetry: provide information about the client in server telemetry
|
|
#
|
|
# This software may be used and distributed according to the terms of the
|
|
# GNU General Public License version 2 or any later version.
|
|
"""provide information about the client in server telemetry
|
|
|
|
[clienttelemetry]
|
|
# whether or not to announce the remote hostname when connecting
|
|
announceremotehostname = False
|
|
"""
|
|
|
|
from __future__ import absolute_import
|
|
import random
|
|
import socket
|
|
import string
|
|
|
|
from mercurial.i18n import _
|
|
from mercurial import (
|
|
dispatch,
|
|
extensions,
|
|
hg,
|
|
wireproto,
|
|
)
|
|
|
|
# Client telemetry functions generate client telemetry data at connection time.
|
|
_clienttelemetryfuncs = {}
|
|
|
|
def clienttelemetryfunc(f):
|
|
"""Decorator for registering client telemetry functions."""
|
|
_clienttelemetryfuncs[f.__name__] = f
|
|
return f
|
|
|
|
@clienttelemetryfunc
|
|
def hostname(ui):
|
|
return socket.gethostname()
|
|
|
|
_correlator = None
|
|
|
|
@clienttelemetryfunc
|
|
def correlator(ui):
|
|
"""
|
|
The correlator is a random string that is logged on both the client and
|
|
server. This can be used to correlate the client logging to the server
|
|
logging.
|
|
"""
|
|
global _correlator
|
|
if _correlator is None:
|
|
alphabet = string.ascii_letters + string.digits
|
|
_correlator = ''.join(random.choice(alphabet) for _x in range(16))
|
|
ui.log('clienttelemetry', '', client_correlator=_correlator)
|
|
return _correlator
|
|
|
|
# Client telemetry data is generated before connection and stored here.
|
|
_clienttelemetrydata = {}
|
|
|
|
def _clienttelemetry(repo, proto, args):
|
|
"""Handle received client telemetry"""
|
|
logargs = {'client_%s' % key: value for key, value in args.items()}
|
|
repo.ui.log('clienttelemetry', '', **logargs)
|
|
return socket.gethostname()
|
|
|
|
def _capabilities(orig, repo, proto):
|
|
result = orig(repo, proto)
|
|
result.append('clienttelemetry')
|
|
return result
|
|
|
|
def _runcommand(orig, lui, repo, cmd, fullargs, ui, options, d, cmdpats,
|
|
cmdoptions):
|
|
# Record the command that is running in the client telemetry data.
|
|
_clienttelemetrydata['command'] = cmd
|
|
_clienttelemetrydata['fullcommand'] = dispatch._formatargs(fullargs)
|
|
return orig(lui, repo, cmd, fullargs, ui, options, d, cmdpats, cmdoptions)
|
|
|
|
def _peersetup(ui, peer):
|
|
if peer.capable('clienttelemetry'):
|
|
logargs = {name: f(ui) for name, f in _clienttelemetryfuncs.items()}
|
|
logargs.update(_clienttelemetrydata)
|
|
peername = peer._call('clienttelemetry', **logargs)
|
|
ui.log('clienttelemetry', '', server_realhostname=peername)
|
|
ann = ui.configbool('clienttelemetry', 'announceremotehostname', None)
|
|
if ann is None:
|
|
ann = not ui.plain() and ui._isatty(ui.ferr)
|
|
if ann and not ui.quiet:
|
|
ui.warn(_('connected to %s\n') % peername)
|
|
|
|
def uisetup(ui):
|
|
wireproto.wireprotocommand('clienttelemetry', '*')(_clienttelemetry)
|
|
extensions.wrapfunction(wireproto, '_capabilities', _capabilities)
|
|
hg.wirepeersetupfuncs.append(_peersetup)
|
|
extensions.wrapfunction(dispatch, 'runcommand', _runcommand)
|