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.

Sign up for GitHub

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

[Lens] fix telemetry on save names #192367

Merged
merged 2 commits into from
Sep 10, 2024
Merged

[Lens] fix telemetry on save names #192367

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a88b424
[Lens] fix telemetry on save names
mbondyra Sep 9, 2024
41a2148
Update x-pack/plugins/lens/public/visualizations/xy/visualization.tsx
mbondyra Sep 9, 2024
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
4 changes: 2 additions & 2 deletions x-pack/plugins/lens/public/app_plugin/app.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ import {
} from '../data_views_service/service';
import { replaceIndexpattern } from '../state_management/lens_slice';
import { useApplicationUserMessages } from './get_application_user_messages';
import { trackUiCounterEvents } from '../lens_ui_telemetry';
import { trackSaveUiCounterEvents } from '../lens_ui_telemetry';

export type SaveProps = Omit<OnSaveProps, 'onTitleDuplicate' | 'newDescription'> & {
returnToOrigin: boolean;
Expand Down Expand Up @@ -325,7 +325,7 @@ export function App({
prevVisState
);
if (telemetryEvents && telemetryEvents.length) {
trackUiCounterEvents(telemetryEvents);
trackSaveUiCounterEvents(telemetryEvents);
}
return runSaveLensVisualization(
{
Expand Down
4 changes: 2 additions & 2 deletions x-pack/plugins/lens/public/app_plugin/shared/edit_on_the_fly/lens_configuration_flyout.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ import { FlyoutWrapper } from './flyout_wrapper';
import { getSuggestions, getGridAttrs, type ESQLDataGridAttrs } from './helpers';
import { SuggestionPanel } from '../../../editor_frame_service/editor_frame/suggestion_panel';
import { useApplicationUserMessages } from '../../get_application_user_messages';
import { trackUiCounterEvents } from '../../../lens_ui_telemetry';
import { trackSaveUiCounterEvents } from '../../../lens_ui_telemetry';
import { ESQLDataGridAccordion } from './esql_data_grid_accordion';

export function LensEditConfigurationFlyout({
Expand Down Expand Up @@ -288,7 +288,7 @@ export function LensEditConfigurationFlyout({
prevVisState
);
if (telemetryEvents && telemetryEvents.length) {
trackUiCounterEvents(telemetryEvents);
trackSaveUiCounterEvents(telemetryEvents);
}

onApplyCb?.(attrs as TypedLensByValueInput['attributes']);
Expand Down
72 changes: 36 additions & 36 deletions x-pack/plugins/lens/public/lens_ui_telemetry/color_telemetry_helpers.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,8 +112,8 @@ describe('color_telemetry_helpers', () => {
});
it('settings (default): unassigned terms loop, default palette returns correct events', () => {
expect(getColorMappingTelemetryEvents(DEFAULT_COLOR_MAPPING_CONFIG)).toEqual([
'lens_color_mapping_palette_eui_amsterdam_color_blind',
'lens_color_mapping_unassigned_terms_loop',
'color_mapping_palette_eui_amsterdam_color_blind',
'color_mapping_unassigned_terms_loop',
]);
});
it('gradient event when user changed colorMode to gradient', () => {
Expand All @@ -136,33 +136,33 @@ describe('color_telemetry_helpers', () => {
},
DEFAULT_COLOR_MAPPING_CONFIG
)
).toEqual(['lens_color_mapping_gradient']);
).toEqual(['color_mapping_gradient']);
});
it('settings: custom palette, unassigned terms from palette, 2 colors with 5 terms in total', () => {
expect(getColorMappingTelemetryEvents(MANUAL_COLOR_MAPPING_CONFIG)).toEqual([
'lens_color_mapping_palette_elastic_brand_2023',
'lens_color_mapping_unassigned_terms_palette',
'lens_color_mapping_colors_2_to_4',
'lens_color_mapping_custom_colors_2',
'lens_color_mapping_avg_count_terms_per_color_2_to_4',
'color_mapping_palette_elastic_brand_2023',
'color_mapping_unassigned_terms_palette',
'color_mapping_colors_2_to_4',
'color_mapping_custom_colors_2',
'color_mapping_avg_count_terms_per_color_2_to_4',
]);
expect(
getColorMappingTelemetryEvents(MANUAL_COLOR_MAPPING_CONFIG, DEFAULT_COLOR_MAPPING_CONFIG)
).toEqual([
'lens_color_mapping_palette_elastic_brand_2023',
'lens_color_mapping_unassigned_terms_palette',
'lens_color_mapping_colors_2_to_4',
'lens_color_mapping_custom_colors_2',
'lens_color_mapping_avg_count_terms_per_color_2_to_4',
'color_mapping_palette_elastic_brand_2023',
'color_mapping_unassigned_terms_palette',
'color_mapping_colors_2_to_4',
'color_mapping_custom_colors_2',
'color_mapping_avg_count_terms_per_color_2_to_4',
]);
});
it('color, custom color and count of terms changed (even if the same event would be returned)', () => {
const config = { ...MANUAL_COLOR_MAPPING_CONFIG };
config.assignments = config.assignments.slice(0, 3);
expect(getColorMappingTelemetryEvents(config, MANUAL_COLOR_MAPPING_CONFIG)).toEqual([
'lens_color_mapping_colors_2_to_4',
'lens_color_mapping_custom_colors_1',
'lens_color_mapping_avg_count_terms_per_color_2_to_4',
'color_mapping_colors_2_to_4',
'color_mapping_custom_colors_1',
'color_mapping_avg_count_terms_per_color_2_to_4',
]);
});

Expand All @@ -177,56 +177,56 @@ describe('color_telemetry_helpers', () => {

config.assignments = [exampleAssignment(4, 'custom')];
expect(getColorMappingTelemetryEvents(config, MANUAL_COLOR_MAPPING_CONFIG)).toEqual([
'lens_color_mapping_colors_up_to_2',
'lens_color_mapping_custom_colors_1',
'lens_color_mapping_avg_count_terms_per_color_2_to_4',
'color_mapping_colors_up_to_2',
'color_mapping_custom_colors_1',
'color_mapping_avg_count_terms_per_color_2_to_4',
]);
});
it('2 colors', () => {
const config = { ...MANUAL_COLOR_MAPPING_CONFIG };

config.assignments = [exampleAssignment(1), exampleAssignment(1)];
expect(getColorMappingTelemetryEvents(config, MANUAL_COLOR_MAPPING_CONFIG)).toEqual([
'lens_color_mapping_colors_2',
'lens_color_mapping_avg_count_terms_per_color_1',
'color_mapping_colors_2',
'color_mapping_avg_count_terms_per_color_1',
]);
});
it('3 colors, 10 terms per assignment', () => {
const config = { ...MANUAL_COLOR_MAPPING_CONFIG };

config.assignments = Array.from({ length: 3 }, () => exampleAssignment(10));
expect(getColorMappingTelemetryEvents(config, MANUAL_COLOR_MAPPING_CONFIG)).toEqual([
'lens_color_mapping_colors_2_to_4',
'lens_color_mapping_avg_count_terms_per_color_above_4',
'color_mapping_colors_2_to_4',
'color_mapping_avg_count_terms_per_color_above_4',
]);
});
it('7 colors, 2 terms per assignment, all custom', () => {
const config = { ...MANUAL_COLOR_MAPPING_CONFIG };

config.assignments = Array.from({ length: 7 }, () => exampleAssignment(2, 'custom'));
expect(getColorMappingTelemetryEvents(config, MANUAL_COLOR_MAPPING_CONFIG)).toEqual([
'lens_color_mapping_colors_4_to_8',
'lens_color_mapping_custom_colors_4_to_8',
'lens_color_mapping_avg_count_terms_per_color_2',
'color_mapping_colors_4_to_8',
'color_mapping_custom_colors_4_to_8',
'color_mapping_avg_count_terms_per_color_2',
]);
});
it('12 colors', () => {
const config = { ...MANUAL_COLOR_MAPPING_CONFIG };

config.assignments = Array.from({ length: 12 }, () => exampleAssignment(3, 'custom'));
expect(getColorMappingTelemetryEvents(config, MANUAL_COLOR_MAPPING_CONFIG)).toEqual([
'lens_color_mapping_colors_8_to_16',
'lens_color_mapping_custom_colors_8_to_16',
'lens_color_mapping_avg_count_terms_per_color_2_to_4',
'color_mapping_colors_8_to_16',
'color_mapping_custom_colors_8_to_16',
'color_mapping_avg_count_terms_per_color_2_to_4',
]);
});
it('27 colors', () => {
const config = { ...MANUAL_COLOR_MAPPING_CONFIG };
config.assignments = Array.from({ length: 27 }, () => exampleAssignment(3, 'custom'));
expect(getColorMappingTelemetryEvents(config, MANUAL_COLOR_MAPPING_CONFIG)).toEqual([
'lens_color_mapping_colors_above_16',
'lens_color_mapping_custom_colors_above_16',
'lens_color_mapping_avg_count_terms_per_color_2_to_4',
'color_mapping_colors_above_16',
'color_mapping_custom_colors_above_16',
'color_mapping_avg_count_terms_per_color_2_to_4',
]);
});
});
Expand All @@ -241,15 +241,15 @@ describe('color_telemetry_helpers', () => {
},
DEFAULT_COLOR_MAPPING_CONFIG
)
).toEqual(['lens_color_mapping_unassigned_terms_palette']);
).toEqual(['color_mapping_unassigned_terms_palette']);
});
it('unassigned terms changed from palette to loop', () => {
expect(
getColorMappingTelemetryEvents(DEFAULT_COLOR_MAPPING_CONFIG, {
...DEFAULT_COLOR_MAPPING_CONFIG,
specialAssignments: specialAssignmentsPalette,
})
).toEqual(['lens_color_mapping_unassigned_terms_loop']);
).toEqual(['color_mapping_unassigned_terms_loop']);
});
it('unassigned terms changed from loop to another custom color', () => {
expect(
Expand All @@ -260,7 +260,7 @@ describe('color_telemetry_helpers', () => {
},
DEFAULT_COLOR_MAPPING_CONFIG
)
).toEqual(['lens_color_mapping_unassigned_terms_custom']);
).toEqual(['color_mapping_unassigned_terms_custom']);
});
it('unassigned terms changed from custom color to another custom color', () => {
expect(
Expand All @@ -271,7 +271,7 @@ describe('color_telemetry_helpers', () => {
specialAssignments: specialAssignmentsCustom2,
}
)
).toEqual(['lens_color_mapping_unassigned_terms_custom']);
).toEqual(['color_mapping_unassigned_terms_custom']);
});
});
});
2 changes: 1 addition & 1 deletion x-pack/plugins/lens/public/lens_ui_telemetry/color_telemetry_helpers.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import { ColorMapping, NeutralPalette, DEFAULT_OTHER_ASSIGNMENT_INDEX } from '@k
import { isEqual } from 'lodash';
import { nonNullable } from '../utils';

