datadog-frontend-toolkit 1.0.33 → 1.0.35

package/dist/resources/templates/slos.js

@@ -1,11 +1,45 @@
 "use strict";
 /**
  * SLO templates for Datadog API provisioning.
- * Uses metric-based SLOs with RUM queries (monitor-based SLOs do NOT
- * support RUM alert or log alert monitors).
+ * Uses metric-based SLOs with custom RUM-generated metrics.
+ *
+ * Required generated metrics (created automatically by the toolkit):
+ * - rum.frontend_toolkit.api_total   — count of XHR/fetch resources
+ * - rum.frontend_toolkit.api_errors  — count of XHR/fetch resources with status >= 400
+ * - rum.frontend_toolkit.good_lcp    — count of views with LCP < 2.5 s
  */
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.RUM_METRIC_DEFINITIONS = void 0;
 exports.buildSloTemplates = buildSloTemplates;
+exports.RUM_METRIC_DEFINITIONS = [
+    {
+        id: 'rum.frontend_toolkit.api_total',
+        event_type: 'resource',
+        filter: '@resource.type:(xhr OR fetch)',
+        group_by: [
+            { path: 'service', tag_name: 'service' },
+            { path: 'env', tag_name: 'env' },
+        ],
+    },
+    {
+        id: 'rum.frontend_toolkit.api_errors',
+        event_type: 'resource',
+        filter: '@resource.type:(xhr OR fetch) @resource.status_code:>=400',
+        group_by: [
+            { path: 'service', tag_name: 'service' },
+            { path: 'env', tag_name: 'env' },
+        ],
+    },
+    {
+        id: 'rum.frontend_toolkit.good_lcp',
+        event_type: 'view',
+        filter: '@view.largest_contentful_paint:<2500000000',
+        group_by: [
+            { path: 'service', tag_name: 'service' },
+            { path: 'env', tag_name: 'env' },
+        ],
+    },
+];
 function buildSloTemplates(service, env, _monitorIds, team) {
     const tags = [
         `service:${service}`,
@@ -15,12 +49,12 @@ function buildSloTemplates(service, env, _monitorIds, team) {
     ];
     return [
         {
-            name: `${service} (${env}) - Frontend Availability`,
-            description: 'Measures frontend availability based on RUM error rate. Managed by datadog-frontend-toolkit.',
+            name: `${service} (${env}) - API Availability`,
+            description: 'Measures API request availability as the ratio of successful API calls (XHR/fetch with status < 400) to total API calls. Pattern: good = total − errors. Managed by datadog-frontend-toolkit.',
             type: 'metric',
             query: {
-                numerator: `sum:rum.measure.view.error_free{service:${service},env:${env}}.as_count()`,
-                denominator: `sum:rum.measure.view{service:${service},env:${env}}.as_count()`,
+                numerator: `sum:rum.frontend_toolkit.api_total{service:${service},env:${env}}.as_count() - sum:rum.frontend_toolkit.api_errors{service:${service},env:${env}}.as_count()`,
+                denominator: `sum:rum.frontend_toolkit.api_total{service:${service},env:${env}}.as_count()`,
             },
             thresholds: [
                 { timeframe: '7d', target: 99.5, warning: 99.9 },
@@ -28,6 +62,20 @@ function buildSloTemplates(service, env, _monitorIds, team) {
             ],
             tags,
         },
+        {
+            name: `${service} (${env}) - Core Web Vitals (LCP)`,
+            description: 'Measures the percentage of page views with good Largest Contentful Paint (< 2.5 s). Target aligned with Google Core Web Vitals "good" threshold (75 %). Managed by datadog-frontend-toolkit.',
+            type: 'metric',
+            query: {
+                numerator: `sum:rum.frontend_toolkit.good_lcp{service:${service},env:${env}}.as_count()`,
+                denominator: `sum:rum.measure.view{service:${service},env:${env}}.as_count()`,
+            },
+            thresholds: [
+                { timeframe: '7d', target: 75, warning: 90 },
+                { timeframe: '30d', target: 75, warning: 90 },
+            ],
+            tags,
+        },
     ];
 }
 //# sourceMappingURL=slos.js.map

package/dist/resources/templates/slos.js.map

@@ -1 +1 @@
-{"version":3,"file":"slos.js","sourceRoot":"","sources":["../../../src/resources/templates/slos.ts"],"names":[],"mappings":";AAAA;;;;GAIG;;AAcH,8CA6BC;AA7BD,SAAgB,iBAAiB,CAC/B,OAAe,EACf,GAAW,EACX,WAA2C,EAC3C,IAAa;IAEb,MAAM,IAAI,GAAG;QACX,WAAW,OAAO,EAAE;QACpB,OAAO,GAAG,EAAE;QACZ,kCAAkC;QAClC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,QAAQ,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;KAClC,CAAC;IAEF,OAAO;QACL;YACE,IAAI,EAAE,GAAG,OAAO,KAAK,GAAG,2BAA2B;YACnD,WAAW,EAAE,8FAA8F;YAC3G,IAAI,EAAE,QAAQ;YACd,KAAK,EAAE;gBACL,SAAS,EAAE,2CAA2C,OAAO,QAAQ,GAAG,cAAc;gBACtF,WAAW,EAAE,gCAAgC,OAAO,QAAQ,GAAG,cAAc;aAC9E;YACD,UAAU,EAAE;gBACV,EAAE,SAAS,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE;gBAChD,EAAE,SAAS,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE;aAClD;YACD,IAAI;SACL;KACF,CAAC;AACJ,CAAC"}
+{"version":3,"file":"slos.js","sourceRoot":"","sources":["../../../src/resources/templates/slos.ts"],"names":[],"mappings":";AAAA;;;;;;;;GAQG;;;AAuDH,8CA6CC;AA3EY,QAAA,sBAAsB,GAA0B;IAC3D;QACE,EAAE,EAAE,gCAAgC;QACpC,UAAU,EAAE,UAAU;QACtB,MAAM,EAAE,+BAA+B;QACvC,QAAQ,EAAE;YACR,EAAE,IAAI,EAAE,SAAS,EAAE,QAAQ,EAAE,SAAS,EAAE;YACxC,EAAE,IAAI,EAAE,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE;SACjC;KACF;IACD;QACE,EAAE,EAAE,iCAAiC;QACrC,UAAU,EAAE,UAAU;QACtB,MAAM,EAAE,2DAA2D;QACnE,QAAQ,EAAE;YACR,EAAE,IAAI,EAAE,SAAS,EAAE,QAAQ,EAAE,SAAS,EAAE;YACxC,EAAE,IAAI,EAAE,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE;SACjC;KACF;IACD;QACE,EAAE,EAAE,+BAA+B;QACnC,UAAU,EAAE,MAAM;QAClB,MAAM,EAAE,4CAA4C;QACpD,QAAQ,EAAE;YACR,EAAE,IAAI,EAAE,SAAS,EAAE,QAAQ,EAAE,SAAS,EAAE;YACxC,EAAE,IAAI,EAAE,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE;SACjC;KACF;CACF,CAAC;AAEF,SAAgB,iBAAiB,CAC/B,OAAe,EACf,GAAW,EACX,WAA2C,EAC3C,IAAa;IAEb,MAAM,IAAI,GAAG;QACX,WAAW,OAAO,EAAE;QACpB,OAAO,GAAG,EAAE;QACZ,kCAAkC;QAClC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,QAAQ,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;KAClC,CAAC;IAEF,OAAO;QACL;YACE,IAAI,EAAE,GAAG,OAAO,KAAK,GAAG,sBAAsB;YAC9C,WAAW,EACT,+LAA+L;YACjM,IAAI,EAAE,QAAQ;YACd,KAAK,EAAE;gBACL,SAAS,EAAE,8CAA8C,OAAO,QAAQ,GAAG,8DAA8D,OAAO,QAAQ,GAAG,cAAc;gBACzK,WAAW,EAAE,8CAA8C,OAAO,QAAQ,GAAG,cAAc;aAC5F;YACD,UAAU,EAAE;gBACV,EAAE,SAAS,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE;gBAChD,EAAE,SAAS,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE;aAClD;YACD,IAAI;SACL;QACD;YACE,IAAI,EAAE,GAAG,OAAO,KAAK,GAAG,2BAA2B;YACnD,WAAW,EACT,8LAA8L;YAChM,IAAI,EAAE,QAAQ;YACd,KAAK,EAAE;gBACL,SAAS,EAAE,6CAA6C,OAAO,QAAQ,GAAG,cAAc;gBACxF,WAAW,EAAE,gCAAgC,OAAO,QAAQ,GAAG,cAAc;aAC9E;YACD,UAAU,EAAE;gBACV,EAAE,SAAS,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,OAAO,EAAE,EAAE,EAAE;gBAC5C,EAAE,SAAS,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,EAAE,OAAO,EAAE,EAAE,EAAE;aAC9C;YACD,IAAI;SACL;KACF,CAAC;AACJ,CAAC"}

package/dist/types/resources/ResourceProvisioner.d.ts

@@ -40,6 +40,11 @@ export declare class ResourceProvisioner {
     private findExistingDashboard;
     private findExistingMonitor;
     private findExistingSlo;
+    /**
+     * Ensures the RUM-generated metrics required by the SLOs exist.
+     * Creates them via POST /api/v2/rum/config/metrics; silently ignores 409 (already exists).
+     */
+    private ensureRumMetrics;
     private apiRequest;
 }
 export {};

package/dist/types/resources/ResourceProvisioner.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ResourceProvisioner.d.ts","sourceRoot":"","sources":["../../../src/resources/ResourceProvisioner.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAC;AAM1D,UAAU,kBAAkB;IAC1B,UAAU,EAAE;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAC;QAAC,GAAG,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;IACzD,QAAQ,EAAE;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;IACzC,IAAI,EAAE;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;IACrC,MAAM,EAAE,MAAM,EAAE,CAAC;CAClB;AAID;;;;;;;;GAQG;AACH,qBAAa,mBAAmB;IAC9B,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAS;IAChC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAS;IAChC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAS;gBAErB,MAAM,EAAE,kBAAkB;IAMtC;;;OAGG;IACG,SAAS,CACb,OAAO,EAAE,MAAM,EACf,GAAG,EAAE,MAAM,EACX,MAAM,EAAE,kBAAkB,GACzB,OAAO,CAAC,kBAAkB,CAAC;YAqChB,kBAAkB;YA8BlB,iBAAiB;YAkDjB,aAAa;YAwDb,qBAAqB;YA2BrB,mBAAmB;YAqCnB,eAAe;YAkCf,UAAU;CAwCzB"}
+{"version":3,"file":"ResourceProvisioner.d.ts","sourceRoot":"","sources":["../../../src/resources/ResourceProvisioner.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAC;AAM1D,UAAU,kBAAkB;IAC1B,UAAU,EAAE;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAC;QAAC,GAAG,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;IACzD,QAAQ,EAAE;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;IACzC,IAAI,EAAE;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;IACrC,MAAM,EAAE,MAAM,EAAE,CAAC;CAClB;AAID;;;;;;;;GAQG;AACH,qBAAa,mBAAmB;IAC9B,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAS;IAChC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAS;IAChC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAS;gBAErB,MAAM,EAAE,kBAAkB;IAMtC;;;OAGG;IACG,SAAS,CACb,OAAO,EAAE,MAAM,EACf,GAAG,EAAE,MAAM,EACX,MAAM,EAAE,kBAAkB,GACzB,OAAO,CAAC,kBAAkB,CAAC;YAsChB,kBAAkB;YA8BlB,iBAAiB;YAkDjB,aAAa;YAqDb,qBAAqB;YA6BrB,mBAAmB;YAqCnB,eAAe;IAkC7B;;;OAGG;YACW,gBAAgB;YAyBhB,UAAU;CAwCzB"}

package/dist/types/resources/templates/dashboard.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"dashboard.d.ts","sourceRoot":"","sources":["../../../../src/resources/templates/dashboard.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,wBAAgB,qBAAqB,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAyvB1G"}
+{"version":3,"file":"dashboard.d.ts","sourceRoot":"","sources":["../../../../src/resources/templates/dashboard.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,wBAAgB,qBAAqB,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAgwB1G"}

package/dist/types/resources/templates/slos.d.ts

@@ -1,7 +1,11 @@
 /**
  * SLO templates for Datadog API provisioning.
- * Uses metric-based SLOs with RUM queries (monitor-based SLOs do NOT
- * support RUM alert or log alert monitors).
+ * Uses metric-based SLOs with custom RUM-generated metrics.
+ *
+ * Required generated metrics (created automatically by the toolkit):
+ * - rum.frontend_toolkit.api_total   — count of XHR/fetch resources
+ * - rum.frontend_toolkit.api_errors  — count of XHR/fetch resources with status >= 400
+ * - rum.frontend_toolkit.good_lcp    — count of views with LCP < 2.5 s
  */
 export interface SloTemplate {
     name: string;
@@ -18,6 +22,20 @@ export interface SloTemplate {
     }>;
     tags: string[];
 }
+/**
+ * Definitions for the RUM-generated metrics the SLOs depend on.
+ * Each entry maps to a POST /api/v2/rum/config/metrics call.
+ */
+export interface RumMetricDefinition {
+    id: string;
+    event_type: string;
+    filter: string;
+    group_by: Array<{
+        path: string;
+        tag_name: string;
+    }>;
+}
+export declare const RUM_METRIC_DEFINITIONS: RumMetricDefinition[];
 export declare function buildSloTemplates(service: string, env: string, _monitorIds: {
     id: number;
     name: string;

package/dist/types/resources/templates/slos.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"slos.d.ts","sourceRoot":"","sources":["../../../../src/resources/templates/slos.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE;QACN,SAAS,EAAE,MAAM,CAAC;QAClB,WAAW,EAAE,MAAM,CAAC;KACrB,CAAC;IACF,UAAU,EAAE,KAAK,CAAC;QAAE,SAAS,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IAC3E,IAAI,EAAE,MAAM,EAAE,CAAC;CAChB;AAED,wBAAgB,iBAAiB,CAC/B,OAAO,EAAE,MAAM,EACf,GAAG,EAAE,MAAM,EACX,WAAW,EAAE;IAAE,EAAE,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,EAAE,EAC3C,IAAI,CAAC,EAAE,MAAM,GACZ,WAAW,EAAE,CAwBf"}
+{"version":3,"file":"slos.d.ts","sourceRoot":"","sources":["../../../../src/resources/templates/slos.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE;QACN,SAAS,EAAE,MAAM,CAAC;QAClB,WAAW,EAAE,MAAM,CAAC;KACrB,CAAC;IACF,UAAU,EAAE,KAAK,CAAC;QAAE,SAAS,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IAC3E,IAAI,EAAE,MAAM,EAAE,CAAC;CAChB;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC,EAAE,EAAE,MAAM,CAAC;IACX,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,KAAK,CAAC;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;CACrD;AAED,eAAO,MAAM,sBAAsB,EAAE,mBAAmB,EA4BvD,CAAC;AAEF,wBAAgB,iBAAiB,CAC/B,OAAO,EAAE,MAAM,EACf,GAAG,EAAE,MAAM,EACX,WAAW,EAAE;IAAE,EAAE,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,EAAE,EAC3C,IAAI,CAAC,EAAE,MAAM,GACZ,WAAW,EAAE,CAwCf"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "datadog-frontend-toolkit",
-  "version": "1.0.33",
+  "version": "1.0.35",
   "description": "Enterprise-grade, framework-agnostic frontend observability toolkit for Datadog. Auto-instruments RUM, Logs, Error Tracking, Performance Monitoring, and provisions Dashboards, Monitors & SLOs.",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",