@keyframerdev/vitals 0.1.4 → 0.1.6

package/README.md

@@ -53,13 +53,14 @@ Before your store release, declare it in the stores' privacy forms (App Store: D
 | `appVersion` | required | The version people see (`2.4.1`) |
 | `build` | none | The build number (`812`) |
 | `environment` | `'development'` when `__DEV__`, else `'production'` | Development reports are kept only when the project accepts development builds |
-| `sampleRate` | `0.1` | The share of sessions that report, until the project's settings say otherwise |
+| `sampleRate` | `0.1` | The share of sessions that report. Release builds use it until the project's settings arrive, then the project's rate. Development builds always use it, and report every session when you leave it out (no daily cap either: someone is testing) |
 | `navigationRef` | none | Screens are named from its routes |
 | `screenName` | the route's name | `(route) => string`, to name routes yourself (still masked) |
 | `storage` | none | Anything with `getItem`, `setItem` and `removeItem` (AsyncStorage, an MMKV wrapper) |
 | `device` | none | `{ model, memoryBytes, memoryGb, tier, displayHz }`, read by the app (for example from `expo-device`) |
 | `appId` | none | The bundle id or package name |
 | `endpoint` | `https://vitals.keyframer.dev` | The ingest server |
+| `debug` | `false` | Logs what the SDK decides, measures and sends: the session and its sampling, frames a second per thread, each report against the server's limits. Lines are tagged `[Keyframer.dev]` and go through `console.debug`, so Metro shows them as `DEBUG` (a note for you, such as development builds being off, is `INFO`; a refused report is `WARN`). For development builds |
 
 ## Call sites with file and line
 

package/dist/index.js

@@ -624,7 +624,7 @@ var MAX_FRAME_MS = 10 * 60 * 1000;
 
 // src/version.ts
 var SDK_NAME = "@keyframerdev/vitals";
-var SDK_VERSION = "0.1.4";
+var SDK_VERSION = "0.1.6";
 
 // src/controller.ts
 var STORAGE_KEYS = {
@@ -684,6 +684,7 @@ async function write(storage, key, value) {
       await storage.setItem(key, JSON.stringify(value));
   } catch {}
 }
