Doc: minimum sample-interval relation to runtime

Fixes #36
con · Jun 3, 2024 · b98d6b0 · b98d6b0
1 parent 2edd56e
commit b98d6b0
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -34,7 +34,9 @@ options:
                         .duct/logs/{datetime_filesafe}-{pid}_)
   --sample-interval SAMPLE_INTERVAL, --s-i SAMPLE_INTERVAL
                         Interval in seconds between status checks of the
-                        running process. (default: 1.0)
+                        running process. Sample interval should be larger than
+                        the runtime of the process or `duct` may underreport
+                        the number of processes started. (default: 1.0)
   --report-interval REPORT_INTERVAL, --r-i REPORT_INTERVAL
                         Interval in seconds at which to report aggregated
                         data. (default: 60.0)

diff --git a/src/duct.py b/src/duct.py
@@ -217,7 +217,9 @@ def create_and_parse_args():
         "--s-i",
         type=float,
         default=float(os.getenv("DUCT_SAMPLE_INTERVAL", "1.0")),
-        help="Interval in seconds between status checks of the running process.",
+        help="Interval in seconds between status checks of the running process. "
+        "Sample interval should be larger than the runtime of the process or `duct` may "
+        "underreport the number of processes started.",
     )
     parser.add_argument(
         "--report-interval",