gerrit/java/Main.java
Edwin Kempin d92f6f754a 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-14 08:07:59 +02:00

79 lines
2.5 KiB
Java

// 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 {
private static final String FLOGGER_BACKEND_PROPERTY = "flogger.backend_factory";
private static final String FLOGGER_LOGGING_CONTEXT = "flogger.logging_context";
// 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()) {
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;
}
private static void configureFloggerBackend() {
System.setProperty(
FLOGGER_LOGGING_CONTEXT, "com.google.gerrit.server.logging.LoggingContext#getInstance");
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() {}
}