-
Notifications
You must be signed in to change notification settings - Fork 11.7k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Chore: Add tracking for dashboard load (#70057)
* Chore: Add tracking for dashboard load * Address review comments
- Loading branch information
1 parent
43051d1
commit 3dfdd96
Showing
3 changed files
with
70 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
import { getDashboardModel } from 'test/helpers/getDashboardModel'; | ||
|
||
import * as runtime from '@grafana/runtime'; | ||
|
||
import { trackDashboardLoaded } from './tracking'; | ||
|
||
describe('trackDashboardLoaded', () => { | ||
it('should report dashboard_loaded interaction with correct parameters', () => { | ||
const dashboardJSON = { | ||
uid: 'dashboard-123', | ||
title: 'Test Dashboard', | ||
panels: [ | ||
{ id: 1, type: 'row', repeat: 'dc', gridPos: { x: 0, y: 0, h: 1, w: 24 } }, | ||
{ id: 2, repeat: 'app', repeatDirection: 'h', gridPos: { x: 0, y: 1, h: 2, w: 8 } }, | ||
], | ||
templating: { | ||
list: [ | ||
{ type: 'query', name: 'Query 1' }, | ||
{ type: 'interval', name: 'Interval 1' }, | ||
{ type: 'query', name: 'Query 2' }, | ||
], | ||
}, | ||
}; | ||
const model = getDashboardModel(dashboardJSON); | ||
const reportInteractionSpy = jest.spyOn(runtime, 'reportInteraction'); | ||
|
||
trackDashboardLoaded(model, 16); | ||
|
||
expect(reportInteractionSpy).toHaveBeenCalledWith('dashboards_init_dashboard_completed', { | ||
uid: 'dashboard-123', | ||
title: 'Test Dashboard', | ||
theme: 'dark', | ||
schemaVersion: model.schemaVersion, // This value is based on public/app/features/dashboard/state/DashboardMigrator.ts#L81 | ||
panels_count: 2, | ||
variable_type_query_count: 2, | ||
variable_type_interval_count: 1, | ||
version_before_migration: 16, | ||
}); | ||
}); | ||
}); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
import { reportInteraction } from '@grafana/runtime'; | ||
|
||
import { DashboardModel } from '../state'; | ||
|
||
export function trackDashboardLoaded(dashboard: DashboardModel, versionBeforeMigration?: number) { | ||
// Count the different types of variables | ||
const variables = dashboard.templating.list | ||
.map((v) => v.type) | ||
.reduce((r, k) => { | ||
r[variableName(k)] = 1 + r[variableName(k)] || 1; | ||
return r; | ||
}, {}); | ||
|
||
reportInteraction('dashboards_init_dashboard_completed', { | ||
uid: dashboard.uid, | ||
title: dashboard.title, | ||
theme: dashboard.style, | ||
schemaVersion: dashboard.schemaVersion, | ||
version_before_migration: versionBeforeMigration, | ||
panels_count: dashboard.panels.length, | ||
...variables, | ||
}); | ||
} | ||
|
||
const variableName = (type: string) => `variable_type_${type}_count`; |