@contrast/config 1.35.0 → 1.37.0

package/lib/config.js

@@ -60,7 +60,11 @@ module.exports = class Config {
       node: {},
     };
     this.application = {};
-    this.assess = {};
+    this.assess = {
+      probabilistic_sampling: {
+        route_monitor: {}
+      }
+    };
     this.inventory = {};
     this.protect = {
       rules: {},

package/lib/index.d.ts

@@ -241,6 +241,16 @@ export interface Config {
 
     /** Defualt: `false` */
     trust_custom_validators: boolean;
+
+    // effective based on local config and 'assess.sampling' TS DTM
+    probabilistic_sampling: {
+      /** Defualt: `false` */
+      enable: boolean,
+      route_monitor: {
+        /** Defualt: `3600000` */
+        ttl_ms: number,
+      }
+    }
   };
 
   protect: {
@@ -256,7 +266,7 @@ export interface Config {
       /**
        * List of rule ids to disable.
        * Default: `[]`
-      */
+       */
       disabled_rules: string[];
     } & Record<Omit<Rule, Rule.BOT_BLOCKER | Rule.IP_DENYLIST | Rule.VIRTUAL_PATCH>, { mode: ProtectRuleMode }>;
   };

package/lib/options.js

@@ -171,7 +171,7 @@ const options = [
           const existingSource = cfg.getEffectiveSource(canonicalName);
           if (existingSource !== DEFAULT_VALUE) {
             cfg._logs.push({
-              level: 'info',
+              level: 'warn',
               msg: 'Using configured value for `%s` (set by %s) instead of `api.token`.',
               args: [canonicalName, existingSource]
             });
@@ -541,6 +541,7 @@ Example - \`/opt/Contrast/contrast.log\` creates a log in the \`/opt/Contrast\`
     desc: 'Set to true to enable sampling of requests for dataflow and other Assess features',
   },
   {
+    // effective based on local config and 'assess.sampling' TeamServer DTM
     name: 'assess.probabilistic_sampling.base_probability',
     arg: '<probability>',
     fn: (val) => {
@@ -553,8 +554,22 @@ Example - \`/opt/Contrast/contrast.log\` creates a log in the \`/opt/Contrast\`
         });
       }
     },
-    default: 0.01,
-    desc: 'A value p within the interval [0, 1]. Each request will share same probability p of being sampled.',
+    default: 0.10,
+    desc: 'A value p within the range [0, 1]. Each request will share same probability p of being sampled.',
+  },
+  {
+    name: 'assess.probabilistic_sampling.route_monitor.enable',
+    arg: '[true]',
+    default: true,
+    fn: castBoolean,
+    desc: 'The agent will keep track of which routes have been analyzed and skip analysis if the route was recently sampled.',
+  },
+  {
+    name: 'assess.probabilistic_sampling.route_monitor.ttl_ms',
+    arg: '<number>',
+    default: 1_800_000,
+    fn: parseNum,
+    desc: 'Limits individual route analysis to once per this value. Defaults to 1_800_000ms (30 minutes).',
   },
   {
     name: 'assess.tags',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contrast/config",
-  "version": "1.35.0",
+  "version": "1.37.0",
   "description": "An API for discovering Contrast agent configuration data",
   "license": "SEE LICENSE IN LICENSE",
   "author": "Contrast Security <nodejs@contrastsecurity.com> (https://www.contrastsecurity.com)",
@@ -17,7 +17,7 @@
     "test": "../scripts/test.sh"
   },
   "dependencies": {
-    "@contrast/common": "1.26.0",
+    "@contrast/common": "1.27.0",
     "yaml": "^2.2.2"
   }
 }