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

event-tracking: Disable if not in production or user opted-out #1497

Merged
merged 1 commit into from
Dec 9, 2024
Merged

event-tracking: Disable if not in production or user opted-out #1497

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
15 changes: 15 additions & 0 deletions src/libs/external-telemetry/event-tracking.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@ import ky from 'ky'
import localforage from 'localforage'
import posthog from 'posthog-js'

const cockpitTelemetryEnabledKey = 'cockpit-enable-usage-statistics-telemetry'

type EventPayload = {
/**
* The name of the event
Expand All @@ -21,6 +23,7 @@ type EventPayload = {
*
*/
class EventTracker {
private static enableEventTracking = false
static postHogApiUrl = 'https://us.i.posthog.com'
static postHogApiKey = 'phc_SfqVeZcpYHmhUn9NRizThxFxiI9fKqvjRjmBDB8ToRs'
static posthog: ReturnType<typeof posthog.init> | undefined = undefined
Expand All @@ -30,6 +33,16 @@ class EventTracker {
* Initialize the event tracking system
*/
constructor() {
// Only track usage statistics if the user has not opted out and the app is not in development mode
const isRunningInProduction = import.meta.env.PROD
const userHasExternalTelemetryEnabled = window.localStorage.getItem(cockpitTelemetryEnabledKey) === 'true'
EventTracker.enableEventTracking = isRunningInProduction && userHasExternalTelemetryEnabled

if (!EventTracker.enableEventTracking) {
console.info('Event tracking is disabled. Not initializing event tracker.')
return
}

if (!EventTracker.posthog) {
EventTracker.posthog = posthog.init(EventTracker.postHogApiKey, {
api_host: EventTracker.postHogApiUrl,
Expand All @@ -56,6 +69,8 @@ class EventTracker {
* @param {Record<string, unknown>} eventProperties - The properties of the event
*/
async capture(eventName: string, eventProperties?: Record<string, unknown>): Promise<void> {
if (!EventTracker.enableEventTracking) return

const eventId = `${eventName}-${Date.now()}`
const eventPayload: EventPayload = {
eventName,
Expand Down
Loading