commit	fea59300516aff3e3bf73f1927539bad06565231	[log] [tgz]
author	Edwin Kempin <ekempin@google.com>	Thu Jun 13 09:04:35 2019 +0200
committer	Edwin Kempin <ekempin@google.com>	Thu Jun 13 09:32:58 2019 +0200
tree	c3171ba18af659ecdb50f17574b64bbbc7c02177
parent	ca836deb4dfe8d8bf87b030d91b7f008a3b944e7 [diff]

Log caller for debug logs when reading external ID notes map

The external ID notes map is loaded quite frequently. To understand
better if we could avoid some of those reads we would like to know from
where this is called. Hence include the caller into the debug log.

Logging callers is fragile and can easily break on refactorings. This is
why we do this only in very few places where we have a high benefit from
this.

There are 2 main ways to trigger reading the external ID notes map:

1. through ExternalIds
2. through AccountsUpdate

For the log in ExternalIdNotes#onLoad we want to know the classes that
trigger reading of the external ID notes map by calling
ExternalIds/AccountsUpdate, hence they are added as targets to
CallerFinder.

For AccountsUpdate there is a complication since it uses the Retryer and
a typical stacktrace looks like this:

  at com.google.gerrit.server.account.externalids.ExternalIdNotes.onLoad(ExternalIdNotes.java:677)
  at com.google.gerrit.server.git.meta.VersionedMetaData.load(VersionedMetaData.java:180)
  at com.google.gerrit.server.git.meta.VersionedMetaData.load(VersionedMetaData.java:152)
  at com.google.gerrit.server.account.externalids.ExternalIdNotes.load(ExternalIdNotes.java:360)
  at com.google.gerrit.server.account.externalids.ExternalIdNotes$Factory.load(ExternalIdNotes.java:164)
  at com.google.gerrit.server.account.AccountsUpdate.createExternalIdNotes(AccountsUpdate.java:447)
  at com.google.gerrit.server.account.AccountsUpdate.lambda$0(AccountsUpdate.java:331)
  at com.google.gerrit.server.account.AccountsUpdate.lambda$2(AccountsUpdate.java:410)
  at com.github.rholder.retry.AttemptTimeLimiters$NoAttemptTimeLimit.call(AttemptTimeLimiters.java:78)
  at com.github.rholder.retry.Retryer.call(Retryer.java:160)
  at com.google.gerrit.server.update.RetryHelper.executeWithTimeoutCount(RetryHelper.java:282)
  at com.google.gerrit.server.update.RetryHelper.executeWithAttemptAndTimeoutCount(RetryHelper.java:260)
  at com.google.gerrit.server.update.RetryHelper.execute(RetryHelper.java:206)
  at com.google.gerrit.server.update.RetryHelper.execute(RetryHelper.java:196)
  at com.google.gerrit.server.account.AccountsUpdate.executeAccountUpdate(AccountsUpdate.java:424)
  at com.google.gerrit.server.account.AccountsUpdate.updateAccount(AccountsUpdate.java:407)
  at com.google.gerrit.server.account.AccountsUpdate.insert(AccountsUpdate.java:319)
  at com.google.gerrit.server.account.AccountsUpdate.insert(AccountsUpdate.java:303)
  at com.google.gerrit.acceptance.AccountCreator.create(AccountCreator.java:94)
  ...

Adding AccountsUpdate as target to caller finder means that it finds
AccountsUpdate in the stack and then reports the next other class in the
stack as caller, which would be
com.github.rholder.retry.AttemptTimeLimiters in the example above. To
get the right caller (com.google.gerrit.acceptance.AccountCreator) we
need to ignore the retryer class. Hence add support for ignoring
classes/packages to CallerFinder.

The caller computation is expensive, hence it is only done when the
request is traced or when the log level is set to debug (the caller
returned by CallerFinder is a LazyArg which is only called when a log is
actually written).

Signed-off-by: Edwin Kempin <ekempin@google.com>
Change-Id: Ieb313c689bcfd0015e90daed6a5d76759d5e4a2b

2 files changed

tree: c3171ba18af659ecdb50f17574b64bbbc7c02177

README.md

Gerrit Code Review

Gerrit is a code review and project management tool for Git based projects.

Objective

Gerrit makes reviews easier by showing changes in a side-by-side display, and allowing inline comments to be added by any reviewer.

Gerrit simplifies Git based project maintainership by permitting any authorized user to submit changes to the master Git repository, rather than requiring all approved changes to be merged in by hand by the project maintainer.

Documentation

For information about how to install and use Gerrit, refer to the documentation.

Source

Our canonical Git repository is located on googlesource.com. There is a mirror of the repository on Github.

Reporting bugs

Please report bugs on the issue tracker.

Contribute

Gerrit is the work of hundreds of contributors. We appreciate your help!

Please read the contribution guidelines.

Note that we do not accept Pull Requests via the Github mirror.

Getting in contact

The IRC channel on freenode is #gerrit. An archive is available at: echelog.com.

The Developer Mailing list is repo-discuss on Google Groups.

License

Gerrit is provided under the Apache License 2.0.

Build

Install Bazel and run the following:

    git clone --recurse-submodules https://gerrit.googlesource.com/gerrit
    cd gerrit && bazel build release

Install binary packages (Deb/Rpm)

The instruction how to configure GerritForge/BinTray repositories is here

On Debian/Ubuntu run:

    apt-get update & apt-get install gerrit=<version>-<release>

NOTE: release is a counter that starts with 1 and indicates the number of packages that have been released with the same version of the software.

On CentOS/RedHat run:

    yum clean all && yum install gerrit-<version>[-<release>]

On Fedora run:

    dnf clean all && dnf install gerrit-<version>[-<release>]

Use pre-built Gerrit images on Docker

Docker images of Gerrit are available on DockerHub

To run a CentOS 7 based Gerrit image:

    docker run -p 8080:8080 gerritforge/gerrit-centos7[:version]

To run a Ubuntu 15.04 based Gerrit image:

    docker run -p 8080:8080 gerritforge/gerrit-ubuntu15.04[:version]

NOTE: release is optional. Last released package of the version is installed if the release number is omitted.