Skip to content

Commit a114f36

Browse files
committed
docs: keep the compile timings table to keys users read
1 parent fff4e12 commit a114f36

2 files changed

Lines changed: 6 additions & 8 deletions

File tree

  • src/sqlbuild/.agents/skills/sqlbuild/references/docs/cli
  • website/src/content/docs/docs/cli

‎src/sqlbuild/.agents/skills/sqlbuild/references/docs/cli/compile.md‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -191,18 +191,17 @@ where a slow compile spends its time:
191191
| `built_in_rules_ms` | Wall time of the built-in Rules |
192192
| `custom_rules_ms`, `custom_rules_cpu_ms` | Wall and CPU time of the custom Rules, including their host processes |
193193
| `custom_rules_invocations` | Custom Rule invocations, one per Rule and subject |
194-
| `custom_rules_monitor_cpu_ms` | Host CPU spent checking Rule modules for state one subject could leave for another |
195-
| `custom_rules_guard_cpu_ms` | Host CPU spent deciding whether an audited operation, such as opening a file, came from Rule code |
196194
| `custom_rules.<code>.invocations` | Invocations of one custom Rule |
197-
| `custom_rules.<code>.cpu_ms` | Host CPU of those invocations, without the guard's checks |
195+
| `custom_rules.<code>.cpu_ms` | CPU time of those invocations |
198196
| `custom_rules.<code>.cache_hits` | Subjects whose stored result was reused |
199197
| `custom_rules.<code>.cache_misses` | Subjects evaluated again; every subject when the Rules cache is off |
200198
| `rule_cache_hits`, `rule_cache_misses` | Rule results reused or evaluated again |
201199
| `project_reuse_hits`, `project_reuse_misses`, `project_reuse_bypasses` | Whether the compile [reused an unchanged compile](#reusing-an-unchanged-compile), compiled because something changed, or was not eligible |
202200
| `project_reuse_check_ms` | Time spent checking whether the previous compile can be reused |
203201
| `total_ms` | Wall time of the whole compile |
204202

205-
Other keys are finer-grained phase timings and cache counters. Each selected custom Rule has all
203+
Other keys are finer-grained phase timings, cache counters and the custom Rules host's own
204+
overhead (`custom_rules_monitor_cpu_ms`, `custom_rules_guard_cpu_ms`). Each selected custom Rule has all
206205
four `custom_rules.<code>.*` keys; read one with
207206
`jq '.compile_timings["custom_rules.XORDERS001.cpu_ms"]'`. A Rule answered fully from the cache
208207
reports `0` invocations. Invocations and CPU can exceed a Rule's subject count, because a Rule

‎website/src/content/docs/docs/cli/compile.mdx‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -175,18 +175,17 @@ where a slow compile spends its time:
175175
| `built_in_rules_ms` | Wall time of the built-in Rules |
176176
| `custom_rules_ms`, `custom_rules_cpu_ms` | Wall and CPU time of the custom Rules, including their host processes |
177177
| `custom_rules_invocations` | Custom Rule invocations, one per Rule and subject |
178-
| `custom_rules_monitor_cpu_ms` | Host CPU spent checking Rule modules for state one subject could leave for another |
179-
| `custom_rules_guard_cpu_ms` | Host CPU spent deciding whether an audited operation, such as opening a file, came from Rule code |
180178
| `custom_rules.<code>.invocations` | Invocations of one custom Rule |
181-
| `custom_rules.<code>.cpu_ms` | Host CPU of those invocations, without the guard's checks |
179+
| `custom_rules.<code>.cpu_ms` | CPU time of those invocations |
182180
| `custom_rules.<code>.cache_hits` | Subjects whose stored result was reused |
183181
| `custom_rules.<code>.cache_misses` | Subjects evaluated again; every subject when the Rules cache is off |
184182
| `rule_cache_hits`, `rule_cache_misses` | Rule results reused or evaluated again |
185183
| `project_reuse_hits`, `project_reuse_misses`, `project_reuse_bypasses` | Whether the compile [reused an unchanged compile](#reusing-an-unchanged-compile), compiled because something changed, or was not eligible |
186184
| `project_reuse_check_ms` | Time spent checking whether the previous compile can be reused |
187185
| `total_ms` | Wall time of the whole compile |
188186

189-
Other keys are finer-grained phase timings and cache counters. Each selected custom Rule has all
187+
Other keys are finer-grained phase timings, cache counters and the custom Rules host's own
188+
overhead (`custom_rules_monitor_cpu_ms`, `custom_rules_guard_cpu_ms`). Each selected custom Rule has all
190189
four `custom_rules.<code>.*` keys; read one with
191190
`jq '.compile_timings["custom_rules.XORDERS001.cpu_ms"]'`. A Rule answered fully from the cache
192191
reports `0` invocations. Invocations and CPU can exceed a Rule's subject count, because a Rule

0 commit comments

Comments
 (0)