improve logging consistency

This commit is contained in:
Elijah Duffy
2025-12-18 19:00:51 -08:00
parent f5ec7b3812
commit f2d389ee64
3 changed files with 22 additions and 20 deletions

View File

@@ -25,7 +25,9 @@
const consentGranted = $derived(trackingManager ? trackingManager.consent === true : true); const consentGranted = $derived(trackingManager ? trackingManager.consent === true : true);
// Development overrides to prevent dirty analytics // Development overrides to prevent dirty analytics
const devConsoleTag = $derived(`[dev][consent: ${consentGranted ? 'granted' : 'revoked'}]`); const devConsoleTag = $derived(
`[Umami] [dev][consent: ${consentGranted ? 'granted' : 'revoked'}]`
);
const devOverride = { const devOverride = {
track: (...args: unknown[]): Promise<string> | undefined => { track: (...args: unknown[]): Promise<string> | undefined => {
log.debug(`${devConsoleTag}: Track called with:`, ...args); log.debug(`${devConsoleTag}: Track called with:`, ...args);
@@ -62,7 +64,7 @@
} }
}); });
if (dev) log.debug('[dev]: Umami tracking disabled'); if (dev) log.info('[Umami] [dev]: tracking disabled');
onMount(() => { onMount(() => {
if (dev) { if (dev) {

View File

@@ -125,7 +125,7 @@ export class ConversionControl {
// If we're in dev mode and missing a test event code, log and exit // If we're in dev mode and missing a test event code, log and exit
if (dev && !this._testEventCode) { if (dev && !this._testEventCode) {
log.info( log.debug(
`[ConversionControl] ${eventName} event not sent - missing test event code in dev mode.` `[ConversionControl] ${eventName} event not sent - missing test event code in dev mode.`
); );
return Promise.resolve({ return Promise.resolve({

View File

@@ -104,7 +104,7 @@ export class PixelControl {
); );
} else if (options?.conversionHref) { } else if (options?.conversionHref) {
log.warn( log.warn(
`Conversion Client ${options.conversionHref} for Meta Pixel [${this._pixelID}] not initialized - TrackingManager is required for user consent.` `[PixelControl] Conversion Client ${options.conversionHref} for Meta Pixel [${this._pixelID}] not initialized, TrackingManager is required for user consent.`
); );
} }
} }
@@ -116,25 +116,25 @@ export class PixelControl {
try { try {
await loadMetaPixel(); // Load the Meta Pixel script await loadMetaPixel(); // Load the Meta Pixel script
} catch (e) { } catch (e) {
log.warn('Failed to load Meta Pixel script, all events will be queued.', e); log.warn('[PixelControl] Failed to load Meta Pixel script, all events will be queued.', e);
} }
} }
this._baseLoaded = true; this._baseLoaded = true;
log.debug('Meta Pixel base script loaded.'); log.debug('[PixelControl] Meta Pixel base script loaded.');
} }
/** Tells the Meta pixel that the user has given consent for tracking. */ /** Tells the Meta pixel that the user has given consent for tracking. */
static grantConsent() { static grantConsent() {
this.loadGuard(); this.loadGuard();
window.fbq?.('consent', 'grant'); window.fbq?.('consent', 'grant');
log.debug('Meta Pixel consent granted.'); log.debug('[PixelControl] Pixel consent granted.');
} }
/** Tells the Meta pixel that the user has revoked consent for tracking. */ /** Tells the Meta pixel that the user has revoked consent for tracking. */
static revokeConsent() { static revokeConsent() {
this.loadGuard(); this.loadGuard();
window.fbq?.('consent', 'revoke'); window.fbq?.('consent', 'revoke');
log.debug('Meta Pixel consent revoked.'); log.debug('[PixelControl] Pixel consent revoked.');
} }
/** /**
@@ -159,7 +159,7 @@ export class PixelControl {
// Check for existing PixelControl instance // Check for existing PixelControl instance
if (this._registeredPixels[pixelID]) { if (this._registeredPixels[pixelID]) {
log.warn( log.warn(
`PixelControl instance for Meta Pixel ID: ${pixelID} already exists. Returning existing instance.` `[PixelControl] Instance for Meta Pixel ID: ${pixelID} already exists. Returning existing instance.`
); );
return this._registeredPixels[pixelID]; return this._registeredPixels[pixelID];
} }
@@ -170,7 +170,7 @@ export class PixelControl {
// Fire initialization // Fire initialization
window.fbq('init', pixel._pixelID, options?.advancedMatching, options?.initOptions); window.fbq('init', pixel._pixelID, options?.advancedMatching, options?.initOptions);
log.debug(`Meta Pixel [${pixel._pixelID}] initialized.`); log.debug(`[PixelControl] [${pixel._pixelID}] initialized.`);
return pixel; return pixel;
} }
@@ -216,14 +216,14 @@ export class PixelControl {
.trackEvent('PageView', { eventID }) .trackEvent('PageView', { eventID })
.then((response) => { .then((response) => {
log.debug( log.debug(
`Meta Pixel [${this._pixelID}] PageView event sent to Conversion API with Event ID: ${eventID}, Response: ${JSON.stringify( `[PixelControl] [${this._pixelID}] PageView event sent to Conversion API with Event ID: ${eventID}, Response: ${JSON.stringify(
response response
)}` )}`
); );
}) })
.catch((error) => { .catch((error) => {
log.error( log.error(
`Meta Pixel [${this._pixelID}] Failed to send PageView event to Conversion API with Event ID: ${eventID}`, `[PixelControl] [${this._pixelID}] Failed to send PageView event to Conversion API with Event ID: ${eventID}`,
error error
); );
}); });
@@ -236,11 +236,11 @@ export class PixelControl {
eventID eventID
}); });
log.debug( log.debug(
`Meta Pixel [${this._pixelID}] PageView event sent${dev && ` (test code: ${this._testEventCode})`}.` `[PixelControl] [${this._pixelID}] PageView event sent${dev && ` (test code: ${this._testEventCode})`}.`
); );
} else { } else {
log.info( log.info(
`Meta Pixel [${this._pixelID}] PageView event not sent in development mode without a test event code.` `[PixelControl] [${this._pixelID}] PageView event not sent in development mode without a test event code.`
); );
} }
} }
@@ -259,14 +259,14 @@ export class PixelControl {
.trackEvent(event, { eventID: eventID, customData: pixelParamsToCustomData(params ?? {}) }) .trackEvent(event, { eventID: eventID, customData: pixelParamsToCustomData(params ?? {}) })
.then((response) => { .then((response) => {
log.debug( log.debug(
`Meta Pixel [${this._pixelID}] ${event} event sent to Conversion API with Event ID: ${eventID}, Response: ${JSON.stringify( `[PixelControl] [${this._pixelID}] ${event} event sent to Conversion API with Event ID: ${eventID}, Response: ${JSON.stringify(
response response
)}` )}`
); );
}) })
.catch((error) => { .catch((error) => {
log.error( log.error(
`Meta Pixel [${this._pixelID}] Failed to send ${event} event to Conversion API with Event ID: ${eventID}`, `[PixelControl] [${this._pixelID}] Failed to send ${event} event to Conversion API with Event ID: ${eventID}`,
error error
); );
}); });
@@ -279,11 +279,11 @@ export class PixelControl {
test_event_code: this._testEventCode test_event_code: this._testEventCode
}); });
log.debug( log.debug(
`Meta Pixel [${this._pixelID}] ${event} event sent${dev && ` (test code: ${this._testEventCode})`}.` `[PixelControl] [${this._pixelID}] ${event} event sent${dev && ` (test code: ${this._testEventCode})`}.`
); );
} else { } else {
log.info( log.info(
`Meta Pixel [${this._pixelID}] ${event} event not sent in development mode without a test event code.` `[PixelControl] [${this._pixelID}] ${event} event not sent in development mode without a test event code.`
); );
} }
} }
@@ -300,11 +300,11 @@ export class PixelControl {
test_event_code: this._testEventCode test_event_code: this._testEventCode
}); });
log.debug( log.debug(
`Meta Pixel [${this._pixelID}] ${event} custom event sent (test code: ${this._testEventCode}).` `[PixelControl] [${this._pixelID}] ${event} custom event sent (test code: ${this._testEventCode}).`
); );
} else { } else {
log.info( log.info(
`Meta Pixel [${this._pixelID}] ${event} custom event not sent in development mode without a test event code.` `[PixelControl] [${this._pixelID}] ${event} custom event not sent in development mode without a test event code.`
); );
} }
} }