Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

79 lines
2.5 KiB
Java
Raw Normal View History

// Copyright (C) 2009 The Android Open Source Project
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
public final class Main {
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-05-08 11:41:55 +02:00
private static final String FLOGGER_BACKEND_PROPERTY = "flogger.backend_factory";
Add support for logging tags By opening a TraceContext it is now possible to set a logging tag that will be automatically included into all subsequent log statements that are done by the same thread. When the TraceContext is closed the tag is unset. A tag has a name and a value. Having multiple tags with the same name but different values is possible. Adding a tag with the same name and same value a second time is possible but has no effect. With this change open TraceContexts are not propagated to newly started threads that do work in the background. Support for this will be implemented by the follow-up change. Example: // Initially there are no tags logger.atSevere().log("log without tag"); // a tag can be set by opening a TraceContext try (TraceContext ctx = new TraceContext("tag1", "value1")) { logger.atSevere().log("with tag1=value1"); // by opening another TraceContext a another tag can be added try (TraceContext ctx2 = new TraceContext("tag2", "value2")) { logger.atSevere().log("log with tag1=value1 and tag2=value2"); // it's possible to have same tag name with multiple values try (TraceContext ctx3 = new TraceContext("tag2", "value2a")) { logger.atSevere().log("log with tag1=value1, tag2=value2 and tag2=value2a"); // adding a tag with the same name and value of an existing tag has no effect try (TraceContext ctx4 = new TraceContext("tag2", "value2a")) { logger.atSevere().log("log with tag1=value1, tag2=value2 and tag2=value2a"); } // closing ctx4 didn't remove tag2=value2a since it was set before opening ctx4 logger.atSevere().log("log with tag1=value1, tag2=value2 and tag2=value2a"); } // closing ctx3 removed tag2=value2a logger.atSevere().log("log with tag1=value1 and tag2=value2"); } // closing ctx2 removed tag2=value2 logger.atSevere().log("with tag1=value1"); } // closing ctx1 removed tag1=value1 logger.atSevere().log("log without tag"); To support logging tags we must register a LoggingContext in Flogger. This is done by setting the 'flogger.logging_context' system property. Change-Id: Ib01eb90b9ad832be0b2d794e14ce23bdef2f0fb6 Signed-off-by: Edwin Kempin <ekempin@google.com>
2018-08-03 09:00:08 +02:00
private static final String FLOGGER_LOGGING_CONTEXT = "flogger.logging_context";
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-05-08 11:41:55 +02:00
// We don't do any real work here because we need to import
// the archive lookup code and we cannot import a class in
// the default package. So this is just a tiny springboard
// to jump into the real main code.
//
public static void main(String[] argv) throws Exception {
if (onSupportedJavaVersion()) {
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-05-08 11:41:55 +02:00
configureFloggerBackend();
com.google.gerrit.launcher.GerritLauncher.main(argv);
} else {
System.exit(1);
}
}
private static boolean onSupportedJavaVersion() {
final String version = System.getProperty("java.specification.version");
if (1.8 <= parse(version)) {
return true;
}
System.err.println("fatal: Gerrit Code Review requires Java 8 or later");
System.err.println(" (trying to run on Java " + version + ")");
return false;
}
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-05-08 11:41:55 +02:00
private static void configureFloggerBackend() {
Add support for logging tags By opening a TraceContext it is now possible to set a logging tag that will be automatically included into all subsequent log statements that are done by the same thread. When the TraceContext is closed the tag is unset. A tag has a name and a value. Having multiple tags with the same name but different values is possible. Adding a tag with the same name and same value a second time is possible but has no effect. With this change open TraceContexts are not propagated to newly started threads that do work in the background. Support for this will be implemented by the follow-up change. Example: // Initially there are no tags logger.atSevere().log("log without tag"); // a tag can be set by opening a TraceContext try (TraceContext ctx = new TraceContext("tag1", "value1")) { logger.atSevere().log("with tag1=value1"); // by opening another TraceContext a another tag can be added try (TraceContext ctx2 = new TraceContext("tag2", "value2")) { logger.atSevere().log("log with tag1=value1 and tag2=value2"); // it's possible to have same tag name with multiple values try (TraceContext ctx3 = new TraceContext("tag2", "value2a")) { logger.atSevere().log("log with tag1=value1, tag2=value2 and tag2=value2a"); // adding a tag with the same name and value of an existing tag has no effect try (TraceContext ctx4 = new TraceContext("tag2", "value2a")) { logger.atSevere().log("log with tag1=value1, tag2=value2 and tag2=value2a"); } // closing ctx4 didn't remove tag2=value2a since it was set before opening ctx4 logger.atSevere().log("log with tag1=value1, tag2=value2 and tag2=value2a"); } // closing ctx3 removed tag2=value2a logger.atSevere().log("log with tag1=value1 and tag2=value2"); } // closing ctx2 removed tag2=value2 logger.atSevere().log("with tag1=value1"); } // closing ctx1 removed tag1=value1 logger.atSevere().log("log without tag"); To support logging tags we must register a LoggingContext in Flogger. This is done by setting the 'flogger.logging_context' system property. Change-Id: Ib01eb90b9ad832be0b2d794e14ce23bdef2f0fb6 Signed-off-by: Edwin Kempin <ekempin@google.com>
2018-08-03 09:00:08 +02:00
System.setProperty(
FLOGGER_LOGGING_CONTEXT, "com.google.gerrit.server.logging.LoggingContext#getInstance");
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-05-08 11:41:55 +02:00
if (System.getProperty(FLOGGER_BACKEND_PROPERTY) != null) {
// Flogger backend is already configured
return;
}
// Configure log4j backend
System.setProperty(
FLOGGER_BACKEND_PROPERTY,
"com.google.common.flogger.backend.log4j.Log4jBackendFactory#getInstance");
}
private static double parse(String version) {
if (version == null || version.length() == 0) {
return 0.0;
}
try {
final int fd = version.indexOf('.');
final int sd = version.indexOf('.', fd + 1);
if (0 < sd) {
version = version.substring(0, sd);
}
return Double.parseDouble(version);
} catch (NumberFormatException e) {
return 0.0;
}
}
private Main() {}
}