sapling/eden/hg-server/edenscm/hgext/clienttelemetry.py
Durham Goode 98d9269874 server: copy hg to a new hg-server directory
Summary:
Create a fork of the Mercurial code that we can use to build server
rpms. The hg servers will continue to exist for a few more months while we move
the darkstorm and ediscovery use cases off them. In the mean time, we want to
start making breaking changes to the client, so let's create a stable copy of
the hg code to produce rpms for the hg servers.

The fork is based off c7770c78d, the latest hg release.

This copies the files as is, then adds some minor tweaks to get it to build:
- Disables some lint checks that appear to be bypassed by path
- sed replace eden/scm with eden/hg-server
- Removed a dependency on scm/telemetry from the edenfs-client tests since
  scm/telemetry pulls in the original eden/scm/lib/configparser which conflicts
  with the hg-server conflict parser.

allow-large-files

Reviewed By: quark-zju

Differential Revision: D27632557

fbshipit-source-id: b2f442f4ec000ea08e4d62de068750832198e1f4
2021-04-09 10:09:06 -07:00

151 lines
4.6 KiB
Python

# Copyright (c) Facebook, Inc. and its affiliates.
#
# This software may be used and distributed according to the terms of the
# GNU General Public License version 2.
# clienttelemetry: provide information about the client in server telemetry
"""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 socket
import string
from edenscm.mercurial import (
blackbox,
dispatch,
extensions,
hg,
perftrace,
util,
wireproto,
)
from edenscm.mercurial.i18n import _
from edenscm.mercurial.pycompat import decodeutf8
# 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:
_correlator = util.makerandomidentifier()
ui.log("clienttelemetry", client_correlator=_correlator)
return _correlator
@clienttelemetryfunc
def wantslfspointers(ui):
"""
Tells the server whether this clients wants LFS pointers to be sent in
getpackv2. Only applies when the repository is being migrated to sending
LFS pointers and doesn't apply on repositories already converted.
Oh, if you haven't realized already, this is a hack. Hopefully when the
Mercurial servers are gone we'll be able to have a real capability exchange
system when establishing a connection.
"""
return str(ui.configbool("lfs", "wantslfspointers"))
# 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)
# Make them available to other extensions
repo.clienttelemetry = logargs
return socket.gethostname()
def getclienttelemetry(repo):
kwargs = {}
if util.safehasattr(repo, "clienttelemetry"):
clienttelemetry = repo.clienttelemetry
fields = ["client_fullcommand", "client_hostname"]
for f in fields:
if f in clienttelemetry:
kwargs[f] = clienttelemetry[f]
return kwargs
def _capabilities(orig, repo, proto):
result = orig(repo, proto)
result.append("clienttelemetry")
return result
def clienttelemetryvaluesfromconfig(ui):
result = {}
for name, value in ui.configitems("clienttelemetryvalues"):
result[name] = value
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
fullcommand = dispatch._formatargs(fullargs)
# Long invocations can occupy a lot of space in the logs.
if len(fullcommand) > 256:
fullcommand = fullcommand[:256] + " (truncated)"
_clienttelemetrydata["fullcommand"] = fullcommand
return orig(lui, repo, cmd, fullargs, ui, options, d, cmdpats, cmdoptions)
def _peersetup(ui, peer):
if peer.capable("clienttelemetry"):
logargs = clienttelemetryvaluesfromconfig(ui)
logargs.update({name: f(ui) for name, f in _clienttelemetryfuncs.items()})
logargs.update(_clienttelemetrydata)
peername = decodeutf8(peer._call("clienttelemetry", **logargs))
peer._realhostname = peername
blackbox.log({"clienttelemetry": {"peername": peername}})
util.info("client-telemetry", peername=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.write_err(_("connected to %s\n") % peername)
perftrace.tracevalue("Server", peername)
def uisetup(ui):
wireproto.wireprotocommand("clienttelemetry", "*")(_clienttelemetry)
extensions.wrapfunction(wireproto, "_capabilities", _capabilities)
hg.wirepeersetupfuncs.append(_peersetup)
extensions.wrapfunction(dispatch, "runcommand", _runcommand)