feat: optionally exclude exception capture from sentry integration (#2312)

Author: daibhin

.changeset/pink-birds-switch.md

@@ -0,0 +1,6 @@
+---
+'posthog-js': patch
+'posthog-node': patch
+---
+
+chore: allow PostHog exception capture to be skipped in Sentry integration

packages/browser/src/extensions/sentry-integration.ts

@@ -15,6 +15,7 @@
  * @param {Number} [projectId] Optional: The Sentry project id, used to send a direct link from PostHog to Sentry
  * @param {string} [prefix] Optional: Url of a self-hosted sentry instance (default: https://sentry.io/organizations/)
  * @param {SeverityLevel[] | '*'} [severityAllowList] Optional: send events matching the provided levels. Use '*' to send all events (default: ['error'])
+ * @param {boolean} [sendExceptionsToPostHog] Optional: capture exceptions as events in PostHog (default: true)
  */
 
 import { PostHog } from '../posthog-core'
@@ -63,13 +64,20 @@ export type SentryIntegrationOptions = {
     projectId?: number
     prefix?: string
     severityAllowList?: SeverityLevel[] | '*'
+    sendExceptionsToPostHog?: boolean
 }
 
 const NAME = 'posthog-js'
 
 export function createEventProcessor(
     _posthog: PostHog,
-    { organization, projectId, prefix, severityAllowList = ['error'] }: SentryIntegrationOptions = {}
+    {
+        organization,
+        projectId,
+        prefix,
+        severityAllowList = ['error'],
+        sendExceptionsToPostHog = true,
+    }: SentryIntegrationOptions = {}
 ): (event: _SentryEvent) => _SentryEvent {
     return (event) => {
         const shouldProcessLevel = severityAllowList === '*' || severityAllowList.includes(event.level as SeverityLevel)
@@ -135,7 +143,9 @@ export function createEventProcessor(
                 event.event_id
         }
 
-        _posthog.exceptions.sendExceptionEvent(data)
+        if (sendExceptionsToPostHog) {
+            _posthog.exceptions.sendExceptionEvent(data)
+        }
 
         return event
     }
@@ -165,13 +175,20 @@ export class SentryIntegration implements _SentryIntegrationClass {
         organization?: string,
         projectId?: number,
         prefix?: string,
-        severityAllowList?: SeverityLevel[] | '*'
+        severityAllowList?: SeverityLevel[] | '*',
+        sendExceptionsToPostHog?: boolean
     ) {
         // setupOnce gets called by Sentry when it intializes the plugin
         this.name = NAME
         this.setupOnce = function (addGlobalEventProcessor: (callback: _SentryEventProcessor) => void) {
             addGlobalEventProcessor(
-                createEventProcessor(_posthog, { organization, projectId, prefix, severityAllowList })
+                createEventProcessor(_posthog, {
+                    organization,
+                    projectId,
+                    prefix,
+                    severityAllowList,
+                    sendExceptionsToPostHog: sendExceptionsToPostHog ?? true,
+                })
             )
         }
     }

packages/node/src/extensions/sentry-integration.ts

@@ -20,6 +20,7 @@
  * @param {Number} [projectId] Optional: The Sentry project id, used to send a direct link from PostHog to Sentry
  * @param {string} [prefix] Optional: Url of a self-hosted sentry instance (default: https://sentry.io/organizations/)
  * @param {SeverityLevel[] | '*'} [severityAllowList] Optional: send events matching the provided levels. Use '*' to send all events (default: ['error'])
+ * @param {boolean} [sendExceptionsToPostHog] Optional: capture exceptions as events in PostHog (default: true)
  */
 
 import { SeverityLevel } from './error-tracking/types'
@@ -70,13 +71,20 @@ export type SentryIntegrationOptions = {
   projectId?: number
   prefix?: string
   severityAllowList?: SeverityLevel[] | '*'
+  sendExceptionsToPostHog?: boolean
 }
 
 const NAME = 'posthog-node'
 
 export function createEventProcessor(
   _posthog: PostHogBackendClient,
-  { organization, projectId, prefix, severityAllowList = ['error'] }: SentryIntegrationOptions = {}
+  {
+    organization,
+    projectId,
+    prefix,
+    severityAllowList = ['error'],
+    sendExceptionsToPostHog = true,
+  }: SentryIntegrationOptions = {}
 ): (event: _SentryEvent) => _SentryEvent {
   return (event) => {
     const shouldProcessLevel = severityAllowList === '*' || severityAllowList.includes(event.level)
@@ -147,7 +155,9 @@ export function createEventProcessor(
         event.event_id
     }
 
-    _posthog.capture({ event: '$exception', distinctId: userId, properties })
+    if (sendExceptionsToPostHog) {
+      _posthog.capture({ event: '$exception', distinctId: userId, properties })
+    }
 
     return event
   }
@@ -182,7 +192,8 @@ export class PostHogSentryIntegration implements _SentryIntegrationClass {
     _posthog: PostHogBackendClient,
     organization?: string,
     prefix?: string,
-    severityAllowList?: SeverityLevel[] | '*'
+    severityAllowList?: SeverityLevel[] | '*',
+    sendExceptionsToPostHog?: boolean
   ) {
     // setupOnce gets called by Sentry when it intializes the plugin
     this.name = NAME
@@ -197,6 +208,7 @@ export class PostHogSentryIntegration implements _SentryIntegrationClass {
           projectId,
           prefix,
           severityAllowList,
+          sendExceptionsToPostHog: sendExceptionsToPostHog ?? true,
         })
       )
     }