Skip to content

Commit 74b9163

Browse files
committed
update docstring
1 parent b110577 commit 74b9163

File tree

1 file changed

+9
-4
lines changed

1 file changed

+9
-4
lines changed

packages/common/src/failure.ts

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -101,10 +101,15 @@ export const [encodeRetryState, decodeRetryState] = makeProtoEnumConverters<
101101
'RETRY_STATE_'
102102
);
103103

104+
/**
105+
* A category to describe the severity and change the observability behavior of an application failure.
106+
*
107+
* Currently, observability behaviour changes are limited to:
108+
* - activities that fail due to a BENIGN application failure emit DEBUG level logs and do not record metrics
109+
*
110+
* @experimental Category is a new feature and may be subject to change.
111+
*/
104112
export const ApplicationFailureCategory = {
105-
/**
106-
* BENIGN category errors emit DEBUG level logs and do not record metrics
107-
*/
108113
BENIGN: 'BENIGN',
109114
} as const;
110115

@@ -288,7 +293,7 @@ export interface ApplicationFailureOptions {
288293

289294
/**
290295
* Severity category of the application error.
291-
* Maps to corresponding client-side logging/metrics behaviors.
296+
* Affects worker-side logging and metrics behavior of this failure.
292297
*/
293298
category?: ApplicationFailureCategory;
294299
}

0 commit comments

Comments
 (0)