Skip to content

Commit

Permalink
feat: add writeSynchronicity flag to appender configuration (#542)
Browse files Browse the repository at this point in the history
* feat: add support for write synchronicity config

add new adapter configuration to allow setting writeSynchronicity

* chore: set default value and remove debug output

remove debug prints
add option description into class javadoc
setup default value of the instance

* chore: remove async testing from samples

* chore: change type of writeSynchronicity to enum
  • Loading branch information
minherz committed Sep 17, 2021
1 parent 288a368 commit 65ab6f8
Showing 1 changed file with 24 additions and 3 deletions.
Expand Up @@ -33,6 +33,7 @@
import com.google.cloud.logging.MonitoredResourceUtil;
import com.google.cloud.logging.Payload;
import com.google.cloud.logging.Severity;
import com.google.cloud.logging.Synchronicity;
import com.google.common.base.Strings;
import com.google.common.collect.ImmutableList;
import java.io.FileInputStream;
Expand Down Expand Up @@ -63,8 +64,12 @@
* <!-- Optional: defaults to "ERROR" -->
* <flushLevel>WARNING</flushLevel>
*
* <!-- Optional: defaults to ASYNC -->
* <writeSynchronicity>SYNC</writeSynchronicity>
*
* &lt;!-- Optional: auto detects on App Engine Flex, Standard, GCE and GKE, defaults to "global". See <a
* href="https://cloud.google.com/logging/docs/api/v2/resource-list">supported resource types</a> --&gt;
* href=
* "https://cloud.google.com/logging/docs/api/v2/resource-list">supported resource types</a> --&gt;
* &lt;resourceType&gt;&lt;/resourceType&gt;
*
* &lt;!-- Optional: defaults to the default credentials of the environment --&gt;
Expand Down Expand Up @@ -96,6 +101,7 @@ public class LoggingAppender extends UnsynchronizedAppenderBase<ILoggingEvent> {
private String log;
private String resourceType;
private String credentialsFile;
private Synchronicity writeSyncFlag = Synchronicity.ASYNC;
private final Set<String> enhancerClassNames = new HashSet<>();
private final Set<String> loggingEventEnhancerClassNames = new HashSet<>();

Expand All @@ -122,8 +128,9 @@ public void setLog(String log) {
/**
* Sets the name of the monitored resource (Optional).
*
* <p>Must be a <a href="https://cloud.google.com/logging/docs/api/v2/resource-list">supported</a>
* resource type. gae_app, gce_instance and container are auto-detected.
* <p>Must be a <a href=
* "https://cloud.google.com/logging/docs/api/v2/resource-list">supported</a> resource type.
* gae_app, gce_instance and container are auto-detected.
*
* <p>Defaults to "global"
*
Expand All @@ -144,6 +151,15 @@ public void setCredentialsFile(String credentialsFile) {
this.credentialsFile = credentialsFile;
}

/**
* Define synchronization mode for writing log entries.
*
* @param flag to set {@code Synchronicity} value.
*/
public void setWriteSynchronicity(Synchronicity flag) {
this.writeSyncFlag = flag;
}

/** Add extra labels using classes that implement {@link LoggingEnhancer}. */
public void addEnhancer(String enhancerClassName) {
this.enhancerClassNames.add(enhancerClassName);
Expand All @@ -161,6 +177,10 @@ String getLogName() {
return (log != null) ? log : "java.log";
}

public Synchronicity getWriteSynchronicity() {
return (this.writeSyncFlag != null) ? this.writeSyncFlag : Synchronicity.ASYNC;
}

MonitoredResource getMonitoredResource(String projectId) {
return MonitoredResourceUtil.getResource(projectId, resourceType);
}
Expand Down Expand Up @@ -253,6 +273,7 @@ Logging getLogging() {
synchronized (this) {
if (logging == null) {
logging = getLoggingOptions().getService();
logging.setWriteSynchronicity(writeSyncFlag);
}
}
}
Expand Down

0 comments on commit 65ab6f8

Please sign in to comment.