+var TAG = "[Keyframer.dev]";
 
 class VitalsController {
   env;
@@ -793,9 +794,12 @@ class VitalsController {
     this.seq = 0;
     this.sampleRate = this.rate();
     const env = this.opts.environment ?? "production";
-    const devOk = env === "production" || !this.config || this.config.collect.development;
-    let sampled = devOk && this.sampleRate > 0 && this.env.random() < this.sampleRate;
-    if (sampled) {
+    const dev = env === "development";
+    const devOk = !dev || !this.config || this.config.collect.development;
+    const draw = this.env.random();
+    let sampled = devOk && this.sampleRate > 0 && draw < this.sampleRate;
+    let capped = false;
+    if (sampled && !dev) {
       const day = (this.env.day ?? localDay)(this.env.wall());
       if (!this.dayCount || this.dayCount.day !== day) {
         const saved = await read(this.opts.storage, STORAGE_KEYS.day);
@@ -803,9 +807,10 @@ class VitalsController {
           return;
         this.dayCount = saved && saved.day === day ? saved : { day, n: 0 };
       }
-      if (this.dayCount.n >= VITALS_MAX_SESSIONS_PER_DAY)
+      if (this.dayCount.n >= VITALS_MAX_SESSIONS_PER_DAY) {
         sampled = false;
-      else {
+        capped = true;
+      } else {
         this.dayCount.n++;
         await write(this.opts.storage, STORAGE_KEYS.day, this.dayCount);
         if (run !== this.run)
@@ -813,7 +818,8 @@ class VitalsController {
       }
     }
     this.sampled = sampled;
-    this.debug(`session ${this.nonce.slice(0, 6)}: ${sampled ? "sampled" : "not sampled"} (rate ${this.sampleRate}, environment ${env}` + `${devOk ? "" : ", the project does not collect development builds"})`);
+    const why = sampled ? "" : !devOk ? ": the project does not keep development builds" : capped ? `: ${VITALS_MAX_SESSIONS_PER_DAY} sessions already reported today on this device (the daily cap)` : `: drew ${draw.toFixed(2)} against the rate`;
+    this.debug(`Motion Vitals ${SDK_VERSION}, session ${this.nonce.slice(0, 6)}: ${sampled ? "sampled" : "not sampled"} (rate ${this.sampleRate}, environment ${env})${why}`);
     if (!sampled)
       return;
     this.collector.clear();
@@ -1258,7 +1264,7 @@ class VitalsController {
       if (kept)
         this.debug("this project keeps development builds: this build's reports show in the dashboard's Development view");
       else
-        this.env.log?.("[keyframer vitals] This project does not keep reports from development builds, so this build sends nothing. " + `To test here, turn on "Development builds" in the project's setup on keyframer.dev, then reload. Release builds are not affected.`, "info");
+        this.env.log?.(`${TAG} This project does not keep reports from development builds, so this build sends nothing. ` + `To test here, turn on "Development builds" in the project's setup on keyframer.dev, then reload. Release builds are not affected.`, "info");
     }
     if (!kept && this.sampled)
       this.endSampling();
@@ -1283,7 +1289,7 @@ class VitalsController {
     return true;
   }
   rate() {
-    const r = this.config ? this.config.sampleRate : this.opts?.sampleRate ?? VITALS_DEFAULT_SAMPLE_RATE;
+    const r = this.opts?.environment === "development" ? this.opts.sampleRate ?? 1 : this.config ? this.config.sampleRate : this.opts?.sampleRate ?? VITALS_DEFAULT_SAMPLE_RATE;
     return Number.isFinite(r) ? Math.max(0, Math.min(1, r)) : VITALS_DEFAULT_SAMPLE_RATE;
   }
   clearTimers() {
@@ -1295,11 +1301,11 @@ class VitalsController {
     }
   }
   log(message) {
-    this.env.log?.(`[keyframer vitals] ${message}`);
+    this.env.log?.(`${TAG} ${message}`, "warn");
   }
   debug(message) {
     if (this.opts?.debug)
-      this.env.log?.(`[keyframer vitals] ${message}`, "debug");
+      this.env.log?.(`${TAG} ${message}`, "debug");
   }
 }
 
@@ -1450,7 +1456,7 @@ var env = {
   setTimeout: (fn, ms) => setTimeout(fn, ms),
   clearTimeout: (h) => clearTimeout(h),
   platform: { os: Platform.OS === "ios" ? "ios" : "android", osMajor: osMajor() },
-  log: (m, level) => level === "debug" || level === "info" ? console.log(m) : console.warn(m)
+  log: (m, level) => level === "debug" ? console.debug(m) : level === "info" ? console.info(m) : console.warn(m)
 };
 var controller = new VitalsController(env);
 var jsHook = createJsHook(controller, () => checkScreen());

package/dist/types/controller.d.ts

@@ -236,6 +236,11 @@ export declare class VitalsController {
     private developmentConfig;
     private killSwitch;
     private allowed;
+    /**
+     * Release builds: the project's rate once its config is known, the app's until then. Development builds:
+     * the app's own rate, else every session. Someone is testing, and the project's 10% left nine runs in
+     * ten silent after the first session.
+     */
     private rate;
     private clearTimers;
     private log;

package/dist/types/version.d.ts

@@ -1,3 +1,3 @@
 /** This package's version: sent in every report's `sdk`, and compared with the config's `minSdk`. Keep it in step with package.json. */
 export declare const SDK_NAME = "@keyframerdev/vitals";
-export declare const SDK_VERSION = "0.1.4";
+export declare const SDK_VERSION = "0.1.6";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@keyframerdev/vitals",
-  "version": "0.1.4",
+  "version": "0.1.6",
   "description": "Motion Vitals for React Native: slow frames and janky animations from production, by screen and call site",
   "keywords": [
     "react-native",