Logging refactor of JUL + monitored resource construction by jabubake · Pull Request #1847 · googleapis/google-cloud-java

jabubake · 2017-04-03T16:07:57Z

Auto detection of select resources to get JUL working across GCP environments and refactoring of code to help support more adapters like Slf4j.
Testing across GCP in progress.
See Issue #1654

TODO : tests

Sign in to view

+        value = MetadataConfig.getInstanceId();
+        break;
+      case "cluster_name":
+        value = MetadataConfig.getClusterName();


removing flush size config : needs to be better exposed in loggingoptions for control

Sign in to view

      this.flushLevel = config.getFlushLevel();
      String logName = firstNonNull(log, config.getLogName());

+      LoggingOptions loggingOptions = (options != null) ? options : LoggingOptions.getDefaultInstance();


garrettjonesgoogle

Just some quick initial comments.

Sign in to view

+        }
+        return null;
+    }
+}


Sign in to view

+ */
+
+package com.google.cloud.logging;
+/**


Sign in to view

+import static com.google.common.base.MoreObjects.firstNonNull;
+import static com.google.common.base.Preconditions.checkNotNull;
+
+public class LoggingHelper {


michaelbausor

Hi @jabubake! I've just done an initial review - one thing is it looks like it would be good to run the Google Java formatter to clean up some of the indentation issues.

(cc @pongad who asked me to review)

Sign in to view

-    // return null if can't determine
-    return null;
+    // return project id from metadata config
+     return MetadataConfig.getProjectId();


Sign in to view

+  }
+
+  String getLogName() {
+    return getProperty( logFileNameTag, "java.log");


Sign in to view

+  }
+}
+
+


Sign in to view

-  private final List<Enhancer> enhancers;
+  private LoggingHelper loggingHelper;
+  private List<Enhancer> enhancers;
+  private  ErrorHandler errorHandler;


Sign in to view

+
+      LoggingOptions loggingOptions = (options != null) ? options : LoggingOptions.getDefaultInstance();
+      if (options == null) {
+        options = LoggingOptions.getDefaultInstance();


Sign in to view

+      this.flushLevel = config.getFlushLevel();
+      String logName = firstNonNull(log, config.getLogName());
+
+      LoggingOptions loggingOptions = (options != null) ? options : LoggingOptions.getDefaultInstance();


Sign in to view

+    try {
+      logEntryBuilder = logEntryBuilderFor(record);
+    } catch (Exception ex) {
+      errorHandler.handleFormatError(ex);


Sign in to view

+      loggingHelper.close();
+  }
+
+  public synchronized void setFlushLevel(Level level) {


renaming helper -> service

jabubake · 2017-04-05T19:29:32Z

@michaelbausor @garrettjonesgoogle ran the Google java formatter.
I renamed the class to LoggingService : its a wrapper class, if you have a preferred name suggestion, let me know.

pongad · 2017-04-06T06:59:48Z

Codacy seems to be really mad at you, but the flushing code looks fine (at least not any worse than it was before 😆 ). Lots of unit test failures though, are you setting default properties correctly?

meltsufin · 2017-04-06T14:33:13Z

@gregw PTAL

Sign in to view

+      case "instance_id":
+        value = MetadataConfig.getInstanceId();
+        break;
+      case "cluster_name":


Sign in to view

+        break;
+      case "gce_instance":
+        labels = new String[] {"instance_id", "zone"};
+        break;


Sign in to view

+ */
+public class TraceEnhancer implements Enhancer {
+
+  private static final ThreadLocal<String> traceId = new ThreadLocal<>();


Sign in to view

+package com.google.cloud.logging;
+
+/** A Log Enhancer. Used to enhance the {@link LogEntry} */
+public interface Enhancer {


Sign in to view

+import com.google.cloud.MonitoredResource;
+import com.google.cloud.logging.Logging.WriteOption;
+import com.google.common.util.concurrent.Uninterruptibles;
+import java.util.*;


Sign in to view

+      return "gae_app_standard";
+    }
+    if (MetadataConfig.getInstanceId() != null) {
+      return "gce_instance";


garrettjonesgoogle

I finally got a chance to complete a deep review.

Sign in to view

 import com.google.common.base.Strings;
-import java.util.List;
+
+import java.util.*;


Sign in to view

+      } catch (Exception e) {
+        // Ignore exceptions, they are propagated to the error manager.
+      }
+    }


Sign in to view

