RETIRED, Gerrit as used by OpenStack
Go to file
Edwin Kempin 2b81d71374 Add dependency to Flogger
Flogger is an open source project (Apache 2 License) from Google that
provides a fluent JAVA API for logging:
* https://github.com/google/flogger
* https://google.github.io/flogger/

We want to use Flogger instead of slf4j. This idea was discussed at the
Gerrit hackathon in Lund [1] and on the mailing list [2].

Benefits:
* Better Readability
* Better Performance
* Will allow us to implement request tracing

Flogger API examples:
* logger.atSevere()
    .withCause(err)
    .log("Error in %s %s", req.getMethod(), uri);
* logger.atInfo()
    .atMostEvery(1, TimeUnit.HOURS)
    .log(...)
* logger.atInfo()
    .withStackTrace(StackSize.FULL)
    .log(...)

Within Google Flogger is long-established and is used by almost 3/4 of
all Google's Java projects, hence this library is very mature.

The Flogger API can be used with different logging backends. We are
using the log4j backend, as we are currently using log4j as backend with
slf4j. This means there are no changes to how logs are configured
(existing log4j.properties and log4j.xml files continue to work). It
also means that this doesn't effect any integrations that work with
log4j (e.g. integration with logstash continues to work).

To use the log4j backend for Flogger the system property
'flogger.backend_factory' must be set to
'com.google.common.flogger.backend.log4j.Log4jBackendFactory#getInstance'.
E.g. this system property may be set in gerrit.config:
[container]
  javaOptions = "-Dflogger.backend_factory=com.google.common.flogger.backend.log4j.Log4jBackendFactory#getInstance"

If this property is not set Gerrit sets it automatically on startup so
that we always have a proper logging configuration. We do this in
Main.java before loading any class. This is important since Flogger
reads this system property only once when the FluentLogger class is
loaded and we must be sure that the system property was set before this.

Using Flogger and slf4j in parallel is not a problem. Logs from both
APIs end up in the same log file(s).

This change doesn't migrate any classes to Flogger yet. This will be
done by follow-up changes.

JGit is still using slf4j and needs an explicit runtime dependency on
slf4j.

[1] https://docs.google.com/presentation/d/1Kwn77c1PScMLDEWiJDklEm43NsN2-mWm2PqHwYTkJfI/edit?usp=sharing
[2] https://groups.google.com/d/msg/repo-discuss/meEWJO7c4pA/fxDx2waRCQAJ

Change-Id: Ifc31fb95c10397857e8de5657c729f49c1820ec4
Signed-off-by: Edwin Kempin <ekempin@google.com>
2018-06-05 13:06:05 +02:00
.settings Merge branch 'stable-2.14' into stable-2.15 2018-05-16 08:15:29 +09:00
antlr3 antlr/BUILD: clear timestamps 2018-02-12 11:11:53 +01:00
contrib Fix merge conflict in populate-fixture-data.py 2018-05-31 19:06:53 +00:00
Documentation Merge changes Iacd3f2db,Iad2bd925,I1c11924d,I7c1461c4,I6b2c4f4d, ... 2018-06-04 07:55:18 +00:00
gerrit-elasticsearch/src Merge branch 'stable-2.15' 2018-06-05 10:55:00 +09:00
gerrit-gwtdebug Dissolve gerrit-pgm top-level directory 2017-10-31 11:02:37 -04:00
gerrit-gwtui Move Truth rules to a subdirectory of lib 2018-05-16 14:20:06 -07:00
gerrit-gwtui-common Use Collections.addAll to copy elements from an array to collections 2018-04-27 13:36:46 +00:00
gerrit-plugin-gwtui Switch to 2.14.9-SNAPSHOT version 2018-05-09 07:32:45 +00:00
gerrit-server/src/test/java/com/google/gerrit/metrics/dropwizard Merge branch 'stable-2.14' into stable-2.15 2018-06-04 17:19:17 +09:00
java Add dependency to Flogger 2018-06-05 13:06:05 +02:00
javatests Merge branch 'stable-2.15' 2018-06-05 10:55:00 +09:00
lib Add dependency to Flogger 2018-06-05 13:06:05 +02:00
plugins Update git submodules 2018-05-24 01:44:32 +00:00
polygerrit-ui Merge "Refactor timing report for expanding many diffs" 2018-06-05 01:24:26 +00:00
prolog Extract prolog predicates from gerrit-server:server rule 2017-10-31 11:02:36 -04:00
prologtests Isolate gerrit:server rule in gerrit/server package 2017-10-31 11:02:38 -04:00
proto Serialize ConflictsCache as proto 2018-05-23 10:28:08 -04:00
resources Make footer GWT UI link configurable 2018-05-24 11:57:40 -07:00
tools Merge branch 'stable-2.15' 2018-06-05 10:55:00 +09:00
webapp Dissolve gerrit-war top-level directory 2017-10-31 11:02:37 -04:00
.bazelproject Exclude bin directory from IntelliJ Bazel project 2018-05-21 11:44:17 -04:00
.editorconfig Added continuation indent to editorconfig 2016-04-26 14:42:58 +02:00
.git-blame-ignore-revs Update git hyper-blame configuration 2017-02-17 16:35:50 +09:00
.gitignore Remove outstanding references to buck 2018-02-07 09:16:41 -05:00
.gitmodules Modify plugins:core to build codemirror-editor 2017-12-09 00:59:31 +01:00
.mailmap Update .mailmap 2018-04-18 08:52:53 +02:00
.pydevproject Update PyDev project to use Python 2.7 2014-10-02 15:16:44 +09:00
BUILD Dissolve gerrit-plugin-api top-level directory 2017-10-31 11:02:37 -04:00
COPYING Initial project setup of Gerrit 2 2008-11-14 16:59:34 -08:00
INSTALL Remove Gerrit 1.x to 2.x import tools 2009-03-27 20:20:10 -07:00
README.md Switch GitHub mirror URL to the most up-to-date 2017-04-05 09:03:59 +01:00
SUBMITTING_PATCHES Add step to SUBMITTING_PATCHES to ensure Change-Id 2018-01-11 20:35:37 +00:00
version.bzl Switch to 2.14.9-SNAPSHOT version 2018-05-09 07:32:45 +00:00
WORKSPACE Add dependency to Flogger 2018-06-05 13:06:05 +02:00

Gerrit Code Review

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

Build Status

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 --recursive 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.