Merge pull request #24564 from secustor/feat/expose-dd-rum-session-sampling

feat: expose DD RUM sessionSampleRate and sessionReplaySampleRate

app-config.yaml

@@ -9,6 +9,9 @@ app:
   #  applicationId: qwerty
   #   site: # datadoghq.eu default = datadoghq.com
   #   env: # optional
+  #   sessionSampleRate: 100
+  #   sessionReplaySampleRate: 0
+
   support:
     url: https://github.com/backstage/backstage/issues # Used by common ErrorPage
     items: # Used by common SupportButton component

docs/integrations/datadog-rum/installation.md

@@ -22,6 +22,8 @@ app:
     applicationId: qwerty
   #   site: datadoghq.eu
   #   env: 'staging'
+  #   sessionSampleRate: 100
+  #   sessionReplaySampleRate: 0
 ```
 
 If your [`app-config.yaml`](https://github.com/backstage/backstage/blob/e0506af8fc54074a160fb91c83d6cae8172d3bb3/app-config.yaml#L5) file does not have this configuration, you may have to adjust your [`packages/app/public/index.html`](https://github.com/backstage/backstage/blob/e0506af8fc54074a160fb91c83d6cae8172d3bb3/packages/app/public/index.html#L69) to include the Datadog RUM `init()` section manually.

packages/app-next/public/index.html

@@ -72,7 +72,10 @@
           site: '<%= config.getOptionalString("app.datadogRum.site") || "datadoghq.com" %>',
           service: 'backstage',
           env: '<%= config.getString("app.datadogRum.env") %>',
-          sampleRate: 100,
+          sampleRate:
+            '<%= config.getOptionalNumber("app.datadogRum.sessionSampleRate") || 100 %>',
+          sessionReplaySampleRate:
+            '<%= config.getOptionalNumber("app.datadogRum.sessionReplaySampleRate") || 0 %>',
           trackInteractions: true,
         });
       });

packages/app/public/index.html

@@ -72,7 +72,10 @@
           site: '<%= config.getOptionalString("app.datadogRum.site") || "datadoghq.com" %>',
           service: 'backstage',
           env: '<%= config.getString("app.datadogRum.env") %>',
-          sampleRate: 100,
+          sampleRate:
+            '<%= config.getOptionalNumber("app.datadogRum.sessionSampleRate") || 100 %>',
+          sessionReplaySampleRate:
+            '<%= config.getOptionalNumber("app.datadogRum.sessionReplaySampleRate") || 0 %>',
           trackInteractions: true,
         });
       });

packages/cli/package.json

@@ -1,34 +1,46 @@
 {
   "name": "@backstage/cli",
-  "description": "CLI for developing Backstage plugins and apps",
   "version": "0.26.5-next.0",
-  "publishConfig": {
-    "access": "public"
-  },
+  "description": "CLI for developing Backstage plugins and apps",
   "backstage": {
     "role": "cli"
   },
+  "publishConfig": {
+    "access": "public"
+  },
+  "keywords": [
+    "backstage"
+  ],
   "homepage": "https://backstage.io",
   "repository": {
     "type": "git",
     "url": "https://github.com/backstage/backstage",
     "directory": "packages/cli"
   },
-  "keywords": [
-    "backstage"
-  ],
   "license": "Apache-2.0",
   "main": "dist/index.cjs.js",
-  "scripts": {
-    "build": "backstage-cli package build",
-    "lint": "backstage-cli package lint",
-    "test": "backstage-cli package test",
-    "clean": "backstage-cli package clean",
-    "start": "nodemon --"
-  },
   "bin": {
     "backstage-cli": "bin/backstage-cli"
   },
+  "files": [
+    "asset-types",
+    "templates",
+    "config",
+    "bin",
+    "dist/**/*.js"
+  ],
+  "scripts": {
+    "build": "backstage-cli package build",
+    "clean": "backstage-cli package clean",
+    "lint": "backstage-cli package lint",
+    "start": "nodemon --",
+    "test": "backstage-cli package test"
+  },
+  "nodemonConfig": {
+    "exec": "bin/backstage-cli",
+    "ext": "ts",
+    "watch": "./src"
+  },
   "dependencies": {
     "@backstage/catalog-model": "workspace:^",
     "@backstage/cli-common": "workspace:^",
@@ -197,18 +209,6 @@
       "optional": true
     }
   },
-  "files": [
-    "asset-types",
-    "templates",
-    "config",
-    "bin",
-    "dist/**/*.js"
-  ],
-  "nodemonConfig": {
-    "watch": "./src",
-    "exec": "bin/backstage-cli",
-    "ext": "ts"
-  },
   "configSchema": {
     "$schema": "https://backstage.io/schema/config-v1",
     "title": "@backstage/cli",
@@ -248,6 +248,16 @@
                 "type": "string",
                 "visibility": "frontend",
                 "description": "site for Datadog RUM events"
+              },
+              "sessionSampleRate": {
+                "type": "number",
+                "visibility": "frontend",
+                "description": "sample rate of Datadog RUM events"
+              },
+              "sessionReplaySampleRate": {
+                "type": "number",
+                "visibility": "frontend",
+                "description": "sample rate of session replays based upon already sampled Datadog RUM events"
               }
             },
             "required": [