+
+public class MetadataConfig {
+
+  private static final String metadataUrl = "http://metadata/computeMetadata/v1/";


Sign in to view

+    return getAttribute("instance/", attributeName);
+  }
+
+  private static String getAttribute(String prefix, String attributeName) {


Sign in to view

+  private static final String formatterTag = "formatter";
+  private static final String synchronicityTag = "synchronicity";
+  private static final String resourceTypeTag = "resourceType";
+  private static final String enchancersTag = "enhancers";


Sign in to view

+import com.google.cloud.ServiceOptions;
+import com.google.common.base.Strings;
+
+import java.util.*;


Sign in to view

+
+    addToMap(map, Resource.gce_instance, Label.instance_id, Label.zone);
+
+    resourceTypeWithLabels = Collections.unmodifiableMap(map);


Sign in to view

-            });
-        break;
+    for (LoggingEnhancer enhancer : enhancers) {
+      enhancer.enhanceLogEntry(builder);


Sign in to view

+import java.util.List;
+import java.util.Set;
+
+public class LoggingService {


Sign in to view

+
+  public synchronized void setFlushSeverity(Severity severity) {
+    flushSeverity = severity;
+  }


garrettjonesgoogle

LGTM after my open question to @pongad is answered, and other people's feedback is addressed

Sign in to view

+package com.google.cloud.logging;
+
+/*
+ */


pongad

The volatile makes sense to me. LGTM.

jabubake · 2017-04-18T02:47:44Z

@gregw, I've addressed your comments, PTAL.

meltsufin · 2017-04-18T20:40:05Z

@jabubake You might want to take a look at grpc-context as an alternative thread local to carry the trace id.

jabubake · 2017-04-18T22:29:57Z

@meltsufin : will look into it. @garrettjonesgoogle recommends we do that it in a separate PR.

coveralls · 2017-04-18T23:59:38Z

Coverage decreased (-0.08%) to 80.858% when pulling cca8fc4 on jabubake:ja_logging_refactor into 455f739 on GoogleCloudPlatform:master.

garrettjonesgoogle · 2017-04-19T00:00:47Z

LGTM

meltsufin · 2017-04-19T13:42:43Z

@jabubake and @garrettjonesgoogle thanks pulling this together! When can we expect a push to Maven?

garrettjonesgoogle · 2017-04-19T13:57:08Z

We should have a release by the end of the week.

#1847) * chore: Update generation configuration at Wed Aug 6 02:42:06 UTC 2025 * chore: Update generation configuration at Thu Aug 7 02:41:33 UTC 2025 * chore: Update generation configuration at Fri Aug 8 02:40:44 UTC 2025 * chore: Update generation configuration at Sat Aug 9 02:31:48 UTC 2025 * chore: Update generation configuration at Sun Aug 10 02:43:08 UTC 2025 * chore: Update generation configuration at Mon Aug 11 02:41:33 UTC 2025 * chore: Update generation configuration at Tue Aug 12 02:31:18 UTC 2025 * chore: Update generation configuration at Wed Aug 13 02:31:58 UTC 2025 * chore: Update generation configuration at Thu Aug 14 05:52:20 UTC 2025 * chore: Update generation configuration at Fri Aug 15 02:34:46 UTC 2025 * chore: Update generation configuration at Sat Aug 16 02:30:28 UTC 2025 * chore: generate libraries at Sat Aug 16 02:31:03 UTC 2025 * chore: Update generation configuration at Wed Aug 20 02:30:01 UTC 2025 * chore: generate libraries at Wed Aug 20 02:30:31 UTC 2025 * chore: Update generation configuration at Thu Aug 21 02:29:14 UTC 2025 * chore: Update generation configuration at Fri Aug 22 02:30:19 UTC 2025 * chore: Update generation configuration at Sat Aug 23 02:27:53 UTC 2025 * chore: Update generation configuration at Tue Aug 26 02:29:37 UTC 2025 * chore: Update generation configuration at Wed Aug 27 02:28:43 UTC 2025 * chore: Update generation configuration at Thu Aug 28 02:27:37 UTC 2025 * chore: Update generation configuration at Fri Aug 29 02:29:06 UTC 2025 * chore: generate libraries at Fri Aug 29 02:29:32 UTC 2025 * chore: Update generation configuration at Sat Aug 30 02:25:09 UTC 2025 * chore: Update generation configuration at Wed Sep 3 02:24:33 UTC 2025 * chore: Update generation configuration at Thu Sep 4 02:25:23 UTC 2025 * chore: Update generation configuration at Fri Sep 5 02:26:27 UTC 2025 * chore: Update generation configuration at Sat Sep 6 02:25:42 UTC 2025 * chore: generate libraries at Sat Sep 6 02:26:13 UTC 2025 * chore: Update generation configuration at Tue Sep 9 02:27:36 UTC 2025 * chore: Update generation configuration at Wed Sep 10 02:25:35 UTC 2025 * chore: Update generation configuration at Thu Sep 11 02:27:53 UTC 2025 --------- Co-authored-by: Blake Li <[email protected]>

…v3.48.0 (#1847)

🤖 I have created a release *beep* *boop* --- ## [2.28.2](https://togithub.com/googleapis/java-datastore/compare/v2.28.1...v2.28.2) (2025-05-16) ### Dependencies * Update dependency com.google.cloud:sdk-platform-java-config to v3.48.0 ([#1847](https://togithub.com/googleapis/java-datastore/issues/1847)) ([7ed3232](https://togithub.com/googleapis/java-datastore/commit/7ed32321a5c84c4b2f61094e4c4adb5e36e5bc1b)) * Update googleapis/sdk-platform-java action to v2.58.0 ([#1853](https://togithub.com/googleapis/java-datastore/issues/1853)) ([eef820d](https://togithub.com/googleapis/java-datastore/commit/eef820d017f5e00245924d551abe172a2a39e29f)) --- This PR was generated with [Release Please](https://togithub.com/googleapis/release-please). See [documentation](https://togithub.com/googleapis/release-please#release-please).

…ntials requests (#1847) * fix: Add configurable connect and read timeouts to STS requests * chore: Fix lint issues * chore: Add connect and read timeout to identity pool creds * chore: Propogate connect and read timeouts to all calls

googleapis#1847) * chore: Update generation configuration at Wed Aug 6 02:42:06 UTC 2025 * chore: Update generation configuration at Thu Aug 7 02:41:33 UTC 2025 * chore: Update generation configuration at Fri Aug 8 02:40:44 UTC 2025 * chore: Update generation configuration at Sat Aug 9 02:31:48 UTC 2025 * chore: Update generation configuration at Sun Aug 10 02:43:08 UTC 2025 * chore: Update generation configuration at Mon Aug 11 02:41:33 UTC 2025 * chore: Update generation configuration at Tue Aug 12 02:31:18 UTC 2025 * chore: Update generation configuration at Wed Aug 13 02:31:58 UTC 2025 * chore: Update generation configuration at Thu Aug 14 05:52:20 UTC 2025 * chore: Update generation configuration at Fri Aug 15 02:34:46 UTC 2025 * chore: Update generation configuration at Sat Aug 16 02:30:28 UTC 2025 * chore: generate libraries at Sat Aug 16 02:31:03 UTC 2025 * chore: Update generation configuration at Wed Aug 20 02:30:01 UTC 2025 * chore: generate libraries at Wed Aug 20 02:30:31 UTC 2025 * chore: Update generation configuration at Thu Aug 21 02:29:14 UTC 2025 * chore: Update generation configuration at Fri Aug 22 02:30:19 UTC 2025 * chore: Update generation configuration at Sat Aug 23 02:27:53 UTC 2025 * chore: Update generation configuration at Tue Aug 26 02:29:37 UTC 2025 * chore: Update generation configuration at Wed Aug 27 02:28:43 UTC 2025 * chore: Update generation configuration at Thu Aug 28 02:27:37 UTC 2025 * chore: Update generation configuration at Fri Aug 29 02:29:06 UTC 2025 * chore: generate libraries at Fri Aug 29 02:29:32 UTC 2025 * chore: Update generation configuration at Sat Aug 30 02:25:09 UTC 2025 * chore: Update generation configuration at Wed Sep 3 02:24:33 UTC 2025 * chore: Update generation configuration at Thu Sep 4 02:25:23 UTC 2025 * chore: Update generation configuration at Fri Sep 5 02:26:27 UTC 2025 * chore: Update generation configuration at Sat Sep 6 02:25:42 UTC 2025 * chore: generate libraries at Sat Sep 6 02:26:13 UTC 2025 * chore: Update generation configuration at Tue Sep 9 02:27:36 UTC 2025 * chore: Update generation configuration at Wed Sep 10 02:25:35 UTC 2025 * chore: Update generation configuration at Thu Sep 11 02:27:53 UTC 2025 --------- Co-authored-by: Blake Li <[email protected]>

…ntials requests (#1847) * fix: Add configurable connect and read timeouts to STS requests * chore: Fix lint issues * chore: Add connect and read timeout to identity pool creds * chore: Propogate connect and read timeouts to all calls

…v3.48.0 (#1847)

🤖 I have created a release *beep* *boop* --- ## [2.28.2](https://togithub.com/googleapis/java-datastore/compare/v2.28.1...v2.28.2) (2025-05-16) ### Dependencies * Update dependency com.google.cloud:sdk-platform-java-config to v3.48.0 ([#1847](https://togithub.com/googleapis/java-datastore/issues/1847)) ([bf4a27d](https://togithub.com/googleapis/java-datastore/commit/bf4a27de072d4fe803a14b945e5289932a0d7581)) * Update googleapis/sdk-platform-java action to v2.58.0 ([#1853](https://togithub.com/googleapis/java-datastore/issues/1853)) ([41f9a5d](https://togithub.com/googleapis/java-datastore/commit/41f9a5d9343ddc5a94e2cf598a05e1ef4650cb4d)) --- This PR was generated with [Release Please](https://togithub.com/googleapis/release-please). See [documentation](https://togithub.com/googleapis/release-please#release-please).

…v6.82.0 (googleapis#1847)

…29.0 (#1847) * chore(deps): update dependency com.google.cloud:libraries-bom to v26.29.0 * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md --------- Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>

…v3.36.1 (#1847)

jabubake added 10 commits February 23, 2017 14:03

adding slf4j logging adapter

b4138ca

TODO : tests

fixes, cleanup

2111278

logging refactor wip

bf9ee31

logging refactoring

46cde33

Merge remote-tracking branch 'upstream/master' into logging_refactor

25cef54

sync fork

8ec9a3f

fork sync

9d79afd

handling null options

b7da6f3

Merge remote-tracking branch 'upstream/master' into ja_logging_refactor

e3e41aa

TODO : tests

unit test fixes

dc2bc97

jabubake added the api: logging Issues related to the Cloud Logging API. label Apr 3, 2017

jabubake requested a review from pongad April 3, 2017 16:07

googlebot added the cla: yes This human has signed the Contributor License Agreement. label Apr 3, 2017

duchuyctlk reviewed Apr 3, 2017

View reviewed changes

jabubake added 2 commits April 3, 2017 10:21

adding missing break

db1d11a

removing in-memory buffering

efbb5c9

removing flush size config : needs to be better exposed in loggingoptions for control

duchuyctlk reviewed Apr 4, 2017

View reviewed changes

garrettjonesgoogle reviewed Apr 4, 2017

View reviewed changes

michaelbausor reviewed Apr 4, 2017

View reviewed changes

jabubake added 2 commits April 5, 2017 12:24

formatting updates

ba5efba

renaming helper -> service

formatting fixes

9a239cf

reverting formatting on files not related to update

d62d94e

garrettjonesgoogle reviewed Apr 6, 2017

View reviewed changes

jabubake added 3 commits April 6, 2017 17:22

code review fixes

7647a11

format update

3d5b71d

code cleanup MonitoredResourceUtil

573395e

garrettjonesgoogle reviewed Apr 11, 2017

View reviewed changes

moving flush severity, sychnronicity to volatile

f2d15ba

garrettjonesgoogle reviewed Apr 17, 2017

View reviewed changes

Comment thread google-cloud-logging/src/main/java/com/google/cloud/logging/TraceLoggingEnhancer.java Outdated

package com.google.cloud.logging;

/*

*/

This comment was marked as spam.

Sign in to view

This comment was marked as spam.

Sign in to view

pongad reviewed Apr 18, 2017

View reviewed changes

adding javadoc

ae68387

jabubake added 3 commits April 18, 2017 09:30

updating logging snippets, writeAsync => write

d0d11f0

Merge remote-tracking branch 'upstream/master' into ja_logging_refactor

b029633

fixing unit test

0b2e670

jabubake added 2 commits April 18, 2017 16:03

adding defaultSeverity argument

ab0e527

removing flaky unit test in reading properties file

cca8fc4

jabubake merged commit 101e56e into googleapis:master Apr 19, 2017

jabubake deleted the ja_logging_refactor branch April 19, 2017 00:02

chingor13 pushed a commit that referenced this pull request Jan 22, 2026

deps: update dependency com.google.cloud:sdk-platform-java-config to …

7ed3232

…v3.48.0 (#1847)

lqiu96 pushed a commit that referenced this pull request Mar 20, 2026

deps: update dependency com.google.cloud:sdk-platform-java-config to …

bf4a27d

…v3.48.0 (#1847)

suztomo pushed a commit to suztomo/google-cloud-java that referenced this pull request Mar 23, 2026

deps: update dependency com.google.cloud:google-cloud-spanner-bom to …

a1dfee4

…v6.82.0 (googleapis#1847)

meltsufin pushed a commit that referenced this pull request May 2, 2026

deps: update dependency com.google.cloud:sdk-platform-java-config to …

4392b5f

…v3.36.1 (#1847)


		public class MetadataConfig {

		private static final String metadataUrl = "http://metadata/computeMetadata/v1/";


		addToMap(map, Resource.gce_instance, Label.instance_id, Label.zone);

		resourceTypeWithLabels = Collections.unmodifiableMap(map);

Conversation

jabubake commented Apr 3, 2017

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

garrettjonesgoogle left a comment

Choose a reason for hiding this comment

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

michaelbausor left a comment

Choose a reason for hiding this comment

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

jabubake commented Apr 5, 2017

Uh oh!

pongad commented Apr 6, 2017

Uh oh!

meltsufin commented Apr 6, 2017

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

garrettjonesgoogle left a comment

Choose a reason for hiding this comment

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!