posthog-node 3.2.1 → 3.3.0

package/lib/index.d.ts

@@ -316,7 +316,7 @@ declare class PostHog extends PostHogCoreStateless implements PostHogNodeV1 {
     private _memoryStorage;
     private featureFlagsPoller?;
     private maxCacheSize;
-    private options;
+    readonly options: PostHogOptions;
     distinctIdHasSentFlagCalls: Record<string, string[]>;
     constructor(apiKey: string, options?: PostHogOptions);
     getPersistedProperty(key: PostHogPersistedProperty): any | undefined;
@@ -379,4 +379,44 @@ declare class PostHog extends PostHogCoreStateless implements PostHogNodeV1 {
     shutdownAsync(): Promise<void>;
 }
 
-export { PostHog, PostHogOptions };
+/**
+ * @file Adapted from [posthog-js](https://github.com/PostHog/posthog-js/blob/8157df935a4d0e71d2fefef7127aa85ee51c82d1/src/extensions/sentry-integration.ts) with modifications for the Node SDK.
+ */
+
+declare type _SentryEventProcessor = any;
+declare type _SentryHub = any;
+interface _SentryIntegration {
+    name: string;
+    setupOnce(addGlobalEventProcessor: (callback: _SentryEventProcessor) => void, getCurrentHub: () => _SentryHub): void;
+}
+/**
+ * Integrate Sentry with PostHog. This will add a direct link to the person in Sentry, and an $exception event in PostHog.
+ *
+ * ### Usage
+ *
+ *     Sentry.init({
+ *          dsn: 'https://example',
+ *          integrations: [
+ *              new PostHogSentryIntegration(posthog)
+ *          ]
+ *     })
+ *
+ *     Sentry.setTag(PostHogSentryIntegration.POSTHOG_ID_TAG, 'some distinct id');
+ *
+ * @param {Object} [posthog] The posthog object
+ * @param {string} [organization] Optional: The Sentry organization, used to send a direct link from PostHog to Sentry
+ * @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/)
+ */
+declare class PostHogSentryIntegration implements _SentryIntegration {
+    private readonly posthog;
+    private readonly posthogHost?;
+    private readonly organization?;
+    private readonly prefix?;
+    readonly name = "posthog-node";
+    static readonly POSTHOG_ID_TAG = "posthog_distinct_id";
+    constructor(posthog: PostHog, posthogHost?: string | undefined, organization?: string | undefined, prefix?: string | undefined);
+    setupOnce(addGlobalEventProcessor: (callback: _SentryEventProcessor) => void, getCurrentHub: () => _SentryHub): void;
+}
+
+export { PostHog, PostHogOptions, PostHogSentryIntegration };

package/lib/index.esm.js

@@ -154,7 +154,7 @@ function __spreadArray(to, from, pack) {
     return to.concat(ar || Array.prototype.slice.call(from));
 }
 
-var version = "3.2.1";
+var version = "3.3.0";
 
 var PostHogPersistedProperty;
 (function (PostHogPersistedProperty) {
@@ -3005,5 +3005,94 @@ function (_super) {
   return PostHog;
 }(PostHogCoreStateless);
 
-export { PostHog };
+/**
+ * Integrate Sentry with PostHog. This will add a direct link to the person in Sentry, and an $exception event in PostHog.
+ *
+ * ### Usage
+ *
+ *     Sentry.init({
+ *          dsn: 'https://example',
+ *          integrations: [
+ *              new PostHogSentryIntegration(posthog)
+ *          ]
+ *     })
+ *
+ *     Sentry.setTag(PostHogSentryIntegration.POSTHOG_ID_TAG, 'some distinct id');
+ *
+ * @param {Object} [posthog] The posthog object
+ * @param {string} [organization] Optional: The Sentry organization, used to send a direct link from PostHog to Sentry
+ * @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/)
+ */
+var PostHogSentryIntegration =
+/** @class */
+function () {
+  function PostHogSentryIntegration(posthog, posthogHost, organization, prefix) {
+    var _a;
+
+    this.posthog = posthog;
+    this.posthogHost = posthogHost;
+    this.organization = organization;
+    this.prefix = prefix;
+    this.name = 'posthog-node';
+    this.posthogHost = (_a = posthog.options.host) !== null && _a !== void 0 ? _a : 'https://app.posthog.com';
+  }
+
+  PostHogSentryIntegration.prototype.setupOnce = function (addGlobalEventProcessor, getCurrentHub) {
+    var _this = this;
+
+    addGlobalEventProcessor(function (event) {
+      var _a, _b, _c, _d, _e, _f, _g, _h;
+
+      if (((_a = event.exception) === null || _a === void 0 ? void 0 : _a.values) === undefined || event.exception.values.length === 0) {
+        return event;
+      }
+
+      if (!event.tags) {
+        event.tags = {};
+      }
+
+      var sentry = getCurrentHub(); // Get the PostHog user ID from a specific tag, which users can set on their Sentry scope as they need.
+
+      var userId = event.tags[PostHogSentryIntegration.POSTHOG_ID_TAG];
+
+      if (userId === undefined) {
+        // If we can't find a user ID, don't bother linking the event. We won't be able to send anything meaningful to PostHog without it.
+        return event;
+      }
+
+      event.tags['PostHog Person URL'] = new URL("/person/".concat(userId), _this.posthogHost).toString();
+      var properties = {
+        // PostHog Exception Properties
+        $exception_message: (_b = event.exception.values[0]) === null || _b === void 0 ? void 0 : _b.value,
+        $exception_type: (_c = event.exception.values[0]) === null || _c === void 0 ? void 0 : _c.type,
+        $exception_personURL: event.tags['PostHog Person URL'],
+        // Sentry Exception Properties
+        $sentry_event_id: event.event_id,
+        $sentry_exception: event.exception,
+        $sentry_exception_message: (_d = event.exception.values[0]) === null || _d === void 0 ? void 0 : _d.value,
+        $sentry_exception_type: (_e = event.exception.values[0]) === null || _e === void 0 ? void 0 : _e.type,
+        $sentry_tags: event.tags
+      };
+      var projectId = (_g = (_f = sentry.getClient()) === null || _f === void 0 ? void 0 : _f.getDsn()) === null || _g === void 0 ? void 0 : _g.projectId;
+
+      if (_this.organization !== undefined && projectId !== undefined && event.event_id !== undefined) {
+        properties.$sentry_url = "".concat((_h = _this.prefix) !== null && _h !== void 0 ? _h : 'https://sentry.io/organizations', "/").concat(_this.organization, "/issues/?project=").concat(projectId, "&query=").concat(event.event_id);
+      }
+
+      _this.posthog.capture({
+        event: '$exception',
+        distinctId: userId,
+        properties: properties
+      });
+
+      return event;
+    });
+  };
+
+  PostHogSentryIntegration.POSTHOG_ID_TAG = 'posthog_distinct_id';
+  return PostHogSentryIntegration;
+}();
+
+export { PostHog, PostHogSentryIntegration };
 //# sourceMappingURL=index.esm.js.map