feat: datadog rum 적용 (#54)

* datadog rum 적용 * 버전도 함께 보내도록 추가
Nexters · Sep 12, 2024 · 2494035 · 2494035
1 parent 61d32c1
commit 2494035
Show file tree

Hide file tree

Showing 8 changed files with 71 additions and 0 deletions.
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -26,6 +26,9 @@ jobs:
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           VITE_API_SERVER_URL: ${{ secrets.VITE_API_SERVER_URL }}
+          VITE_DATADOG_APPLICATION_ID: ${{ secrets.VITE_DATADOG_APPLICATION_ID }}
+          VITE_DATADOG_CLIENT_TOKEN: ${{ secrets.VITE_DATADOG_CLIENT_TOKEN }}
+          VITE_DATADOG_ENV: ${{ secrets.VITE_DATADOG_ENV }}
         run: yarn run publish
 
   publish_on_mac:
@@ -52,6 +55,9 @@ jobs:
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           VITE_API_SERVER_URL: ${{ secrets.VITE_API_SERVER_URL }}
+          VITE_DATADOG_APPLICATION_ID: ${{ secrets.VITE_DATADOG_APPLICATION_ID }}
+          VITE_DATADOG_CLIENT_TOKEN: ${{ secrets.VITE_DATADOG_CLIENT_TOKEN }}
+          VITE_DATADOG_ENV: ${{ secrets.VITE_DATADOG_ENV }}
           APPLE_API_KEY: ${{ env.APPLE_API_KEY }}
           APPLE_API_KEY_ID: ${{ secrets.APPLE_API_KEY_ID }}
           APPLE_API_ISSUER: ${{ secrets.APPLE_API_ISSUER }}
@@ -70,4 +76,7 @@ jobs:
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           VITE_API_SERVER_URL: ${{ secrets.VITE_API_SERVER_URL }}
+          VITE_DATADOG_APPLICATION_ID: ${{ secrets.VITE_DATADOG_APPLICATION_ID }}
+          VITE_DATADOG_CLIENT_TOKEN: ${{ secrets.VITE_DATADOG_CLIENT_TOKEN }}
+          VITE_DATADOG_ENV: ${{ secrets.VITE_DATADOG_ENV }}
         run: yarn run publish
diff --git a/package.json b/package.json
@@ -60,6 +60,7 @@
   ],
   "license": "MIT",
   "dependencies": {
+    "@datadog/browser-rum": "^5.26.0",
     "@lottiefiles/dotlottie-react": "^0.8.8",
     "@radix-ui/react-dialog": "^1.1.1",
     "@radix-ui/react-slot": "^1.1.0",

diff --git a/src/renderer/app/index.tsx b/src/renderer/app/index.tsx
@@ -4,6 +4,10 @@ import './index.css';
 import { Provider } from './provider';
 import { Router } from './router';
 
+import { initDatadogRum } from '@/shared/utils';
+
+initDatadogRum();
+
 const root = createRoot(document.querySelector('#app')!);
 root.render(
   <Provider>

diff --git a/src/renderer/shared/utils/datadog.ts b/src/renderer/shared/utils/datadog.ts
@@ -0,0 +1,26 @@
+import { datadogRum } from '@datadog/browser-rum';
+
+const datadogApplicationId = import.meta.env.VITE_DATADOG_APPLICATION_ID;
+const datadogClientToken = import.meta.env.VITE_DATADOG_CLIENT_TOKEN;
+const datadogEnv = import.meta.env.VITE_DATADOG_ENV;
+
+export const initDatadogRum = () => {
+  datadogRum.init({
+    applicationId: datadogApplicationId,
+    clientToken: datadogClientToken,
+    // `site` refers to the Datadog site parameter of your organization
+    // see https://docs.datadoghq.com/getting_started/site/
+    site: 'us5.datadoghq.com',
+    service: 'mohanyang-desktop',
+    env: datadogEnv,
+    // Specify a version number to identify the deployed version of your application in Datadog
+    version: __APP_VERSION__,
+    sessionSampleRate: 100,
+    sessionReplaySampleRate: 20,
+    allowFallbackToLocalStorage: true,
+    trackUserInteractions: true,
+    trackResources: true,
+    trackLongTasks: true,
+    defaultPrivacyLevel: 'mask-user-input',
+  });
+};
diff --git a/src/renderer/shared/utils/index.ts b/src/renderer/shared/utils/index.ts
@@ -5,3 +5,4 @@ export * from './icon';
 export * from './string';
 export * from './time';
 export * from './iso-duration';
+export * from './datadog';
diff --git a/src/renderer/vite-env.d.ts b/src/renderer/vite-env.d.ts
@@ -4,11 +4,18 @@
 // modules
 declare module '*.riv';
 
+// set app version
+// https://stackoverflow.com/questions/67194082/how-can-i-display-the-current-app-version-from-package-json-to-the-user-using-vi
+declare const __APP_VERSION__: string;
+
 // vite env
 // @see: https://electron-vite.org/guide/env-and-mode
 interface ImportMetaEnv {
   readonly VITE_SAMPLE: string;
   readonly VITE_API_SERVER_URL: string;
+  readonly VITE_DATADOG_APPLICATION_ID: string;
+  readonly VITE_DATADOG_CLIENT_TOKEN: string;
+  readonly VITE_DATADOG_ENV: string;
 }
 
 interface ImportMeta {

diff --git a/vite.renderer.config.ts b/vite.renderer.config.ts
@@ -20,6 +20,9 @@ export default defineConfig((env) => {
       outDir: `.vite/renderer/${name}`,
     },
     plugins: [pluginExposeRenderer(name), svgr()],
+    define: {
+      __APP_VERSION__: JSON.stringify(process.env.npm_package_version),
+    },
     resolve: {
       preserveSymlinks: true,
       alias: {

diff --git a/yarn.lock b/yarn.lock
@@ -174,6 +174,26 @@
   dependencies:
     "@jridgewell/trace-mapping" "0.3.9"
 
+"@datadog/[email protected]":
+  version "5.26.0"
+  resolved "https://registry.yarnpkg.com/@datadog/browser-core/-/browser-core-5.26.0.tgz#5ff355b2eacef7ea3d81ad325ca11266cb603dbb"
+  integrity sha512-/UAS6q7xkc9bsjn5ziPC6PDs3B0Fyd+4PM/hxmXIvOxMFkJa1KmgWcqlkxq3i7TW/i2k2tOgtgTFUtjp4SyEmg==
+
+"@datadog/[email protected]":
+  version "5.26.0"
+  resolved "https://registry.yarnpkg.com/@datadog/browser-rum-core/-/browser-rum-core-5.26.0.tgz#d9615f455d75a16e74884b160d7f3387e78cf791"
+  integrity sha512-DpWUAwsIbFXQ4nkQSYmshV8Kwc/dYy6YKD30XfwPINV7hhpcCStk09I77v1CFNahPEStiHHpguGj1pEa9fzjtw==
+  dependencies:
+    "@datadog/browser-core" "5.26.0"
+
+"@datadog/browser-rum@^5.26.0":
+  version "5.26.0"
+  resolved "https://registry.yarnpkg.com/@datadog/browser-rum/-/browser-rum-5.26.0.tgz#234a6909bd85adc448dc4f538c9f2f9c379b91b5"
+  integrity sha512-Anleo9e0BgPKZ2Ur1vSuWFsDFPb9FOFLJGnDscvSMo+GrcHPVp21ZnmryDsgonI4Ouqj+bbKStksl8ozfVVGow==
+  dependencies:
+    "@datadog/browser-core" "5.26.0"
+    "@datadog/browser-rum-core" "5.26.0"
+
 "@electron-forge/cli@^7.4.0":
   version "7.4.0"
   resolved "https://registry.yarnpkg.com/@electron-forge/cli/-/cli-7.4.0.tgz#db16f4bc678d1f6cec8890cdf86041e9c8336350"