datadog-frontend-toolkit 1.0.52 → 1.0.53

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +34 -6
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -19,6 +19,7 @@ One `init()` call to auto-instrument **RUM**, **Logs**, **Error Tracking**, **Pe
19
19
  - **Resource provisioning CLI** — auto-creates Dashboards, Monitors, SLOs, and Burn Rate Alerts
20
20
  - **Environment-aware SLO targets** — 99.5% for production, 95% for non-production
21
21
  - **Google SRE burn rate alerts** — multi-window, multi-burn-rate alerting with auto-clamped thresholds
22
+ - **Traffic-aware thresholds** — `--load-size` calibrates monitor thresholds to your app's traffic volume
22
23
  - **Resource teardown** — `--remove` flag deletes all managed resources for a service/environment
23
24
  - **Plugin system** — extend with custom integrations
24
25
  - **Lifecycle hooks** — `beforeInit`, `afterInit`, `beforeLog`, `beforeError`
@@ -337,7 +338,8 @@ npx datadog-frontend-toolkit setup \
337
338
  --env production \
338
339
  --api-key $DD_API_KEY \
339
340
  --app-key $DD_APP_KEY \
340
- --team frontend
341
+ --team frontend \
342
+ --load-size medium
341
343
 
342
344
  # Using environment variables (prompted for the rest)
343
345
  export DD_API_KEY=your-api-key
@@ -352,6 +354,9 @@ npx datadog-frontend-toolkit setup -s my-app -e production --force
352
354
 
353
355
  # Skip specific resources
354
356
  npx datadog-frontend-toolkit setup -s my-app -e production --no-slos
357
+
358
+ # Specify traffic load (skips interactive prompt)
359
+ npx datadog-frontend-toolkit setup -s my-app -e production --load-size high -y
355
360
  ```
356
361
 
357
362
  ### Remove Resources
@@ -379,13 +384,36 @@ npx datadog-frontend-toolkit status -s my-app -e production
379
384
  **Dashboard (1):**
380
385
  - Frontend Observability overview with RUM metrics, Web Vitals, error tracking, API endpoint errors, and performance panels
381
386
 
382
- **Monitors (6):**
383
- - High Frontend Error Rate (>50 errors/5min)
387
+ **Monitors (6):** — thresholds adapt to your `--load-size` profile
388
+ - High Frontend Error Rate
384
389
  - Poor LCP Performance (avg LCP > 3s)
385
390
  - High CLS Score (avg CLS > 0.2)
386
- - JS Error Spike (>100 JS errors/5min)
387
- - Error Log Anomaly (>200 error logs/15min)
388
- - Poor INP Performance (avg INP > 400ms)
391
+ - JS Error Spike
392
+ - Error Log Anomaly
393
+ - Slow Page Load (avg loading time > 5s)
394
+
395
+ ### Traffic Load Profiles (`--load-size`)
396
+
397
+ Monitor thresholds and evaluation windows are automatically calibrated based on the selected traffic profile:
398
+
399
+ | Profile | Users/min | Error Rate | JS Spike | Log Anomaly | Web Vitals Window |
400
+ |---------|-----------|------------|----------|-------------|-------------------|
401
+ | `low` | 1–50 | >10 in 15m | >25 in 15m | >50 in 15m | 4h |
402
+ | `medium` | 50–500 | >50 in 10m | >100 in 10m | >200 in 15m | 1h |
403
+ | `high` | 500–5,000 | >200 in 5m | >500 in 5m | >500 in 10m | 30m |
404
+ | `very-high` | 5,000+ | >500 in 5m | >1,000 in 5m | >2,000 in 10m | 15m |
405
+
406
+ If `--load-size` is not provided via flag, the CLI prompts interactively:
407
+
408
+ ```
409
+ Expected traffic load for this service:
410
+ › 1) Low (1–50 users/min) — internal tools, admin panels, staging envs
411
+ 2) Medium (50–500 users/min) — B2B SaaS, department-level apps
412
+ 3) High (500–5,000 users/min) — company-wide apps, B2C products
413
+ 4) Very High (5,000+ users/min) — high-traffic consumer apps
414
+ ```
415
+
416
+ When using `-y` (skip prompts) without `--load-size`, defaults to `low`.
389
417
 
390
418
  **SLOs (2) — environment-aware targets:**
391
419
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "datadog-frontend-toolkit",
3
- "version": "1.0.52",
3
+ "version": "1.0.53",
4
4
  "description": "Enterprise-grade, framework-agnostic frontend observability toolkit for Datadog. Auto-instruments RUM, Logs, Error Tracking, Performance Monitoring, and provisions Dashboards, Monitors & SLOs.",
5
5
  "main": "dist/cjs/index.js",
6
6
  "module": "dist/esm/index.js",