Skip to content

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

Add tracking to the metadata changes from admin (#63672)

Nemanja Glumac6e7aeb6d7147
diff --git a/e2e/test/scenarios/admin/datamodel/datamodel.cy.spec.ts b/e2e/test/scenarios/admin/datamodel/datamodel.cy.spec.ts
index a0c4ebb2db6..43340ae9b49 100644
--- a/e2e/test/scenarios/admin/datamodel/datamodel.cy.spec.ts
+++ b/e2e/test/scenarios/admin/datamodel/datamodel.cy.spec.ts
@@ -1399,6 +1399,15 @@ describe("scenarios > admin > datamodel", () => {
});
describe("Field section", () => {
+ beforeEach(() => {
+ H.resetSnowplow();
+ H.enableTracking();
+ });
+
+ afterEach(() => {
+ H.expectNoBadSnowplowEvents();
+ });
+
describe("Name and description", () => {
it("should allow changing the field name", () => {
H.DataModel.visit({
@@ -1640,6 +1649,11 @@ describe("scenarios > admin > datamodel", () => {
H.popover().should("not.contain.text", "Coercion");
H.popover().findByText("UNIX seconds → Datetime").click();
cy.wait("@updateField");
+ H.expectUnstructuredSnowplowEvent({
+ event: "metadata_edited",
+ event_detail: "type_casting",
+ triggered_from: "admin",
+ });
verifyAndCloseToast("Casting enabled for Rating");
cy.log("verify preview");
@@ -1753,6 +1767,11 @@ describe("scenarios > admin > datamodel", () => {
// it should allow to just type to search (metabase#59052)
.type("no sema{downarrow}{enter}");
cy.wait("@updateField");
+ H.expectUnstructuredSnowplowEvent({
+ event: "metadata_edited",
+ event_detail: "semantic_type_change",
+ triggered_from: "admin",
+ });
H.undoToast().should(
"contain.text",
"Semantic type of Product ID updated",
@@ -2140,6 +2159,11 @@ describe("scenarios > admin > datamodel", () => {
.click();
H.popover().findByText("Everywhere").click();
cy.wait("@updateField");
+ H.expectUnstructuredSnowplowEvent({
+ event: "metadata_edited",
+ event_detail: "visibility_change",
+ triggered_from: "admin",
+ });
verifyAndCloseToast("Visibility of Tax updated");
FieldSection.getVisibilityInput().should("have.value", "Everywhere");
@@ -2327,6 +2351,11 @@ describe("scenarios > admin > datamodel", () => {
.click();
H.popover().findByText("Search box").click();
cy.wait("@updateField");
+ H.expectUnstructuredSnowplowEvent({
+ event: "metadata_edited",
+ event_detail: "filtering_change",
+ triggered_from: "admin",
+ });
verifyAndCloseToast("Filtering of Quantity updated");
cy.log("verify preview");
@@ -2488,6 +2517,11 @@ describe("scenarios > admin > datamodel", () => {
H.popover().findByText("Use foreign key").click();
H.popover().findByText("Title").click();
cy.wait("@updateFieldDimension");
+ H.expectUnstructuredSnowplowEvent({
+ event: "metadata_edited",
+ event_detail: "display_values",
+ triggered_from: "admin",
+ });
H.undoToast().should(
"contain.text",
"Display values of Product ID updated",
@@ -2575,6 +2609,11 @@ describe("scenarios > admin > datamodel", () => {
FieldSection.getDisplayValuesInput().scrollIntoView().click();
H.popover().findByText("Custom mapping").click();
cy.wait("@updateFieldValues");
+ H.expectUnstructuredSnowplowEvent({
+ event: "metadata_edited",
+ event_detail: "display_values",
+ triggered_from: "admin",
+ });
H.undoToast().should(
"contain.text",
"Display values of Num updated",
@@ -2929,6 +2968,11 @@ describe("scenarios > admin > datamodel", () => {
FieldSection.getUnfoldJsonInput().should("have.value", "Yes").click();
H.popover().findByText("No").click();
cy.wait("@updateField");
+ H.expectUnstructuredSnowplowEvent({
+ event: "metadata_edited",
+ event_detail: "json_unfolding",
+ triggered_from: "admin",
+ });
H.undoToast().should(
"contain.text",
"JSON unfolding disabled for Json",
@@ -3049,6 +3093,11 @@ describe("scenarios > admin > datamodel", () => {
FieldSection.getStyleInput().click();
H.popover().findByText("Percent").click();
cy.wait("@updateField");
+ H.expectUnstructuredSnowplowEvent({
+ event: "metadata_edited",
+ event_detail: "formatting",
+ triggered_from: "admin",
+ });
verifyAndCloseToast("Formatting of Quantity updated");
cy.log("verify preview");
diff --git a/frontend/src/metabase-types/analytics/event.ts b/frontend/src/metabase-types/analytics/event.ts
index 81b87b0bf07..2a84a7cbcae 100644
--- a/frontend/src/metabase-types/analytics/event.ts
+++ b/frontend/src/metabase-types/analytics/event.ts
@@ -3,6 +3,7 @@ import type {
ChecklistItemCTA,
ChecklistItemValue,
} from "metabase/home/components/Onboarding/types";
+import type { MetadataEditAnalyticsDetail } from "metabase/metadata/pages/DataModel/types";
import type { KeyboardShortcutId } from "metabase/palette/shortcuts";
import type {
Engine,
@@ -420,6 +421,12 @@ export type LearnAboutDataClickedEvent = ValidateEvent<{
event: "learn_about_our_data_clicked";
}>;
+export type MetadataEditEvent = ValidateEvent<{
+ event: "metadata_edited";
+ event_detail: MetadataEditAnalyticsDetail;
+ triggered_from: "admin";
+}>;
+
export type SimpleEvent =
| CustomSMTPSetupClickedEvent
| CustomSMTPSetupSuccessEvent
@@ -468,4 +475,5 @@ export type SimpleEvent =
| XRayEvent
| MetabotEvent
| RevertVersionEvent
- | LearnAboutDataClickedEvent;
+ | LearnAboutDataClickedEvent
+ | MetadataEditEvent;
diff --git a/frontend/src/metabase/metadata/pages/DataModel/analytics.ts b/frontend/src/metabase/metadata/pages/DataModel/analytics.ts
new file mode 100644
index 00000000000..2c699972e42
--- /dev/null
+++ b/frontend/src/metabase/metadata/pages/DataModel/analytics.ts
@@ -0,0 +1,11 @@
+import { trackSimpleEvent } from "metabase/lib/analytics";
+
+import type { MetadataEditAnalyticsDetail } from "./types";
+
+export const trackMetadataChange = (detail: MetadataEditAnalyticsDetail) => {
+ trackSimpleEvent({
+ event: "metadata_edited",
+ event_detail: detail,
+ triggered_from: "admin",
+ });
+};
diff --git a/frontend/src/metabase/metadata/pages/DataModel/components/FieldSection/BehaviorSection/BehaviorSection.tsx b/frontend/src/metabase/metadata/pages/DataModel/components/FieldSection/BehaviorSection/BehaviorSection.tsx
index 972fd0f85b9..dfc8eeb4927 100644
--- a/frontend/src/metabase/metadata/pages/DataModel/components/FieldSection/BehaviorSection/BehaviorSection.tsx
+++ b/frontend/src/metabase/metadata/pages/DataModel/components/FieldSection/BehaviorSection/BehaviorSection.tsx
@@ -21,6 +21,7 @@ import type {
FieldVisibilityType,
} from "metabase-types/api";
+import { trackMetadataChange } from "../../../analytics";
import { TitledSection } from "../../TitledSection";
import { RemappingPicker } from "./RemappingPicker";
@@ -48,6 +49,8 @@ const BehaviorSectionBase = ({ databaseId, field }: Props) => {
visibility_type: visibilityType,
});
+ trackMetadataChange("visibility_change");
+
if (error) {
sendErrorToast(t`Failed to update visibility of ${field.display_name}`);
} else {
@@ -70,6 +73,8 @@ const BehaviorSectionBase = ({ databaseId, field }: Props) => {
has_field_values: hasFieldValues,
});
+ trackMetadataChange("filtering_change");
+
if (error) {
sendErrorToast(t`Failed to update filtering of ${field.display_name}`);
} else {
@@ -101,6 +106,8 @@ const BehaviorSectionBase = ({ databaseId, field }: Props) => {
: t`Failed to disable JSON unfolding for ${field.display_name}`,
);
} else {
+ trackMetadataChange("json_unfolding");
+
sendSuccessToast(
jsonUnfolding
? t`JSON unfolding enabled for ${field.display_name}`
diff --git a/frontend/src/metabase/metadata/pages/DataModel/components/FieldSection/BehaviorSection/RemappingPicker/RemappingPicker.tsx b/frontend/src/metabase/metadata/pages/DataModel/components/FieldSection/BehaviorSection/RemappingPicker/RemappingPicker.tsx
index ae7df4a4892..59e8e3b0e61 100644
--- a/frontend/src/metabase/metadata/pages/DataModel/components/FieldSection/BehaviorSection/RemappingPicker/RemappingPicker.tsx
+++ b/frontend/src/metabase/metadata/pages/DataModel/components/FieldSection/BehaviorSection/RemappingPicker/RemappingPicker.tsx
@@ -11,6 +11,7 @@ import {
useUpdateFieldValuesMutation,
} from "metabase/api";
import { useMetadataToasts } from "metabase/metadata/hooks";
+import { trackMetadataChange } from "metabase/metadata/pages/DataModel/analytics";
import { getRawTableFieldId } from "metabase/metadata/utils/field";
import { PLUGIN_FEATURE_LEVEL_PERMISSIONS } from "metabase/plugins";
import { FieldDataSelector } from "metabase/query_builder/components/DataSelector";
@@ -129,6 +130,7 @@ export const RemappingPicker = ({
t`Failed to update display values of ${field.display_name}`,
);
} else {
+ trackMetadataChange("display_values");
sendSuccessToast(
t`Display values of ${field.display_name} updated`,
async () => {
diff --git a/frontend/src/metabase/metadata/pages/DataModel/components/FieldSection/DataSection/DataSection.tsx b/frontend/src/metabase/metadata/pages/DataModel/components/FieldSection/DataSection/DataSection.tsx
index 95c7895e52f..f14a588ef05 100644
--- a/frontend/src/metabase/metadata/pages/DataModel/components/FieldSection/DataSection/DataSection.tsx
+++ b/frontend/src/metabase/metadata/pages/DataModel/components/FieldSection/DataSection/DataSection.tsx
@@ -12,6 +12,7 @@ import {
import { Flex, Stack, Switch, rem } from "metabase/ui";
import type { Field } from "metabase-types/api";
+import { trackMetadataChange } from "../../../analytics";
import { TitledSection } from "../../TitledSection";
import S from "./DataSection.module.css";
@@ -87,6 +88,8 @@ const DataSectionBase = ({ field }: Props) => {
: t`Failed to update casting for ${field.display_name}`,
);
} else {
+ trackMetadataChange("type_casting");
+
sendSuccessToast(
field.coercion_strategy == null
? t`Casting enabled for ${field.display_name}`
diff --git a/frontend/src/metabase/metadata/pages/DataModel/components/FieldSection/FormattingSection.tsx b/frontend/src/metabase/metadata/pages/DataModel/components/FieldSection/FormattingSection.tsx
index 6c239f1682b..d2d23632c66 100644
--- a/frontend/src/metabase/metadata/pages/DataModel/components/FieldSection/FormattingSection.tsx
+++ b/frontend/src/metabase/metadata/pages/DataModel/components/FieldSection/FormattingSection.tsx
@@ -12,6 +12,7 @@ import type {
FieldFormattingSettings as FieldSettings,
} from "metabase-types/api";
+import { trackMetadataChange } from "../../analytics";
import { TitledSection } from "../TitledSection";
interface Props {
@@ -36,6 +37,8 @@ const FormattingSectionBase = ({ field }: Props) => {
if (error) {
sendErrorToast(t`Failed to update formatting of ${field.display_name}`);
} else {
+ trackMetadataChange("formatting");
+
sendSuccessToast(
t`Formatting of ${field.display_name} updated`,
async () => {
diff --git a/frontend/src/metabase/metadata/pages/DataModel/components/FieldSection/MetadataSection.tsx b/frontend/src/metabase/metadata/pages/DataModel/components/FieldSection/MetadataSection.tsx
index ca7a92c0154..cb3215d494f 100644
--- a/frontend/src/metabase/metadata/pages/DataModel/components/FieldSection/MetadataSection.tsx
+++ b/frontend/src/metabase/metadata/pages/DataModel/components/FieldSection/MetadataSection.tsx
@@ -11,6 +11,7 @@ import { getRawTableFieldId } from "metabase/metadata/utils/field";
import { PLUGIN_FEATURE_LEVEL_PERMISSIONS } from "metabase/plugins";
import type { DatabaseId, Field, Table } from "metabase-types/api";
+import { trackMetadataChange } from "../../analytics";
import { TitledSection } from "../TitledSection";
import { getSemanticTypeError } from "./utils";
@@ -46,6 +47,8 @@ const MetadataSectionBase = ({ databaseId, field, table }: Props) => {
t`Failed to update semantic type of ${field.display_name}`,
);
} else {
+ trackMetadataChange("semantic_type_change");
+
sendSuccessToast(
t`Semantic type of ${field.display_name} updated`,
async () => {
diff --git a/frontend/src/metabase/metadata/pages/DataModel/types.ts b/frontend/src/metabase/metadata/pages/DataModel/types.ts
index 2f0a5879b08..743e3314c03 100644
--- a/frontend/src/metabase/metadata/pages/DataModel/types.ts
+++ b/frontend/src/metabase/metadata/pages/DataModel/types.ts
@@ -27,3 +27,12 @@ export interface ColumnSizeConfig {
min: number;
max: number;
}
+
+export type MetadataEditAnalyticsDetail =
+ | "type_casting"
+ | "semantic_type_change"
+ | "visibility_change"
+ | "filtering_change"
+ | "display_values"
+ | "json_unfolding"
+ | "formatting";