telemetry: Allow user to opt out of sending usage statistics

bluerobotics · Jul 30, 2024 · e7b9f1a · e7b9f1a
1 parent 92571cd
commit e7b9f1a
Show file tree

Hide file tree

Showing 3 changed files with 29 additions and 10 deletions.
diff --git a/src/main.ts b/src/main.ts
@@ -22,15 +22,18 @@ loadFonts()
 
 const app = createApp(App)
 
-Sentry.init({
-  app,
-  dsn: 'https://5176a29493da4d31a6384c55d291cd3d@o4507692193415168.ingest.us.sentry.io/4507692196036608',
-  integrations: [Sentry.browserTracingIntegration(), Sentry.replayIntegration()],
-  tracesSampleRate: 1.0, //  Capture 100% of the transactions
-  tracePropagationTargets: [],
-  replaysSessionSampleRate: 0.1, // This sets the sample rate at 10%. You may want to change it to 100% while in development and then sample at a lower rate in production.
-  replaysOnErrorSampleRate: 1.0, // If you're not already sampling the entire session, change the sample rate to 100% when sampling sessions where errors occur.
-})
+// Only track usage statistics if the user has not opted out
+if (window.localStorage.getItem('cockpit-enable-usage-statistics-telemetry')) {
+  Sentry.init({
+    app,
+    dsn: 'https://5176a29493da4d31a6384c55d291cd3d@o4507692193415168.ingest.us.sentry.io/4507692196036608',
+    integrations: [Sentry.browserTracingIntegration(), Sentry.replayIntegration()],
+    tracesSampleRate: 1.0, //  Capture 100% of the transactions
+    tracePropagationTargets: [],
+    replaysSessionSampleRate: 0.1, // This sets the sample rate at 10%. You may want to change it to 100% while in development and then sample at a lower rate in production.
+    replaysOnErrorSampleRate: 1.0, // If you're not already sampling the entire session, change the sample rate to 100% when sampling sessions where errors occur.
+  })
+}
 
 app.component('FontAwesomeIcon', FontAwesomeIcon)
 app.use(router).use(vuetify).use(createPinia()).use(FloatingVue).use(VueVirtualScroller)

diff --git a/src/stores/development.ts b/src/stores/development.ts
@@ -6,12 +6,20 @@ import { useBlueOsStorage } from '@/composables/settingsSyncer'
 
 export const systemLoggingEnablingKey = 'cockpit-enable-system-logging'
 export const blueOsSettingsSyncEnablingKey = 'cockpit-enable-blueos-settings-sync'
+export const enableUsageStatisticsTelemetryKey = 'cockpit-enable-usage-statistics-telemetry'
 
 export const useDevelopmentStore = defineStore('development', () => {
   const developmentMode = ref(false)
   const widgetDevInfoBlurLevel = ref(3)
   const enableSystemLogging = useBlueOsStorage(systemLoggingEnablingKey, true)
   const enableBlueOsSettingsSync = useStorage(blueOsSettingsSyncEnablingKey, true)
+  const enableUsageStatisticsTelemetry = useStorage(enableUsageStatisticsTelemetryKey, true)
 
-  return { developmentMode, widgetDevInfoBlurLevel, enableSystemLogging, enableBlueOsSettingsSync }
+  return {
+    developmentMode,
+    widgetDevInfoBlurLevel,
+    enableSystemLogging,
+    enableBlueOsSettingsSync,
+    enableUsageStatisticsTelemetry,
+  }
 })
diff --git a/src/views/ConfigurationDevelopmentView.vue b/src/views/ConfigurationDevelopmentView.vue
@@ -26,6 +26,14 @@
               class="min-w-[155px]"
               @update:model-value="reloadCockpit"
             />
+            <v-switch
+              v-model="devStore.enableUsageStatisticsTelemetry"
+              label="Usage statistics telemetry"
+              color="white"
+              hide-details
+              class="min-w-[155px]"
+              @update:model-value="reloadCockpit"
+            />
             <v-switch
               v-model="devStore.enableSystemLogging"
               label="Enable system logging"