Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add telemetry for vp #1340

Merged
merged 9 commits into from
Jul 20, 2022
Merged
Show file tree
Hide file tree
Changes from 8 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 10 additions & 3 deletions ui/lib/apps/SlowQuery/pages/Detail/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ import {
TreeDiagramView,
} from '@lib/components'
import { useVersionedLocalStorageState } from '@lib/utils/useVersionedLocalStorageState'
import { telemetry } from '@lib/apps/SlowQuery/utils/telemetry'

import DetailTabs from './DetailTabs'

Expand Down Expand Up @@ -69,7 +70,8 @@ function DetailPage() {
setDetailExpand((prev) => ({ ...prev, plan: !prev.plan }))

const [isVpVisible, setIsVpVisable] = useState(false)
const toggleVisualPlan = () => {
const toggleVisualPlan = (action: 'open' | 'close') => {
telemetry.toggleVisualPlanModal(action)
setIsVpVisable(!isVpVisible)
}

Expand Down Expand Up @@ -168,6 +170,9 @@ function DetailPage() {
? 'binary_plan'
: 'text_plan'
}
onTabClick={(key) =>
telemetry.clickPlanTabs(key, data.digest!)
}
>
{binaryPlan &&
!binaryPlan.main.discardedDueToTooLong && (
Expand All @@ -182,7 +187,7 @@ function DetailPage() {
centered
visible={isVpVisible}
width={window.innerWidth}
onCancel={toggleVisualPlan}
onCancel={() => toggleVisualPlan('close')}
footer={null}
destroyOnClose={true}
bodyStyle={{
Expand All @@ -203,7 +208,9 @@ function DetailPage() {
</Modal>
<Descriptions>
<Descriptions.Item span={2}>
<div onClick={toggleVisualPlan}>
<div
onClick={() => toggleVisualPlan('open')}
>
<TreeDiagramView
data={
binaryPlan.ctes
Expand Down
20 changes: 20 additions & 0 deletions ui/lib/apps/SlowQuery/utils/telemetry.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
// Copyright 2022 PingCAP, Inc. Licensed under Apache-2.0.
import { mixpanel } from '@lib/utils/telemetry'

export const telemetry = {
clickPlanTabs(tab: string, queryDigest: string) {
mixpanel.track('Slowquery: Plan Tab Clicked', { tab, queryDigest })
},
toggleVisualPlanModal(action: 'open' | 'close') {
mixpanel.track('Slowquery: Visual Plan Modal Toggled', { action })
},
toggleExpandBtnOnNode(nodeName: string) {
mixpanel.track('Slowquery: Node Button Toggled', { nodeName })
},
clickNode(nodeName: string) {
mixpanel.track('Slowquery: Node Clicked', { nodeName })
},
clickTabOnNodeDetail(tab: string) {
mixpanel.track('Slowquery: Detail Tab on Node Clicked', { tab })
},
}
11 changes: 8 additions & 3 deletions ui/lib/apps/Statement/pages/Detail/PlanDetail.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ import { useVersionedLocalStorageState } from '@lib/utils/useVersionedLocalStora
import type { IPageQuery } from '.'
import DetailTabs from './PlanDetailTabs'
import { useSchemaColumns } from '../../utils/useSchemaColumns'
import { telemetry } from '@lib/apps/Statement/utils/telemetry'

export interface IQuery extends IPageQuery {
plans: string[]
Expand Down Expand Up @@ -54,7 +55,8 @@ function PlanDetail({ query }: IPlanDetailProps) {
const binaryPlan = data?.binary_plan && JSON.parse(data.binary_plan)

const [isVpVisible, setIsVpVisable] = useState(false)
const toggleVisualPlan = () => {
const toggleVisualPlan = (action: 'open' | 'close') => {
telemetry.toggleVisualPlanModal(action)
setIsVpVisable(!isVpVisible)
}

Expand Down Expand Up @@ -177,6 +179,9 @@ function PlanDetail({ query }: IPlanDetailProps) {
? 'binary_plan'
: 'text_plan'
}
onTabClick={(key) =>
telemetry.clickPlanTabs(key, data.digest!)
}
>
{binaryPlan && !binaryPlan.main.discardedDueToTooLong && (
<Tabs.TabPane
Expand All @@ -188,7 +193,7 @@ function PlanDetail({ query }: IPlanDetailProps) {
centered
visible={isVpVisible}
width={window.innerWidth}
onCancel={toggleVisualPlan}
onCancel={() => toggleVisualPlan('close')}
footer={null}
destroyOnClose={true}
bodyStyle={{
Expand All @@ -207,7 +212,7 @@ function PlanDetail({ query }: IPlanDetailProps) {
</Modal>
<Descriptions>
<Descriptions.Item span={2}>
<div onClick={toggleVisualPlan}>
<div onClick={() => toggleVisualPlan('open')}>
<TreeDiagramView
data={
binaryPlan.ctes
Expand Down
20 changes: 20 additions & 0 deletions ui/lib/apps/Statement/utils/telemetry.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
// Copyright 2022 PingCAP, Inc. Licensed under Apache-2.0.
import { mixpanel } from '@lib/utils/telemetry'

export const telemetry = {
clickPlanTabs(tab: string, queryDigest: string) {
mixpanel.track('Statement: Plan Tab Clicked', { tab, queryDigest })
},
toggleVisualPlanModal(action: 'open' | 'close') {
mixpanel.track('Statement: Visual Plan Modal Toggled', { action })
},
toggleExpandBtnOnNode(nodeName: string) {
mixpanel.track('Statement: Node Button Toggled', { nodeName })
},
clickNode(nodeName: string) {
mixpanel.track('Statement: Node Clicked', { nodeName })
},
clickTabOnNodeDetail(tab: string) {
mixpanel.track('Statement: Detail Tab on Node Clicked', { tab })
},
}
3 changes: 3 additions & 0 deletions ui/lib/components/TreeDiagram/Node/DefaultNode.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ import {
ExclamationCircleFilled,
} from '@ant-design/icons'
import { toFixed } from '@baurine/grafana-value-formats'
import { telemetry } from '@lib/apps/Statement/utils/telemetry'

import styles from './DefaultNode.module.less'

Expand All @@ -32,10 +33,12 @@ export const DefaultNode = (nodeProps) => {
}

const handleExpandBtnToggleOnClick = (e, node) => {
telemetry.toggleExpandBtnOnNode(node.name)
onNodeExpandBtnToggle(node.__node_attrs.id)
}

const handleOnNodeDetailClick = (e, node) => {
telemetry.clickNode(node.name)
onNodeDetailClick(node)
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ import { InfoCircleTwoTone } from '@ant-design/icons'
import { addTranslations } from '@lib/utils/i18n'
import { useTranslation } from 'react-i18next'
import translations from '../translations'
import { telemetry } from '@lib/apps/Statement/utils/telemetry'

addTranslations(translations)

Expand All @@ -16,7 +17,12 @@ export const DefaultNodeDetail = (nodeDetailProps) => {
const { t } = useTranslation()

return (
<Tabs defaultActiveKey="1" type="card" size="middle">
<Tabs
defaultActiveKey="1"
type="card"
size="middle"
onTabClick={(key) => telemetry.clickTabOnNodeDetail(key)}
>
<Tabs.TabPane
tab={t(`binary_plan.tabs.general`)}
key="1"
Expand Down