File Content: Analytics.ts import { dateTime } from '@grafana/data'; import { createMonitoringLogger, getBackendSrv } from '@grafana/runtime'; import { config, reportInteraction } from '@grafana/runtime/src'; import { contextSrv } from 'app/core/core'; import { RuleNamespace } from '../../../types/unified-alerting'; import { RulerRulesConfigDTO } from '../../../types/unified-alerting-dto'; export const USER_CREATION_MIN_DAYS = 7; export const LogMessages = { filterByLabel: 'filtering alert instances by label', loadedList: 'loaded Alert Rules list', leavingRuleGroupEdit: 'leaving rule group edit without saving', alertRuleFromPanel: 'creating alert rule from panel', alertRuleFromScratch: 'creating alert rule from scratch', recordingRuleFromScratch: 'creating recording rule from scratch', clickingAlertStateFilters: 'clicking alert state filters', cancelSavingAlertRule: 'user canceled alert rule creation', successSavingAlertRule: 'alert rule saved successfully', unknownMessageFromError: 'unknown messageFromError', }; const alertingLogger = createMonitoringLogger('features.alerting', { module: 'Alerting' }); export function logInfo(message: string, context?: Record<string, string>) { alertingLogger.logInfo(message, context); } export function logError(error: Error, context?: Record<string, string>) { alertingLogger.logError(error, context); } export function logWarning(message: string, context?: Record<string, string>) { alertingLogger.logWarning(message, context); } // eslint-disable-next-line @typescript-eslint/no-explicit-any export function withPerformanceLogging<TFunc extends (...args: any[]) => Promise<any>>( func: TFunc, message: string, context: Record<string, string> ): (...args: Parameters<TFunc>) => Promise<Awaited<ReturnType<TFunc>>> { return async function (...args) { const startLoadingTs = performance.now(); const response = await func(...args); logInfo(message, { loadTimeMs: (performance.now() - startLoadingTs).toFixed(0), ...context, }); return response; }; } // eslint-disable-next-line @typescript-eslint/no-explicit-any export function withPromRulesMetadataLogging<TFunc extends (...args: any[]) => Promise<RuleNamespace[]>>( func: TFunc, message: string, context: Record<string, string> ) { return async (...args: Parameters<TFunc>) => { const startLoadingTs = performance.now(); const response = await func(...args); const { namespacesCount, groupsCount, rulesCount } = getPromRulesMetadata(response); logInfo(message, { loadTimeMs: (performance.now() - startLoadingTs).toFixed(0), namespacesCount, groupsCount, rulesCount, ...context, }); return response; }; } function getPromRulesMetadata(promRules: RuleNamespace[]) { const namespacesCount = promRules.length; const groupsCount = promRules.flatMap((ns) => ns.groups).length; const rulesCount = promRules.flatMap((ns) => ns.groups).flatMap((g) => g.rules).length; const metadata = { namespacesCount: namespacesCount.toFixed(0), groupsCount: groupsCount.toFixed(0), rulesCount: rulesCount.toFixed(0), }; return metadata; } // eslint-disable-next-line @typescript-eslint/no-explicit-any export function withRulerRulesMetadataLogging<TFunc extends (...args: any[]) => Promise<RulerRulesConfigDTO>>( func: TFunc, message: string, context: Record<string, string> ) { return async (...args: Parameters<TFunc>) => { const startLoadingTs = performance.now(); const response = await func(...args); const { namespacesCount, groupsCount, rulesCount } = getRulerRulesMetadata(response); logInfo(message, { loadTimeMs: (performance.now() - startLoadingTs).toFixed(0), namespacesCount, groupsCount, rulesCount, ...context, }); return response; }; } function getRulerRulesMetadata(rulerRules: RulerRulesConfigDTO) { const namespacesCount = Object.keys(rulerRules).length; const groups = Object.values(rulerRules).flatMap((groups) => groups); const rules = groups.flatMap((group) => group.rules); return { namespacesCount: namespacesCount.toFixed(0), groupsCount: groups.length.toFixed(0), rulesCount: rules.length.toFixed(0), }; } export async function isNewUser() { try { const { createdAt } = await getBackendSrv().get(`/api/user`); const limitDateForNewUser = dateTime().subtract(USER_CREATION_MIN_DAYS, 'days'); const userCreationDate = dateTime(createdAt); const isNew = limitDateForNewUser.isBefore(userCreationDate); return isNew; } catch { return true; //if no date is returned, we assume the user is new to prevent tracking actions } } export const trackRuleListNavigation = async ( props: AlertRuleTrackingProps = { grafana_version: config.buildInfo.version, org_id: contextSrv.user.orgId, user_id: contextSrv.user.id, } ) => { const isNew = await isNewUser(); if (isNew) { return; } reportInteraction('grafana_alerting_navigation', props); }; export const trackNewAlerRuleFormSaved = async (props: AlertRuleTrackingProps) => { const isNew = await isNewUser(); if (isNew) { return; } reportInteraction('grafana_alerting_rule_creation', props); }; export const trackNewAlerRuleFormCancelled = async (props: AlertRuleTrackingProps) => { const isNew = await isNewUser(); if (isNew) { return; } reportInteraction('grafana_alerting_rule_aborted', props); }; export const trackNewAlerRuleFormError = async (props: AlertRuleTrackingProps & { error: string }) => { const isNew = await isNewUser(); if (isNew) { return; } reportInteraction('grafana_alerting_rule_form_error', props); }; export const trackInsightsFeedback = async (props: { useful: boolean; panel: string }) => { const defaults = { grafana_version: config.buildInfo.version, org_id: contextSrv.user.orgId, user_id: contextSrv.user.id, }; reportInteraction('grafana_alerting_insights', { ...defaults, ...props }); }; export type AlertRuleTrackingProps = { user_id: number; grafana_version?: string; org_id?: number; }; Submit