diff --git a/plugins/catalog-node/src/scmEvents/types.ts b/plugins/catalog-node/src/scmEvents/types.ts index 92c3ea9b13..72161cacde 100644 --- a/plugins/catalog-node/src/scmEvents/types.ts +++ b/plugins/catalog-node/src/scmEvents/types.ts @@ -58,7 +58,11 @@ export interface CatalogScmEventsService { /** * As a consumer of SCM events, mark that you have taken an action as a result - * of an SCM event. This + * of an SCM event. + * + * This is typically used to record metrics or other observability signals + * about how SCM events are handled, for example counting how many refresh, + * delete, create, or move operations are triggered by incoming events. */ markEventActionTaken(options: { /**