🎉 add @bugsnag/browser-performance and GIT_REVISION to bugsnag initia…

…lization

ops/buildkite/build-code

@@ -55,6 +55,12 @@ update_env() {
     else
         sed -i "s|^BAKED_SITE_DIR=.*$|BAKED_SITE_DIR=/home/owid/live-data/bakedSite|" owid-grapher/.env
     fi
+    # set GIT_REVISION based on current hash, used for Bugsnag
+    if ! grep -q "^GIT_REVISION=" owid-grapher/.env; then
+        echo "GIT_REVISION=$(git rev-parse HEAD)" >> owid-grapher/.env
+    else
+        sed -i "s|^GIT_REVISION=.*$|GIT_REVISION=$(git rev-parse HEAD)|" owid-grapher/.env
+    fi
     # redirect assets
     if ! grep -q "^BAKED_GRAPHER_EXPORTS_BASE_URL=" owid-grapher/.env; then
         echo "BAKED_GRAPHER_EXPORTS_BASE_URL=https://assets.ourworldindata.org/grapher/exports" >> owid-grapher/.env

package.json

@@ -46,6 +46,7 @@
         "@algolia/autocomplete-plugin-recent-searches": "^1.17.2",
         "@algolia/autocomplete-theme-classic": "^1.17.2",
         "@aws-sdk/client-s3": "^3.626.0",
+        "@bugsnag/browser-performance": "^2.4.1",
         "@bugsnag/core": "^7.19.0",
         "@bugsnag/js": "^7.20.0",
         "@bugsnag/plugin-express": "^7.19.0",

settings/clientSettings.ts

@@ -17,7 +17,7 @@ import { parseIntOrUndefined } from "@ourworldindata/utils"
 
 export const ENV: "development" | "production" =
     process.env.ENV === "production" ? "production" : "development"
-
+export const GIT_REVISION = process.env.GIT_REVISION ?? "unknown"
 export const BUGSNAG_API_KEY: string | undefined = process.env.BUGSNAG_API_KEY
 export const ADMIN_SERVER_PORT: number =
     parseIntOrUndefined(process.env.ADMIN_SERVER_PORT) ?? 3030

site/owid.entry.ts

@@ -17,13 +17,15 @@ import {
     ENV,
     BUGSNAG_API_KEY,
     ADMIN_BASE_URL,
+    GIT_REVISION,
 } from "../settings/clientSettings.js"
 import { Grapher, CookieKey } from "@ourworldindata/grapher"
 import { MultiEmbedderSingleton } from "../site/multiembedder/MultiEmbedder.js"
 import { CoreTable } from "@ourworldindata/core-table"
 import { SiteAnalytics } from "./SiteAnalytics.js"
 import Bugsnag, { BrowserConfig } from "@bugsnag/js"
 import BugsnagPluginReact from "@bugsnag/plugin-react"
+import BugsnagPerformance from "@bugsnag/browser-performance"
 import { runMonkeyPatchForGoogleTranslate } from "./hacks.js"
 import { runSiteFooterScripts } from "./runSiteFooterScripts.js"
 import {
@@ -74,11 +76,17 @@ if (BUGSNAG_API_KEY) {
 
         Bugsnag.start({
             apiKey: BUGSNAG_API_KEY,
+            appVersion: GIT_REVISION,
             plugins: [new BugsnagPluginReact()],
             autoTrackSessions: false,
             collectUserIp: false,
             ...bugsnagUserInformation,
         })
+        BugsnagPerformance.start({
+            apiKey: BUGSNAG_API_KEY,
+            appVersion: GIT_REVISION,
+            ...bugsnagUserInformation,
+        })
     } catch (error) {
         console.error("Failed to initialize Bugsnag")
     }