feat: Add support for partialSuccess global configuration (#1359)

* feat: Add support for partialSuccess global configuration * 🦉 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>
googleapis · Oct 27, 2022 · 178b19f · 178b19f
1 parent eda9661
commit 178b19f
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 7 deletions.
diff --git a/src/log.ts b/src/log.ts
@@ -61,6 +61,7 @@ export interface LogOptions {
  maxEntrySize?: number; // see: https://cloud.google.com/logging/quotas
  jsonFieldsToTruncate?: string[];
  defaultWriteDeleteCallback?: ApiResponseCallback;
+ partialSuccess?: boolean;
 }
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -95,6 +96,9 @@ export type DeleteCallback = ApiResponseCallback;
  * Note that {@link LogOptions#defaultWriteDeleteCallback} is useful when {@link Log#write} and {@link Log#delete} APIs are called
  * without `await` and without callback added explicitly to every call - this way {@link LogOptions#defaultWriteDeleteCallback}
  * can serve as global callback handler, which for example could be used to catch all errors and eliminate crashes.
+ * @param {boolean} [options.partialSuccess] Global flag indicating Whether a batch's valid entries should be written even if
+ * some other entry failed due to errors. Default is true.
+ * See {@link https://cloud.google.com/logging/docs/reference/v2/rest/v2/entries/write#body.request_body.FIELDS.partial_success|partialSuccess} for more info.
  * @example
  * ```
  * import {Logging} from '@google-cloud/logging';
@@ -122,6 +126,7 @@ class Log implements LogSeverityFunctions {
  name: string;
  jsonFieldsToTruncate: string[];
  defaultWriteDeleteCallback?: ApiResponseCallback;
+ partialSuccess: boolean;
 
  constructor(logging: Logging, name: string, options?: LogOptions) {
  options = options || {};
@@ -170,6 +175,13 @@ class Log implements LogSeverityFunctions {
  * was set by user and only for APIs which does not accept a callback as parameter
  */
  this.defaultWriteDeleteCallback = options.defaultWriteDeleteCallback;
+
+ /**
+ Turning partialSuccess by default to be true if not provided in options. This should improve
+ overall logging reliability since only oversized entries will be dropped
+ from request. See {@link https://cloud.google.com/logging/quotas#log-limits} for more info
+ */
+ this.partialSuccess = options.partialSuccess ?? true;
  }
 
  /**
@@ -967,9 +979,10 @@ class Log implements LogSeverityFunctions {
  // Extract & format additional context from individual entries. Make sure to add instrumentation info
  const info = populateInstrumentationInfo(entry);
  const decoratedEntries = this.decorateEntries(info[0]);
- // If instrumentation info was added make sure we set partialSuccess, so entire
- // request will make it through and only oversized entries will be dropped if any
- if (info[1]) {
+ // If instrumentation info was added or this.partialSuccess was set, make sure we set
+ // partialSuccess in outgoing write request, so entire request will make it through and
+ // only oversized entries will be dropped if any
+ if (info[1] || (options.partialSuccess ?? this.partialSuccess)) {
  options.partialSuccess = true;
  }
  this.truncateEntries(decoratedEntries);

diff --git a/test/log.ts b/test/log.ts
@@ -379,6 +379,7 @@ describe('Log', () => {
  {
  logName: log.formattedName_,
  entries: ENTRIES,
+ partialSuccess: true,
  resource: {
  labels: {
  project_id: 'fake-project',
@@ -449,6 +450,7 @@ describe('Log', () => {
  {
  logName: log.formattedName_,
  entries: ENTRIES,
+ partialSuccess: true,
  resource: EXPECTED_RESOURCE,
  },
  undefined,
@@ -464,6 +466,7 @@ describe('Log', () => {
  {
  logName: log.formattedName_,
  entries: ENTRIES,
+ partialSuccess: true,
  resource: FAKE_RESOURCE,
  },
  undefined,
@@ -480,6 +483,7 @@ describe('Log', () => {
  {
  logName: log.formattedName_,
  entries: ENTRIES,
+ partialSuccess: true,
  resource: FAKE_RESOURCE,
  },
  undefined,
@@ -534,10 +538,10 @@ describe('Log', () => {
  it('should not require options', async () => {
  await log.write(ENTRY);
  assert(
- log.logging.loggingService.writeLogEntries.calledOnceWithExactly(
- sinon.match.object,
- undefined,
- undefined
+ log.logging.loggingService.writeLogEntries.calledOnceWith(
+ sinon.match({
+  partialSuccess: true,
+ })
  )
  );
  });