document "base severity level"

also improve tests

Author: pongad

google-cloud-logging/src/main/java/com/google/cloud/logging/LoggingHandler.java

@@ -68,6 +68,12 @@
  *     {@code java.log}).
  * <li>{@code com.google.cloud.logging.LoggingHandler.level} specifies the default level for the
  *     handler (defaults to {@code Level.INFO}).
+ *     <p> This configuration also sets the "base severity level".
+ *     Logs with the same severity with the base could be more efficiently sent to Stackdriver.
+ *     The base severity defaults to the level of of handler or {@code Level.FINEST}
+ *     if the handler is set to {@code Level.ALL}.
+ *     There is currently no way to modify the base level, see
+ *     <a href="https://github.com/GoogleCloudPlatform/google-cloud-java/issues/1740">tracking issue</a>.
  * <li>{@code com.google.cloud.logging.LoggingHandler.filter} specifies the name of a {@link Filter}
  *     class to use (defaults to no filter).
  * <li>{@code com.google.cloud.logging.LoggingHandler.formatter} specifies the name of a
@@ -110,7 +116,7 @@ public class LoggingHandler extends Handler {
   private volatile Logging logging;
   private Level flushLevel;
   private long flushSize;
-  private final Level nativeLevel;
+  private final Level baseLevel;
   private Synchronicity synchronicity;
   private final List<Enhancer> enhancers;
 
@@ -178,7 +184,7 @@ public LoggingHandler(String log, LoggingOptions options, MonitoredResource moni
 
       Level level = helper.getLevelProperty(className + ".level", Level.INFO);
       setLevel(level);
-      nativeLevel = level;
+      baseLevel = level.equals(Level.ALL) ? Level.FINEST : level;
 
       this.synchronicity =
           helper.getSynchronicityProperty(className + ".synchronicity", Synchronicity.ASYNC);
@@ -196,9 +202,9 @@ public LoggingHandler(String log, LoggingOptions options, MonitoredResource moni
             WriteOption.labels(
                 ImmutableMap.of(
                     LEVEL_NAME_KEY,
-                    nativeLevel.getName(),
+                    baseLevel.getName(),
                     LEVEL_VALUE_KEY,
-                    nativeLevel.intValue() + ""))
+                    String.valueOf(baseLevel.intValue())))
           };
     } catch (Exception ex) {
       reportError(null, ex, ErrorManager.OPEN_FAILURE);
@@ -396,7 +402,7 @@ private LogEntry entryFor(LogRecord record) {
           .setTimestamp(record.getMillis())
           .setSeverity(severityFor(level));
 
-      if (!nativeLevel.equals(level)) {
+      if (!baseLevel.equals(level)) {
         builder
             .addLabel("levelName", level.getName())
             .addLabel("levelValue", String.valueOf(level.intValue()));

google-cloud-logging/src/test/java/com/google/cloud/logging/LoggingHandlerTest.java

@@ -134,14 +134,6 @@ public class LoggingHandlerTest {
       .addLabel("levelValue", String.valueOf(LoggingLevel.EMERGENCY.intValue()))
       .setTimestamp(123456789L)
       .build();
-  private static final ImmutableMap<String, String> NATIVE_SEVERITY_MAP =
-      ImmutableMap.of("levelName", Level.INFO.getName(), "levelValue", Level.INFO.intValue() + "");
-  private static final WriteOption[] DEFAULT_OPTION =
-      new WriteOption[] {
-        WriteOption.logName(LOG_NAME),
-        WriteOption.resource(DEFAULT_RESOURCE),
-        WriteOption.labels(NATIVE_SEVERITY_MAP)
-      };
   private static final String CONFIG_NAMESPACE = "com.google.cloud.logging.LoggingHandler";
   private static final ImmutableMap<String, String> CONFIG_MAP =
       ImmutableMap.<String, String>builder()
@@ -155,8 +147,15 @@ public class LoggingHandlerTest {
           .put("resourceType", "testResourceType")
           .put("synchronicity", "SYNC")
           .build();
+  private static final ImmutableMap<String, String> NATIVE_SEVERITY_MAP =
+      ImmutableMap.of(
+          "levelName", Level.INFO.getName(), "levelValue", String.valueOf(Level.INFO.intValue()));
   private static final WriteOption[] DEFAULT_OPTIONS =
-      new WriteOption[] {WriteOption.logName(LOG_NAME), WriteOption.resource(DEFAULT_RESOURCE)};
+      new WriteOption[] {
+        WriteOption.logName(LOG_NAME),
+        WriteOption.resource(DEFAULT_RESOURCE),
+        WriteOption.labels(NATIVE_SEVERITY_MAP)
+      };
 
   private static byte[] renderConfig(Map<String, String> config) {
     StringBuilder str = new StringBuilder();
@@ -220,6 +219,8 @@ private static LogRecord newLogRecord(Level level, String message) {
 
   @Test
   public void testPublishLevels() {
+    EasyMock.expect(options.getProjectId()).andReturn(PROJECT).anyTimes();
+    EasyMock.expect(options.getService()).andReturn(logging);
     logging.writeAsync(ImmutableList.of(FINEST_ENTRY), DEFAULT_OPTIONS);
     EasyMock.expectLastCall().andReturn(ApiFutures.immediateFuture(null));
     logging.writeAsync(ImmutableList.of(FINER_ENTRY), DEFAULT_OPTIONS);
@@ -411,9 +412,7 @@ public void testSyncWrite() {
             .addLabel("levelValue", String.valueOf(Level.FINEST.intValue()))
             .setTimestamp(123456789L)
             .build();
-    logging.write(
-        ImmutableList.of(entry),
-        DEFAULT_OPTIONS);
+    logging.write(ImmutableList.of(entry), DEFAULT_OPTIONS);
     EasyMock.replay(options, logging);
     LoggingHandler handler = new LoggingHandler(LOG_NAME, options);
     handler.setLevel(Level.ALL);
@@ -452,8 +451,6 @@ public void testPropertiesFile() throws IOException, InterruptedException {
     LogEntry entry =
         LogEntry.newBuilder(Payload.StringPayload.of(MESSAGE))
             .setSeverity(Severity.DEBUG)
-            .addLabel("levelName", "FINEST")
-            .addLabel("levelValue", String.valueOf(Level.FINEST.intValue()))
             .addLabel("enhanced", "true")
             .setTimestamp(123456789L)
             .build();
@@ -462,7 +459,13 @@ public void testPropertiesFile() throws IOException, InterruptedException {
         WriteOption.logName("testLogName"),
         WriteOption.resource(
             MonitoredResource.of(
-                "testResourceType", ImmutableMap.of("project_id", PROJECT, "enhanced", "true"))));
+                "testResourceType", ImmutableMap.of("project_id", PROJECT, "enhanced", "true"))),
+        WriteOption.labels(
+            ImmutableMap.of(
+                "levelName",
+                Level.FINEST.getName(),
+                "levelValue",
+                String.valueOf(Level.FINEST.intValue()))));
     EasyMock.replay(options, logging);
     LogManager.getLogManager()
         .readConfiguration(new ByteArrayInputStream(renderConfig(CONFIG_MAP)));