Skip to content

The easy-to-use open source Business Intelligence and Embedded Analytics tool that lets everyone work with data :bar_chart:

Add snowplow events when creating a metric (#69990)

Andersond6540d2d6258
diff --git a/e2e/test/scenarios/data-studio/data-studio-metrics.cy.spec.ts b/e2e/test/scenarios/data-studio/data-studio-metrics.cy.spec.ts
index c82dcb0255a..8b9f0e2d04e 100644
--- a/e2e/test/scenarios/data-studio/data-studio-metrics.cy.spec.ts
+++ b/e2e/test/scenarios/data-studio/data-studio-metrics.cy.spec.ts
@@ -23,6 +23,12 @@ describe("scenarios > data studio > library > metrics", () => {
H.DataStudio.Library.newButton().click();
H.popover().findByText("Metric").click();
+ cy.log("Verify metric_create_started event was tracked");
+ H.expectUnstructuredSnowplowEvent({
+ event: "metric_create_started",
+ triggered_from: "data_studio_library",
+ });
+
H.DataStudio.Metrics.queryEditor().should("be.visible");
H.DataStudio.Metrics.saveButton().should("be.disabled");
@@ -49,6 +55,13 @@ describe("scenarios > data studio > library > metrics", () => {
cy.wait("@createCard");
+ cy.log("Verify metric_created event was tracked");
+ H.expectUnstructuredSnowplowEvent({
+ event: "metric_created",
+ triggered_from: "data_studio",
+ result: "success",
+ });
+
cy.log("Verify metric overview page");
cy.url().should("match", /\/data-studio\/library\/metrics\/\d+$/);
@@ -341,6 +354,58 @@ describe("scenarios > data studio > library > metrics", () => {
.should("not.exist");
});
+ describe("analytics events", () => {
+ it("should track metric_create_started and metric_created from browse metrics", () => {
+ cy.visit("/browse/metrics");
+
+ cy.log("Click the plus button to create a new metric");
+ cy.findByRole("link", { name: "Create a new metric" }).click();
+
+ cy.log("Verify metric_create_started event was tracked");
+ H.expectUnstructuredSnowplowEvent({
+ event: "metric_create_started",
+ triggered_from: "browse_metrics",
+ });
+
+ cy.log("Verify we're on the new metric page");
+ cy.url().should("match", /\/metric\/query/);
+
+ cy.findByPlaceholderText(/Search for tables/).type("Orders");
+ H.popover()
+ .findAllByRole("menuitem", { name: /Orders/ })
+ .should("have.length.gte", 1);
+ H.popover()
+ .findAllByRole("menuitem", { name: /Orders/ })
+ .first()
+ .click();
+ cy.findByRole("button", { name: "Save" }).click();
+ cy.findByRole("dialog").findByRole("button", { name: "Save" }).click();
+
+ cy.log("Verify metric_created event was tracked");
+ H.expectUnstructuredSnowplowEvent({
+ event: "metric_created",
+ });
+ });
+
+ it("should track metric_create_started from command palette", () => {
+ cy.visit("/");
+
+ cy.log("Open command palette and create metric");
+ H.openCommandPalette();
+ H.commandPaletteSearch("metric", false);
+ cy.findByRole("option", { name: /New metric/ }).click();
+
+ cy.log("Verify metric_create_started event was tracked");
+ H.expectUnstructuredSnowplowEvent({
+ event: "metric_create_started",
+ triggered_from: "command_palette",
+ });
+
+ cy.log("Verify we're on the new metric page");
+ cy.url().should("match", /\/metric\/query/);
+ });
+ });
+
describe("caching", () => {
it("should allow changing metric caching settings", () => {
cy.log("Navigate to Data Studio Library");
diff --git a/e2e/test/scenarios/metrics/metrics-editing.cy.spec.js b/e2e/test/scenarios/metrics/metrics-editing.cy.spec.js
index a0374a22800..db302ad1a93 100644
--- a/e2e/test/scenarios/metrics/metrics-editing.cy.spec.js
+++ b/e2e/test/scenarios/metrics/metrics-editing.cy.spec.js
@@ -69,6 +69,7 @@ const ORDERS_MULTI_STAGE_QUESTION = {
describe("scenarios > metrics > editing", () => {
beforeEach(() => {
H.restore();
+ H.resetSnowplow();
cy.signInAsNormalUser();
});
@@ -120,12 +121,25 @@ describe("scenarios > metrics > editing", () => {
.should("be.visible")
.click();
+ cy.log("Verify metric_create_started event was tracked");
+ H.expectUnstructuredSnowplowEvent({
+ event: "metric_create_started",
+ triggered_from: "browse_metrics",
+ });
+
H.miniPicker().within(() => {
cy.findByText("Sample Database").click();
cy.findByText("Orders").click();
});
saveMetric();
+ cy.log("Verify metric_created event was tracked");
+ H.expectUnstructuredSnowplowEvent({
+ event: "metric_created",
+ triggered_from: "main_app",
+ result: "success",
+ });
+
cy.log("Go to the collection this metric was saved in");
cy.findByTestId("head-crumbs-container")
.find('a[href*="collection"]')
diff --git a/enterprise/frontend/src/metabase-enterprise/data-studio/library/LibrarySectionLayout/CreateMenu.tsx b/enterprise/frontend/src/metabase-enterprise/data-studio/library/LibrarySectionLayout/CreateMenu.tsx
index 2f0e6ff7402..50ceccc8404 100644
--- a/enterprise/frontend/src/metabase-enterprise/data-studio/library/LibrarySectionLayout/CreateMenu.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/data-studio/library/LibrarySectionLayout/CreateMenu.tsx
@@ -3,6 +3,7 @@ import { push } from "react-router-redux";
import { t } from "ttag";
import { ForwardRefLink } from "metabase/common/components/Link";
+import { trackMetricCreateStarted } from "metabase/data-studio/analytics";
import { useDispatch, useSelector } from "metabase/lib/redux";
import * as Urls from "metabase/lib/urls";
import { PLUGIN_SNIPPET_FOLDERS } from "metabase/plugins";
@@ -54,6 +55,7 @@ export const CreateMenu = ({
collectionId: metricCollectionId,
})}
leftSection={<FixedSizeIcon name="metric" />}
+ onClickCapture={() => trackMetricCreateStarted("data_studio_library")}
>
{t`Metric`}
</Menu.Item>
diff --git a/enterprise/frontend/src/metabase-enterprise/data-studio/library/metrics/pages/NewMetricPage/CreateMetricModal/CreateMetricModal.tsx b/enterprise/frontend/src/metabase-enterprise/data-studio/library/metrics/pages/NewMetricPage/CreateMetricModal/CreateMetricModal.tsx
index 4755b5b6a09..4bb4eb1127d 100644
--- a/enterprise/frontend/src/metabase-enterprise/data-studio/library/metrics/pages/NewMetricPage/CreateMetricModal/CreateMetricModal.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/data-studio/library/metrics/pages/NewMetricPage/CreateMetricModal/CreateMetricModal.tsx
@@ -4,6 +4,7 @@ import * as Yup from "yup";
import { useCreateCardMutation } from "metabase/api";
import FormCollectionPicker from "metabase/collections/containers/FormCollectionPicker";
+import { trackMetricCreated } from "metabase/data-studio/analytics";
import {
Form,
FormErrorMessage,
@@ -71,9 +72,15 @@ function CreateMetricForm({
);
const handleSubmit = async (values: NewMetricValues) => {
- const request = getCreateRequest(query, values);
- const card = await createCard(request).unwrap();
- onCreate(card);
+ try {
+ const request = getCreateRequest(query, values);
+ const card = await createCard(request).unwrap();
+ trackMetricCreated("success", "data_studio", card.id);
+ onCreate(card);
+ } catch (error) {
+ trackMetricCreated("failure", "data_studio", null);
+ throw error;
+ }
};
return (
diff --git a/frontend/src/metabase-types/analytics/event.ts b/frontend/src/metabase-types/analytics/event.ts
index 612671b4f9e..cb4130cf298 100644
--- a/frontend/src/metabase-types/analytics/event.ts
+++ b/frontend/src/metabase-types/analytics/event.ts
@@ -658,6 +658,18 @@ export type DataStudioTableFieldValuesDiscardedEvent = ValidateEvent<{
result: "success" | "failure";
}>;
+export type MetricCreateStartedEvent = ValidateEvent<{
+ event: "metric_create_started";
+ triggered_from: "browse_metrics" | "data_studio_library" | "command_palette";
+}>;
+
+export type MetricCreatedEvent = ValidateEvent<{
+ event: "metric_created";
+ triggered_from: "data_studio" | "main_app";
+ result: "success" | "failure";
+ target_id: number | null;
+}>;
+
export type DataStudioEvent =
| DataStudioOpenedEvent
| DataStudioLibraryCreatedEvent
@@ -673,7 +685,9 @@ export type DataStudioEvent =
| DataStudioBulkAttributeUpdatedEvent
| DataStudioTableSchemaSyncedEvent
| DataStudioTableFieldsRescannedEvent
- | DataStudioTableFieldValuesDiscardedEvent;
+ | DataStudioTableFieldValuesDiscardedEvent
+ | MetricCreateStartedEvent
+ | MetricCreatedEvent;
export type UnsavedChangesWarningDisplayedEvent = ValidateEvent<{
event: "unsaved_changes_warning_displayed";
diff --git a/frontend/src/metabase/browse/metrics/BrowseMetrics.tsx b/frontend/src/metabase/browse/metrics/BrowseMetrics.tsx
index 38b025952e5..fdd7182bf53 100644
--- a/frontend/src/metabase/browse/metrics/BrowseMetrics.tsx
+++ b/frontend/src/metabase/browse/metrics/BrowseMetrics.tsx
@@ -9,6 +9,7 @@ import { ForwardRefLink, Link } from "metabase/common/components/Link";
import { DelayedLoadingAndErrorWrapper } from "metabase/common/components/LoadingAndErrorWrapper/DelayedLoadingAndErrorWrapper";
import { useDocsUrl } from "metabase/common/hooks";
import { useFetchMetrics } from "metabase/common/hooks/use-fetch-metrics";
+import { trackMetricCreateStarted } from "metabase/data-studio/analytics";
import { useSelector } from "metabase/lib/redux";
import * as Urls from "metabase/lib/urls";
import { PLUGIN_CONTENT_VERIFICATION, PLUGIN_LIBRARY } from "metabase/plugins";
@@ -94,7 +95,10 @@ export function BrowseMetrics() {
variant="viewHeader"
component={ForwardRefLink}
to={newMetricLink}
- onClick={() => trackNewMetricInitiated()}
+ onClick={() => {
+ trackNewMetricInitiated();
+ trackMetricCreateStarted("browse_metrics");
+ }}
>
<Icon name="add" />
</ActionIcon>
@@ -169,6 +173,7 @@ function MetricsEmptyState({
component={Link}
to={newMetricLink}
variant="filled"
+ onClick={() => trackMetricCreateStarted("browse_metrics")}
>{t`Create metric`}</Button>
)}
</Flex>
diff --git a/frontend/src/metabase/common/components/SaveQuestionForm/util.ts b/frontend/src/metabase/common/components/SaveQuestionForm/util.ts
index 2369166c152..104b54a7aff 100644
--- a/frontend/src/metabase/common/components/SaveQuestionForm/util.ts
+++ b/frontend/src/metabase/common/components/SaveQuestionForm/util.ts
@@ -5,6 +5,7 @@ import {
canonicalCollectionId,
canonicalCollectionIdOrEntityId,
} from "metabase/collections/utils";
+import { trackMetricCreated } from "metabase/data-studio/analytics";
import { isNullOrUndefined } from "metabase/lib/types";
import type Question from "metabase-lib/v1/Question";
import type { CardType } from "metabase-types/api";
@@ -59,7 +60,22 @@ export const createQuestion = async (options: CreateQuestionOptions) => {
.setCollectionId(collectionId)
.setDashboardId(dashboardId);
- return onCreate(newQuestion, { dashboardTabId });
+ const isMetric = question.type() === "metric";
+
+ try {
+ const result = await onCreate(newQuestion, { dashboardTabId });
+
+ if (isMetric) {
+ trackMetricCreated("success", "main_app", result.id());
+ }
+
+ return result;
+ } catch (error) {
+ if (isMetric) {
+ trackMetricCreated("failure", "main_app", null);
+ }
+ throw error;
+ }
};
export async function submitQuestion(options: SubmitQuestionOptions) {
diff --git a/frontend/src/metabase/data-studio/analytics.ts b/frontend/src/metabase/data-studio/analytics.ts
index fb71f88c732..7cb95dbdd04 100644
--- a/frontend/src/metabase/data-studio/analytics.ts
+++ b/frontend/src/metabase/data-studio/analytics.ts
@@ -146,3 +146,25 @@ export const trackDataStudioOpened = () => {
triggered_from: "nav_menu",
});
};
+
+export const trackMetricCreateStarted = (
+ triggeredFrom: "browse_metrics" | "data_studio_library" | "command_palette",
+) => {
+ trackSimpleEvent({
+ event: "metric_create_started",
+ triggered_from: triggeredFrom,
+ });
+};
+
+export const trackMetricCreated = (
+ result: "success" | "failure",
+ triggeredFrom: "data_studio" | "main_app",
+ targetId: number | null,
+) => {
+ trackSimpleEvent({
+ event: "metric_created",
+ triggered_from: triggeredFrom,
+ result,
+ target_id: targetId,
+ });
+};
diff --git a/frontend/src/metabase/palette/hooks/useCommandPaletteBasicActions.tsx b/frontend/src/metabase/palette/hooks/useCommandPaletteBasicActions.tsx
index e5aa99ab161..3a8a099eacb 100644
--- a/frontend/src/metabase/palette/hooks/useCommandPaletteBasicActions.tsx
+++ b/frontend/src/metabase/palette/hooks/useCommandPaletteBasicActions.tsx
@@ -9,6 +9,7 @@ import {
useDatabaseListQuery,
useSearchListQuery,
} from "metabase/common/hooks";
+import { trackMetricCreateStarted } from "metabase/data-studio/analytics";
import { Collections } from "metabase/entities/collections/collections";
import { useDispatch, useSelector } from "metabase/lib/redux";
import * as Urls from "metabase/lib/urls";
@@ -190,6 +191,7 @@ export const useCommandPaletteBasicActions = ({
section: "basic",
icon: "metric",
perform: () => {
+ trackMetricCreateStarted("command_palette");
dispatch(closeModal());
dispatch(push("metric/query"));
dispatch(