ouyang/cherry-studio
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

feat: add sentry integration

Browse Source
This commit is contained in:
kangfenmao
2025-04-22 21:49:47 +08:00
parent 409e0096d8
commit 314be9b198
16 changed files with 1205 additions and 116 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/main/index.ts
+3
View File
@@ -5,6 +5,7 @@ import { app, ipcMain } from 'electron'
import installExtension, { REACT_DEVELOPER_TOOLS, REDUX_DEVTOOLS } from 'electron-devtools-installer'
import Logger from 'electron-log'
import { initSentry } from './integration/sentry'
import { registerIpc } from './ipc'
import { configManager } from './services/ConfigManager'
import mcpService from './services/MCPService'
@@ -110,3 +111,5 @@ if (!app.requestSingleInstanceLock()) {
// In this file you can include the rest of your app"s specific main process
// code. You can also put them in separate files and require them here.
}
initSentry()
src/main/integration/sentry/index.ts
+11
View File
@@ -0,0 +1,11 @@
import { configManager } from '@main/services/ConfigManager'
import * as Sentry from '@sentry/electron/main'
import { app } from 'electron'
export function initSentry() {
if (app.isPackaged && configManager.getEnableDataCollection()) {
Sentry.init({
dsn: 'https://194ceab3bd44e686bd3ebda9de3c20fd@o4509184559218688.ingest.us.sentry.io/4509184569442304'
})
}
}
src/main/ipc.ts
+4
View File
@@ -9,6 +9,7 @@ import { BrowserWindow, ipcMain, session, shell } from 'electron'
import log from 'electron-log'
import { titleBarOverlayDark, titleBarOverlayLight } from './config'
import { initSentry } from './integration/sentry'
import AppUpdater from './services/AppUpdater'
import BackupManager from './services/BackupManager'
import { configManager } from './services/ConfigManager'
@@ -341,4 +342,7 @@ export function registerIpc(mainWindow: BrowserWindow, app: Electron.App) {
ipcMain.handle(IpcChannel.SearchWindow_OpenUrl, async (_, uid: string, url: string) => {
return await searchService.openUrlInSearchWindow(uid, url)
})
// sentry
ipcMain.handle(IpcChannel.Sentry_Init, () => initSentry())
}
src/main/services/ConfigManager.ts
+10 -1
View File
@@ -15,7 +15,8 @@ enum ConfigKeys {
Shortcuts = 'shortcuts',
ClickTrayToShowQuickAssistant = 'clickTrayToShowQuickAssistant',
EnableQuickAssistant = 'enableQuickAssistant',
AutoUpdate = 'autoUpdate'
AutoUpdate = 'autoUpdate',
EnableDataCollection = 'enableDataCollection'
}
export class ConfigManager {
@@ -145,6 +146,14 @@ export class ConfigManager {
this.set(ConfigKeys.AutoUpdate, value)
}
getEnableDataCollection(): boolean {
return this.get<boolean>(ConfigKeys.EnableDataCollection, true)
}
setEnableDataCollection(value: boolean) {
this.set(ConfigKeys.EnableDataCollection, value)
}
set(key: string, value: unknown) {
this.store.set(key, value)
}
src/preload/index.d.ts
Vendored
+3
View File
@@ -33,6 +33,9 @@ declare global {
setAutoUpdate: (isActive: boolean) => void
reload: () => void
clearCache: () => Promise<{ success: boolean; error?: string }>
sentry: {
init: () => Promise<void>
}
system: {
getDeviceType: () => Promise<'mac' | 'windows' | 'linux'>
getHostname: () => Promise<string>
src/preload/index.ts
+3
View File
@@ -23,6 +23,9 @@ const api = {
setAutoUpdate: (isActive: boolean) => ipcRenderer.invoke(IpcChannel.App_SetAutoUpdate, isActive),
openWebsite: (url: string) => ipcRenderer.invoke(IpcChannel.Open_Website, url),
clearCache: () => ipcRenderer.invoke(IpcChannel.App_ClearCache),
sentry: {
init: () => ipcRenderer.invoke(IpcChannel.Sentry_Init)
},
system: {
getDeviceType: () => ipcRenderer.invoke(IpcChannel.System_GetDeviceType),
getHostname: () => ipcRenderer.invoke(IpcChannel.System_GetHostname)
src/renderer/src/App.tsx
+26 -29
View File
@@ -8,7 +8,6 @@ import { PersistGate } from 'redux-persist/integration/react'
import Sidebar from './components/app/Sidebar'
import TopViewContainer from './components/TopView'
import AntdProvider from './context/AntdProvider'
import PostHogProvider from './context/PostHogProvider'
import StyleSheetManager from './context/StyleSheetManager'
import { SyntaxHighlighterProvider } from './context/SyntaxHighlighterProvider'
import { ThemeProvider } from './context/ThemeProvider'
@@ -25,34 +24,32 @@ import TranslatePage from './pages/translate/TranslatePage'
function App(): React.ReactElement {
return (
<Provider store={store}>
<PostHogProvider>
<StyleSheetManager>
<ThemeProvider>
<AntdProvider>
<SyntaxHighlighterProvider>
<PersistGate loading={null} persistor={persistor}>
<TopViewContainer>
<HashRouter>
<NavigationHandler />
<Sidebar />
<Routes>
<Route path="/" element={<HomePage />} />
<Route path="/agents" element={<AgentsPage />} />
<Route path="/paintings" element={<PaintingsPage />} />
<Route path="/translate" element={<TranslatePage />} />
<Route path="/files" element={<FilesPage />} />
<Route path="/knowledge" element={<KnowledgePage />} />
<Route path="/apps" element={<AppsPage />} />
<Route path="/settings/*" element={<SettingsPage />} />
</Routes>
</HashRouter>
</TopViewContainer>
</PersistGate>
</SyntaxHighlighterProvider>
</AntdProvider>
</ThemeProvider>
</StyleSheetManager>
</PostHogProvider>
<StyleSheetManager>
<ThemeProvider>
<AntdProvider>
<SyntaxHighlighterProvider>
<PersistGate loading={null} persistor={persistor}>
<TopViewContainer>
<HashRouter>
<NavigationHandler />
<Sidebar />
<Routes>
<Route path="/" element={<HomePage />} />
<Route path="/agents" element={<AgentsPage />} />
<Route path="/paintings" element={<PaintingsPage />} />
<Route path="/translate" element={<TranslatePage />} />
<Route path="/files" element={<FilesPage />} />
<Route path="/knowledge" element={<KnowledgePage />} />
<Route path="/apps" element={<AppsPage />} />
<Route path="/settings/*" element={<SettingsPage />} />
</Routes>
</HashRouter>
</TopViewContainer>
</PersistGate>
</SyntaxHighlighterProvider>
</AntdProvider>
</ThemeProvider>
</StyleSheetManager>
</Provider>
)
}
src/renderer/src/context/PostHogProvider.tsx
-24
View File
@@ -1,24 +0,0 @@
import { useAppSelector } from '@renderer/store'
import { PostHogProvider as PostHogReactProvider } from 'posthog-js/react'
import { FC } from 'react'
const POSTHOG_OPTIONS = {
api_key: 'phc_G0omsYajA6A9BY5c0rnU04ZaZck25xpR0DqKhwfF39n',
api_host: 'https://us.i.posthog.com'
}
const PostHogProvider: FC<{ children: React.ReactNode }> = ({ children }) => {
const enableDataCollection = useAppSelector((state) => state.settings.enableDataCollection)
if (enableDataCollection) {
return (
<PostHogReactProvider apiKey={POSTHOG_OPTIONS.api_key} options={POSTHOG_OPTIONS}>
{children}
</PostHogReactProvider>
)
}
return children
}
export default PostHogProvider
src/renderer/src/hooks/useAppInit.ts
+6 -1
View File
@@ -3,6 +3,7 @@ import { isLocalAi } from '@renderer/config/env'
import { useTheme } from '@renderer/context/ThemeProvider'
import db from '@renderer/databases'
import i18n from '@renderer/i18n'
import { initSentry } from '@renderer/init'
import { useAppDispatch } from '@renderer/store'
import { setAvatar, setFilesPath, setResourcesPath, setUpdateState } from '@renderer/store/runtime'
import { delay, runAsyncFunction } from '@renderer/utils'
@@ -18,7 +19,7 @@ import useUpdateHandler from './useUpdateHandler'
export function useAppInit() {
const dispatch = useAppDispatch()
const { proxyUrl, language, windowStyle, autoCheckUpdate, proxyMode, customCss } = useSettings()
const { proxyUrl, language, windowStyle, autoCheckUpdate, proxyMode, customCss, enableDataCollection } = useSettings()
const { minappShow } = useRuntime()
const { setDefaultModel, setTopicNamingModel, setTranslateModel } = useDefaultModel()
const avatar = useLiveQuery(() => db.settings.get('image://avatar'))
@@ -103,4 +104,8 @@ export function useAppInit() {
document.head.appendChild(style)
}
}, [customCss])
useEffect(() => {
enableDataCollection && initSentry()
}, [enableDataCollection])
}
src/renderer/src/init.ts
+16
View File
@@ -1,4 +1,6 @@
import KeyvStorage from '@kangfenmao/keyv-storage'
import * as Sentry from '@sentry/electron/renderer'
import { init as reactInit } from '@sentry/react'
import { startAutoSync } from './services/BackupService'
import { startNutstoreAutoSync } from './services/NutstoreService'
@@ -29,6 +31,20 @@ function initAutoSync() {
}, 2000)
}
export async function initSentry() {
const appInfo = await window.api.getAppInfo()
if (appInfo.isPackaged) {
Sentry.init(
{
sendDefaultPii: true,
tracesSampleRate: 1.0,
integrations: [Sentry.browserTracingIntegration()]
},
reactInit as any
)
}
}
initSpinner()
initKeyv()
initAutoSync()
src/renderer/src/pages/settings/GeneralSettings.tsx
+7 -1
View File
@@ -185,7 +185,13 @@ const GeneralSettings: FC = () => {
<SettingDivider />
<SettingRow>
<SettingRowTitle>{t('settings.privacy.enable_privacy_mode')}</SettingRowTitle>
<Switch value={enableDataCollection} onChange={(v) => dispatch(setEnableDataCollection(v))} />
<Switch
value={enableDataCollection}
onChange={(v) => {
dispatch(setEnableDataCollection(v))
window.api.config.set('enableDataCollection', v)
}}
/>
</SettingRow>
</SettingGroup>
</SettingContainer>