From 83c163a2343b413842392ea83004e00e389008e5 Mon Sep 17 00:00:00 2001 From: Eric Peterson Date: Sun, 12 Sep 2021 20:37:52 +0200 Subject: [PATCH] Minor changeset and other improvements. Signed-off-by: Eric Peterson --- .changeset/analytics-glimmering-radio-station.md | 9 --------- .changeset/analytics-old-skipping-record.md | 2 +- packages/core-app-api/config.d.ts | 12 ------------ .../core-plugin-api/src/analytics/useAnalytics.tsx | 5 +++-- plugins/analytics-module-ga/package.json | 12 ++++++------ 5 files changed, 10 insertions(+), 30 deletions(-) delete mode 100644 .changeset/analytics-glimmering-radio-station.md diff --git a/.changeset/analytics-glimmering-radio-station.md b/.changeset/analytics-glimmering-radio-station.md deleted file mode 100644 index 2bc5aef678..0000000000 --- a/.changeset/analytics-glimmering-radio-station.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -'@backstage/plugin-analytics-module-ga': patch ---- - -Initial Google Analytics implementation for the Backstage Analytics API, which: - -- Handles pageview and custom event instrumentation idiomatically. -- Enables custom dimension and metric collection via app config. -- Includes configurable debug/test mode for non-production environments. diff --git a/.changeset/analytics-old-skipping-record.md b/.changeset/analytics-old-skipping-record.md index a1ee11af84..9bfa58fd57 100644 --- a/.changeset/analytics-old-skipping-record.md +++ b/.changeset/analytics-old-skipping-record.md @@ -1,5 +1,5 @@ --- -'@backstage/core-plugin-api': minor +'@backstage/core-plugin-api': patch --- Introducing the Analytics API: a lightweight way for plugins to instrument key diff --git a/packages/core-app-api/config.d.ts b/packages/core-app-api/config.d.ts index a2fa3f1989..d88c818d11 100644 --- a/packages/core-app-api/config.d.ts +++ b/packages/core-app-api/config.d.ts @@ -65,18 +65,6 @@ export interface Config { }>; }>; }; - - /** - * Information about how analytics events should be collected in this - * Backstage Instance. - */ - analytics?: { - /** - * The provider used to collect instrumented events. Further - * configuration values depend on the provider specified here. - */ - provider: string; - }; }; /** diff --git a/packages/core-plugin-api/src/analytics/useAnalytics.tsx b/packages/core-plugin-api/src/analytics/useAnalytics.tsx index 8643747f35..b120689e2e 100644 --- a/packages/core-plugin-api/src/analytics/useAnalytics.tsx +++ b/packages/core-plugin-api/src/analytics/useAnalytics.tsx @@ -34,8 +34,9 @@ function useTracker(): AnalyticsTracker { context, domain, }); - } catch { - // Just don't throw on an instrumentation problem. + } catch (e) { + // eslint-disable-next-line no-console + console.warn('Error during analytics event capture. %o', e); } }, }; diff --git a/plugins/analytics-module-ga/package.json b/plugins/analytics-module-ga/package.json index ab55ec9a8a..1618129d90 100644 --- a/plugins/analytics-module-ga/package.json +++ b/plugins/analytics-module-ga/package.json @@ -21,21 +21,21 @@ }, "dependencies": { "@backstage/config": "^0.1.5", - "@backstage/core-components": "^0.4.0", - "@backstage/core-plugin-api": "^0.1.6", + "@backstage/core-components": "^0.4.2", + "@backstage/core-plugin-api": "^0.1.8", "@backstage/theme": "^0.2.10", "@material-ui/core": "^4.12.2", "@material-ui/icons": "^4.9.1", - "@material-ui/lab": "4.0.0-alpha.45", + "@material-ui/lab": "4.0.0-alpha.57", "react": "^16.13.1", "react-dom": "^16.13.1", "react-ga": "^3.3.0", "react-use": "^17.2.4" }, "devDependencies": { - "@backstage/cli": "^0.7.10", - "@backstage/core-app-api": "^0.1.11", - "@backstage/dev-utils": "^0.2.8", + "@backstage/cli": "^0.7.12", + "@backstage/core-app-api": "^0.1.13", + "@backstage/dev-utils": "^0.2.9", "@backstage/test-utils": "^0.1.17", "@testing-library/jest-dom": "^5.10.1", "@testing-library/react": "^11.2.5",