Update integration metrics capturing (#985)

Co-authored-by: Christopher Radek <christopher.radek@segment.com>

Author: zikaari

.changeset/poor-masks-jam.md

@@ -0,0 +1,5 @@
+---
+'@segment/analytics-next': minor
+---
+
+Update integration metrics capturing strategy

packages/browser/package.json

@@ -44,7 +44,7 @@
   "size-limit": [
     {
       "path": "dist/umd/index.js",
-      "limit": "29 KB"
+      "limit": "29.1 KB"
     }
   ],
   "dependencies": {

packages/browser/src/core/stats/metric-helpers.ts

@@ -0,0 +1,28 @@
+import { Context } from '../context'
+
+export interface RecordIntegrationMetricProps {
+  integrationName: string
+  methodName: string
+  didError?: boolean
+  type: 'classic' | 'action'
+}
+
+export function recordIntegrationMetric(
+  ctx: Context,
+  {
+    methodName,
+    integrationName,
+    type,
+    didError = false,
+  }: RecordIntegrationMetricProps
+): void {
+  ctx.stats.increment(
+    `analytics_js.integration.invoke${didError ? '.error' : ''}`,
+    1,
+    [
+      `method:${methodName}`,
+      `integration_name:${integrationName}`,
+      `type:${type}`,
+    ]
+  )
+}

packages/browser/src/plugins/ajs-destination/index.ts

@@ -29,6 +29,7 @@ import {
   isDisabledIntegration as shouldSkipIntegration,
   isInstallableIntegration,
 } from './utils'
+import { recordIntegrationMetric } from '../../core/stats/metric-helpers'
 
 export type ClassType<T> = new (...args: unknown[]) => T
 
@@ -158,18 +159,19 @@ export class LegacyDestination implements DestinationPlugin {
     })
 
     try {
-      ctx.stats.increment('analytics_js.integration.invoke', 1, [
-        `method:initialize`,
-        `integration_name:${this.name}`,
-      ])
-
+      recordIntegrationMetric(ctx, {
+        integrationName: this.name,
+        methodName: 'initialize',
+        type: 'classic',
+      })
       this.integration.initialize()
     } catch (error) {
-      ctx.stats.increment('analytics_js.integration.invoke.error', 1, [
-        `method:initialize`,
-        `integration_name:${this.name}`,
-      ])
-
+      recordIntegrationMetric(ctx, {
+        integrationName: this.name,
+        methodName: 'initialize',
+        type: 'classic',
+        didError: true,
+      })
       throw error
     }
   }
@@ -254,20 +256,23 @@ export class LegacyDestination implements DestinationPlugin {
       traverse: !this.disableAutoISOConversion,
     })
 
-    ctx.stats.increment('analytics_js.integration.invoke', 1, [
-      `method:${eventType}`,
-      `integration_name:${this.name}`,
-    ])
+    recordIntegrationMetric(ctx, {
+      integrationName: this.name,
+      methodName: eventType,
+      type: 'classic',
+    })
 
     try {
       if (this.integration) {
         await this.integration.invoke.call(this.integration, eventType, event)
       }
     } catch (err) {
-      ctx.stats.increment('analytics_js.integration.invoke.error', 1, [
-        `method:${eventType}`,
-        `integration_name:${this.name}`,
-      ])
+      recordIntegrationMetric(ctx, {
+        integrationName: this.name,
+        methodName: eventType,
+        type: 'classic',
+        didError: true,
+      })
       throw err
     }
 

packages/browser/src/plugins/remote-loader/__tests__/action-destination.test.ts

@@ -51,21 +51,29 @@ describe('ActionDestination', () => {
 
     expect(ajs.ctx?.stats.metrics[0]).toMatchObject(
       expect.objectContaining({
-        metric: 'analytics_js.action_plugin.invoke',
-        tags: ['method:load', 'action_plugin_name:testDestination'],
+        metric: 'analytics_js.integration.invoke',
+        tags: [
+          'method:load',
+          'integration_name:testDestination',
+          'type:action',
+        ],
       })
     )
 
     const trackCtx = await ajs.track('test')
 
     const actionInvokeMetric = trackCtx.stats.metrics.find(
-      (m) => m.metric === 'analytics_js.action_plugin.invoke'
+      (m) => m.metric === 'analytics_js.integration.invoke'
     )
 
     expect(actionInvokeMetric).toMatchObject(
       expect.objectContaining({
-        metric: 'analytics_js.action_plugin.invoke',
-        tags: ['method:track', 'action_plugin_name:testDestination'],
+        metric: 'analytics_js.integration.invoke',
+        tags: [
+          'method:track',
+          'integration_name:testDestination',
+          'type:action',
+        ],
       })
     )
   })

packages/browser/src/plugins/remote-loader/index.ts

@@ -10,6 +10,7 @@ import {
 } from '../middleware'
 import { Context, ContextCancelation } from '../../core/context'
 import { Analytics } from '../../core/analytics'
+import { recordIntegrationMetric } from '../../core/stats/metric-helpers'
 
 export interface RemotePlugin {
   /** The name of the remote plugin */
@@ -80,18 +81,19 @@ export class ActionDestination implements DestinationPlugin {
       }
 
       try {
-        ctx.stats.increment('analytics_js.action_plugin.invoke', 1, [
-          `method:${methodName}`,
-          `action_plugin_name:${this.action.name}`,
-        ])
-
+        recordIntegrationMetric(ctx, {
+          integrationName: this.action.name,
+          methodName,
+          type: 'action',
+        })
         await this.action[methodName]!(transformedContext)
       } catch (error) {
-        ctx.stats.increment('analytics_js.action_plugin.invoke.error', 1, [
-          `method:${methodName}`,
-          `action_plugin_name:${this.action.name}`,
-        ])
-
+        recordIntegrationMetric(ctx, {
+          integrationName: this.action.name,
+          methodName,
+          type: 'action',
+          didError: true,
+        })
         throw error
       }
 
@@ -117,18 +119,19 @@ export class ActionDestination implements DestinationPlugin {
 
   async load(ctx: Context, analytics: Analytics): Promise<unknown> {
     try {
-      ctx.stats.increment('analytics_js.action_plugin.invoke', 1, [
-        `method:load`,
-        `action_plugin_name:${this.action.name}`,
-      ])
-
+      recordIntegrationMetric(ctx, {
+        integrationName: this.action.name,
+        methodName: 'load',
+        type: 'action',
+      })
       return await this.action.load(ctx, analytics)
     } catch (error) {
-      ctx.stats.increment('analytics_js.action_plugin.invoke.error', 1, [
-        `method:load`,
-        `action_plugin_name:${this.action.name}`,
-      ])
-
+      recordIntegrationMetric(ctx, {
+        integrationName: this.action.name,
+        methodName: 'load',
+        type: 'action',
+        didError: true,
+      })
       throw error
     }
   }