const COLOR_MAPPING_PREFIX = 'lens_color_mapping_';
const COLOR_MAPPING_PREFIX = 'color_mapping_';

export const getColorMappingTelemetryEvents = (
colorMapping: ColorMapping.Config | undefined,
Expand Down
1 change: 1 addition & 0 deletions x-pack/plugins/lens/public/lens_ui_telemetry/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,6 @@ export {
setUsageCollectionStart,
getUsageCollectionStart,
trackUiCounterEvents,
trackSaveUiCounterEvents,
getExecutionContextEvents,
} from './track_counter_events';
15 changes: 13 additions & 2 deletions x-pack/plugins/lens/public/lens_ui_telemetry/track_counter_events.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,10 +27,21 @@ const extractContainerType = (context?: KibanaExecutionContext): string | undefi
}
};

const RENDER_EVENT_PREFIX = `render_lens_`;

const SAVE_EVENT_PREFIX = `save_lens_`;

/** @internal **/
export const trackUiCounterEvents = (
export const trackSaveUiCounterEvents = (
events: string | string[],
context?: KibanaExecutionContext
) => trackUiCounterEvents(events, context, SAVE_EVENT_PREFIX);

/** @internal **/
export const trackUiCounterEvents = (
events: string | string[],
context?: KibanaExecutionContext,
eventPrefix = RENDER_EVENT_PREFIX
) => {
const usageCollection = getUsageCollectionStart();
const containerType = extractContainerType(context) ?? 'application';
Expand All @@ -39,7 +50,7 @@ export const trackUiCounterEvents = (
usageCollection?.reportUiCounter(
containerType,
METRIC_TYPE.COUNT,
`render_lens_${key}`,
`${eventPrefix}${key}`,
counter.length
);
});
Expand Down
66 changes: 33 additions & 33 deletions x-pack/plugins/lens/public/visualizations/xy/legend_stats_telemetry_helpers.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,10 @@ describe('legend_stats_telemetry_helpers', () => {
expect(
getLegendStatsTelemetryEvents([LegendValue.CurrentAndLastValue, LegendValue.Average])
).toEqual([
'lens_legend_stats',
'lens_legend_stats_currentAndLastValue',
'lens_legend_stats_average',
'lens_legend_stats_amount_2',
'legend_stats',
'legend_stats_currentAndLastValue',
'legend_stats_average',
'legend_stats_amount_2',
]);
});

Expand All @@ -36,17 +36,17 @@ describe('legend_stats_telemetry_helpers', () => {
describe('calculates counter events properly', () => {
it('returns single count event', () => {
expect(getLegendStatsTelemetryEvents([LegendValue.Average])).toEqual([
'lens_legend_stats',
'lens_legend_stats_average',
'lens_legend_stats_amount_1',
'legend_stats',
'legend_stats_average',
'legend_stats_amount_1',
]);
});
it('returns 2 count event', () => {
expect(getLegendStatsTelemetryEvents([LegendValue.Average, LegendValue.Count])).toEqual([
'lens_legend_stats',
'lens_legend_stats_average',
'lens_legend_stats_count',
'lens_legend_stats_amount_2',
'legend_stats',
'legend_stats_average',
'legend_stats_count',
'legend_stats_amount_2',
]);
});
it('returns 3 count event', () => {
Expand All @@ -57,11 +57,11 @@ describe('legend_stats_telemetry_helpers', () => {
LegendValue.CurrentAndLastValue,
])
).toEqual([
'lens_legend_stats',
'lens_legend_stats_average',
'lens_legend_stats_count',
'lens_legend_stats_currentAndLastValue',
'lens_legend_stats_amount_3',
'legend_stats',
'legend_stats_average',
'legend_stats_count',
'legend_stats_currentAndLastValue',
'legend_stats_amount_3',
]);
});
it('returns 4 count event', () => {
Expand All @@ -73,12 +73,12 @@ describe('legend_stats_telemetry_helpers', () => {
LegendValue.Average,
])
).toEqual([
'lens_legend_stats',
'lens_legend_stats_currentAndLastValue',
'lens_legend_stats_max',
'lens_legend_stats_min',
'lens_legend_stats_average',
'lens_legend_stats_amount_4_to_7',
'legend_stats',
'legend_stats_currentAndLastValue',
'legend_stats_max',
'legend_stats_min',
'legend_stats_average',
'legend_stats_amount_4_to_7',
]);
});

Expand All @@ -96,17 +96,17 @@ describe('legend_stats_telemetry_helpers', () => {
LegendValue.Median,
])
).toEqual([
'lens_legend_stats',
'lens_legend_stats_currentAndLastValue',
'lens_legend_stats_max',
'lens_legend_stats_min',
'lens_legend_stats_average',
'lens_legend_stats_count',
'lens_legend_stats_total',
'lens_legend_stats_lastValue',
'lens_legend_stats_firstValue',
'lens_legend_stats_median',
'lens_legend_stats_amount_above_8',
'legend_stats',
'legend_stats_currentAndLastValue',
'legend_stats_max',
'legend_stats_min',
'legend_stats_average',
'legend_stats_count',
'legend_stats_total',
'legend_stats_lastValue',
'legend_stats_firstValue',
'legend_stats_median',
'legend_stats_amount_above_8',
]);
});
});
Expand Down
2 changes: 1 addition & 1 deletion x-pack/plugins/lens/public/visualizations/xy/legend_stats_telemetry_helpers.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import { XYLegendValue } from '@kbn/visualizations-plugin/common';
import { nonNullable } from '../../utils';
import { shouldDisplayTable } from '../../shared_components/legend/legend_settings_popover';

const LEGEND_STATS_PREFIX = 'lens_legend_stats';
const LEGEND_STATS_PREFIX = 'legend_stats';
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's great that you also found out about this one! Let's ping @teresaalvarezsoler and update the spreadsheet with both keys used. We should probably also mark in the spreadsheet the time when the new telemetry key was merged/released so we can use both or just one key depending on the queried time.
Or we can update the events directly in our telemetry by renaming the values

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @markov00 thanks. I edited the spreadsheet yesterday with the new and old names and a comment.

const constructName = (eventName: string) => `${LEGEND_STATS_PREFIX}${eventName}`;

export const getLegendStatsTelemetryEvents = (
Expand Down