Skip to content

Refactor KMT Readme #37721

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Draft
wants to merge 9 commits into
base: main
Choose a base branch
from
Draft

Refactor KMT Readme #37721

wants to merge 9 commits into from

Conversation

mbertrone
Copy link
Contributor

What does this PR do?

This PR provides a comprehensive rewrite of the README for the Kernel Matrix Testing (KMT). The primary goal is to improve the documentation's clarity, structure, and overall user-friendliness for both new and existing users.

Key changes include:
A new Structure:

  • A Table of Contents for quick navigation.
  • Separate Quick Start guides for local, remote, and mixed (local + remote) VM setups.
  • A Core Concepts section to explain fundamental ideas like stacks and vmsets.
  • Command Reference with dedicated sections for each kmt task.

Motivation

Provide to developers a better User Experience when using this documentation.

Describe how you validated your changes

Documentation changes only

Possible Drawbacks / Trade-offs

Additional Notes

@mbertrone mbertrone self-assigned this Jun 6, 2025
@mbertrone mbertrone added the qa/no-code-change No code change in Agent code requiring validation label Jun 6, 2025
@github-actions github-actions bot added the medium review PR review might take time label Jun 6, 2025
@cit-pr-commenter cit-pr-commenter
Copy link

Regression Detector

Regression Detector Results

Metrics dashboard
Target profiles
Run ID: 9da2ffd6-f11f-4c8d-8a2b-602e63f995b2

Baseline: 6abc654
Comparison: 263e72d
Diff

Optimization Goals: ✅ No significant changes detected

Fine details of change detection per experiment

perf experiment goal Δ mean % Δ mean % CI trials links
➖ docker_containers_cpu % cpu utilization +2.48 [-0.66, +5.63] 1 Logs
➖ quality_gate_logs % cpu utilization +2.27 [-0.55, +5.08] 1 Logs bounds checks dashboard
➖ tcp_syslog_to_blackhole ingress throughput +1.16 [+1.09, +1.22] 1 Logs
➖ quality_gate_idle_all_features memory utilization +0.85 [+0.76, +0.93] 1 Logs bounds checks dashboard
➖ uds_dogstatsd_to_api_cpu % cpu utilization +0.34 [-0.54, +1.22] 1 Logs
➖ uds_dogstatsd_20mb_12k_contexts_20_senders memory utilization +0.33 [+0.28, +0.37] 1 Logs
➖ otlp_ingest_metrics memory utilization +0.19 [+0.03, +0.34] 1 Logs
➖ ddot_logs memory utilization +0.15 [+0.01, +0.29] 1 Logs
➖ file_to_blackhole_0ms_latency_http2 egress throughput +0.04 [-0.58, +0.66] 1 Logs
➖ file_to_blackhole_1000ms_latency_linear_load egress throughput +0.03 [-0.20, +0.26] 1 Logs
➖ file_to_blackhole_500ms_latency egress throughput +0.02 [-0.55, +0.59] 1 Logs
➖ file_to_blackhole_300ms_latency egress throughput +0.02 [-0.61, +0.65] 1 Logs
➖ uds_dogstatsd_to_api ingress throughput -0.00 [-0.29, +0.28] 1 Logs
➖ tcp_dd_logs_filter_exclude ingress throughput -0.01 [-0.04, +0.02] 1 Logs
➖ file_to_blackhole_100ms_latency egress throughput -0.02 [-0.62, +0.59] 1 Logs
➖ file_to_blackhole_0ms_latency egress throughput -0.06 [-0.66, +0.53] 1 Logs
➖ file_to_blackhole_1000ms_latency egress throughput -0.08 [-0.70, +0.54] 1 Logs
➖ file_to_blackhole_0ms_latency_http1 egress throughput -0.08 [-0.64, +0.48] 1 Logs
➖ ddot_metrics memory utilization -0.12 [-0.24, +0.00] 1 Logs
➖ otlp_ingest_logs memory utilization -0.21 [-0.34, -0.09] 1 Logs
➖ quality_gate_idle memory utilization -0.34 [-0.42, -0.26] 1 Logs bounds checks dashboard
➖ docker_containers_memory memory utilization -1.06 [-1.14, -0.98] 1 Logs
➖ file_tree memory utilization -2.62 [-2.80, -2.44] 1 Logs

Bounds Checks: ❌ Failed

perf experiment bounds_check_name replicates_passed links
❌ docker_containers_memory memory_usage 0/10
✅ docker_containers_cpu simple_check_run 10/10
✅ docker_containers_memory simple_check_run 10/10
✅ file_to_blackhole_0ms_latency lost_bytes 10/10
✅ file_to_blackhole_0ms_latency memory_usage 10/10
✅ file_to_blackhole_0ms_latency_http1 lost_bytes 10/10
✅ file_to_blackhole_0ms_latency_http1 memory_usage 10/10
✅ file_to_blackhole_0ms_latency_http2 lost_bytes 10/10
✅ file_to_blackhole_0ms_latency_http2 memory_usage 10/10
✅ file_to_blackhole_1000ms_latency memory_usage 10/10
✅ file_to_blackhole_1000ms_latency_linear_load memory_usage 10/10
✅ file_to_blackhole_100ms_latency lost_bytes 10/10
✅ file_to_blackhole_100ms_latency memory_usage 10/10
✅ file_to_blackhole_300ms_latency lost_bytes 10/10
✅ file_to_blackhole_300ms_latency memory_usage 10/10
✅ file_to_blackhole_500ms_latency lost_bytes 10/10
✅ file_to_blackhole_500ms_latency memory_usage 10/10
✅ quality_gate_idle intake_connections 10/10 bounds checks dashboard
✅ quality_gate_idle memory_usage 10/10 bounds checks dashboard
✅ quality_gate_idle_all_features intake_connections 10/10 bounds checks dashboard
✅ quality_gate_idle_all_features memory_usage 10/10 bounds checks dashboard
✅ quality_gate_logs intake_connections 10/10 bounds checks dashboard
✅ quality_gate_logs lost_bytes 10/10 bounds checks dashboard
✅ quality_gate_logs memory_usage 10/10 bounds checks dashboard

Explanation

Confidence level: 90.00%
Effect size tolerance: |Δ mean %| ≥ 5.00%

Performance changes are noted in the perf column of each table:

  • ✅ = significantly better comparison variant performance
  • ❌ = significantly worse comparison variant performance
  • ➖ = no significant change in performance

A regression test is an A/B test of target performance in a repeatable rig, where "performance" is measured as "comparison variant minus baseline variant" for an optimization goal (e.g., ingress throughput). Due to intrinsic variability in measuring that goal, we can only estimate its mean value for each experiment; we report uncertainty in that value as a 90.00% confidence interval denoted "Δ mean % CI".

For each experiment, we decide whether a change in performance is a "regression" -- a change worth investigating further -- if all of the following criteria are true:

  1. Its estimated |Δ mean %| ≥ 5.00%, indicating the change is big enough to merit a closer look.

  2. Its 90.00% confidence interval "Δ mean % CI" does not contain zero, indicating that if our statistical model is accurate, there is at least a 90.00% chance there is a difference in performance between baseline and comparison variants.

  3. Its configuration does not mark it "erratic".

CI Pass/Fail Decision

✅ Passed. All Quality Gates passed.

  • quality_gate_idle_all_features, bounds check memory_usage: 10/10 replicas passed. Gate passed.
  • quality_gate_idle_all_features, bounds check intake_connections: 10/10 replicas passed. Gate passed.
  • quality_gate_logs, bounds check lost_bytes: 10/10 replicas passed. Gate passed.
  • quality_gate_logs, bounds check intake_connections: 10/10 replicas passed. Gate passed.
  • quality_gate_logs, bounds check memory_usage: 10/10 replicas passed. Gate passed.
  • quality_gate_idle, bounds check memory_usage: 10/10 replicas passed. Gate passed.
  • quality_gate_idle, bounds check intake_connections: 10/10 replicas passed. Gate passed.

usamasaqib
usamasaqib reviewed Jun 6, 2025
View reviewed changes
tasks/kernel_matrix_testing/README.md Outdated
### Configure stack

We will configure the stack to launch
**5. Connect to the VM**
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this should not be listed in the Quick Start section, since this is more of a "power user" feature.

The normal way to interact with the VMs is to use inv kmt.test for running tests against the VMs.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good Point. I agree that kmt.test is the standard way to interact with the VMs, which is why I've highlighted it as the "primary way" in that section.

I chose to include the SSH instructions as an optional, secondary step because debugging is a very common part of the development workflow. My goal for the Quick Start is to give developers the essential information to be productive right away, and that includes knowing how to inspect the environment if a test fails.

Since the section is clearly marked as optional, it shouldn't distract from the main workflow.

tasks/kernel_matrix_testing/README.md Outdated
```

This will generate a file `kmt_ssh_config` in the `~/.ssh` directory, which you can include in your config by using the line `Include ~/.ssh/kmt_ssh_config` in your `~/.ssh/config` file. Then you can then connect to the VMs using the following command:
**5. Connect to the VM**
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same as above. This should not be part of the Quick Start

tasks/kernel_matrix_testing/README.md

## Getting started
## Quick Start
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the quick start section is too long. This section should just contain 1 recommended approach for using KMT. This means

  • Initializing with inv kmt.init
  • using local VMs
  • relying on KMT to generate the stack name. So no --stack parameter is passed.
  • Using inv kmt.test to interact with the VMs.

All other features are power-user features, which should be explained below in the documentation in detail.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's a good point. I agree that the Quick Start section should be as streamlined as possible for new users.

My goal was to present a complete, end-to-end example of the most common development workflow.

Based on your feedback, I've simplified the examples in the guide to better reflect the "happy path." I've removed the explicit --stack parameter to encourage the default behavior of using the git branch name.

The Quick Start for Local VMs now presents the following essential steps for a typical session:

  • kmt.init
  • kmt.gen-config
  • kmt.launch-stack
  • kmt.status
  • kmt.test (with SSH as an optional step for debugging)
  • kmt.destroy-stack

I believe this structure will be a good compromise.

tasks/kernel_matrix_testing/README.md
- `--distro`: Only list distribution images (default).
- `--custom`: Only list custom kernel images.

### `kmt.create-stack`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe we can remove this task, and remove it in subsequent PRs. This is almost never used by anyone.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let me keep the documentation for now. I'll open a PR to remove it both from README and the code. I'll post the PR on the internal channel asking if anyone has concerns about this command being removed before merging it.

tasks/kernel_matrix_testing/README.md Outdated

The file can be incrementally generated. This means a user may generate a vmset file. Launch it. Add more VMs. Launch them in the same stack.
#### Incremental Configuration Examples
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This feature does not work correctly as of today.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removing it from the readme. should we also cleanup the code (in a future PR), or this feature is already removed from the code?

@agent-platform-auto-pr
Copy link
Contributor

agent-platform-auto-pr bot commented Jun 6, 2025 •
edited
Loading

Static quality checks

✅ Please find below the results from static quality gates
Comparison made with ancestor 6abc654

Successful checks

Info

Quality gate Delta On disk size (MiB) Delta On wire size (MiB)
✅ agent_deb_amd64 $${+0}$$ $${731.89}$$ < $${752.99}$$ $${+0.01}$$ $${181.36}$$ < $${187.44}$$
✅ agent_deb_amd64_fips $${+0}$$ $${730.18}$$ < $${751.36}$$ $${+0}$$ $${180.77}$$ < $${187.06}$$
✅ agent_heroku_amd64 $${+0}$$ $${358.53}$$ < $${369.68}$$ $${+0}$$ $${96.49}$$ < $${99.55}$$
✅ agent_msi $${+0}$$ $${959.75}$$ < $${987.01}$$ $${+0.04}$$ $${146.47}$$ < $${150.72}$$
✅ agent_rpm_amd64 $${+0}$$ $${731.88}$$ < $${752.98}$$ $${-0.01}$$ $${183.5}$$ < $${190.03}$$
✅ agent_rpm_amd64_fips $${+0}$$ $${730.17}$$ < $${751.35}$$ $${-0.01}$$ $${183.63}$$ < $${189.81}$$
✅ agent_rpm_arm64 $${0}$$ $${719.27}$$ < $${739.42}$$ $${-0}$$ $${165.44}$$ < $${171.23}$$
✅ agent_rpm_arm64_fips $${-0}$$ $${717.69}$$ < $${737.91}$$ $${-0.03}$$ $${164.71}$$ < $${170.22}$$
✅ agent_suse_amd64 $${+0}$$ $${731.88}$$ < $${752.98}$$ $${-0.01}$$ $${183.5}$$ < $${190.03}$$
✅ agent_suse_amd64_fips $${+0}$$ $${730.17}$$ < $${751.35}$$ $${-0.01}$$ $${183.63}$$ < $${189.81}$$
✅ agent_suse_arm64 $${0}$$ $${719.27}$$ < $${739.42}$$ $${-0}$$ $${165.44}$$ < $${171.23}$$
✅ agent_suse_arm64_fips $${-0}$$ $${717.69}$$ < $${737.91}$$ $${-0.03}$$ $${164.71}$$ < $${170.22}$$
✅ docker_agent_amd64 $${+0.01}$$ $${815.68}$$ < $${849.39}$$ $${-0}$$ $${277.09}$$ < $${288.34}$$
✅ docker_agent_arm64 $${+0}$$ $${826.52}$$ < $${858.97}$$ $${-0}$$ $${263.64}$$ < $${274.36}$$
✅ docker_agent_jmx_amd64 $${+0.01}$$ $${815.68}$$ < $${849.39}$$ $${-0}$$ $${277.09}$$ < $${288.34}$$
✅ docker_agent_jmx_arm64 $${+0}$$ $${826.52}$$ < $${858.97}$$ $${-0}$$ $${263.64}$$ < $${274.36}$$
✅ docker_agent_windows1809 $${+0.01}$$ $${815.68}$$ < $${849.39}$$ $${-0}$$ $${277.09}$$ < $${288.34}$$
✅ docker_agent_windows1809_core $${+0.01}$$ $${815.68}$$ < $${849.39}$$ $${-0}$$ $${277.09}$$ < $${288.34}$$
✅ docker_agent_windows1809_core_jmx $${+0.01}$$ $${815.68}$$ < $${849.39}$$ $${-0}$$ $${277.09}$$ < $${288.34}$$
✅ docker_agent_windows1809_jmx $${+0.01}$$ $${815.68}$$ < $${849.39}$$ $${-0}$$ $${277.09}$$ < $${288.34}$$
✅ docker_agent_windows2022 $${+0.01}$$ $${815.68}$$ < $${849.39}$$ $${-0}$$ $${277.09}$$ < $${288.34}$$
✅ docker_agent_windows2022_core $${+0.01}$$ $${815.68}$$ < $${849.39}$$ $${-0}$$ $${277.09}$$ < $${288.34}$$
✅ docker_agent_windows2022_core_jmx $${+0.01}$$ $${815.68}$$ < $${849.39}$$ $${-0}$$ $${277.09}$$ < $${288.34}$$
✅ docker_agent_windows2022_jmx $${+0.01}$$ $${815.68}$$ < $${849.39}$$ $${-0}$$ $${277.09}$$ < $${288.34}$$
✅ docker_cluster_agent_amd64 $${+0}$$ $${259.16}$$ < $${259.73}$$ $${-0.01}$$ $${102.87}$$ < $${103.68}$$
✅ docker_cluster_agent_arm64 $${+0}$$ $${273.57}$$ < $${274.24}$$ $${-0.01}$$ $${97.57}$$ < $${98.45}$$
✅ docker_cws_instrumentation_amd64 $${0}$$ $${7.08}$$ < $${7.12}$$ $${+0}$$ $${2.95}$$ < $${3.29}$$
✅ docker_cws_instrumentation_arm64 $${0}$$ $${6.69}$$ < $${6.92}$$ $${+0}$$ $${2.7}$$ < $${3.07}$$
✅ docker_dogstatsd_amd64 $${+0}$$ $${38.93}$$ < $${39.57}$$ $${-0}$$ $${14.95}$$ < $${15.76}$$
✅ docker_dogstatsd_arm64 $${-0}$$ $${37.52}$$ < $${38.2}$$ $${-0}$$ $${13.97}$$ < $${14.83}$$
✅ dogstatsd_deb_amd64 $${0}$$ $${30.61}$$ < $${31.52}$$ $${+0}$$ $${8.03}$$ < $${8.97}$$
✅ dogstatsd_deb_arm64 $${0}$$ $${29.16}$$ < $${30.08}$$ $${-0}$$ $${6.97}$$ < $${7.92}$$
✅ dogstatsd_rpm_amd64 $${0}$$ $${30.61}$$ < $${31.52}$$ $${-0}$$ $${8.04}$$ < $${8.98}$$
✅ dogstatsd_suse_amd64 $${0}$$ $${30.61}$$ < $${31.52}$$ $${-0}$$ $${8.04}$$ < $${8.98}$$
✅ iot_agent_deb_amd64 $${0}$$ $${50.46}$$ < $${60.17}$$ $${+0}$$ $${12.84}$$ < $${15.82}$$
✅ iot_agent_deb_arm64 $${0}$$ $${47.91}$$ < $${56.94}$$ $${+0}$$ $${11.14}$$ < $${13.86}$$
✅ iot_agent_deb_armhf $${0}$$ $${47.49}$$ < $${56.41}$$ $${+0.01}$$ $${11.21}$$ < $${13.86}$$
✅ iot_agent_rpm_amd64 $${0}$$ $${50.46}$$ < $${60.18}$$ $${+0}$$ $${12.87}$$ < $${15.84}$$
✅ iot_agent_rpm_arm64 $${0}$$ $${47.91}$$ < $${56.94}$$ $${+0}$$ $${11.16}$$ < $${13.76}$$
✅ iot_agent_suse_amd64 $${0}$$ $${50.46}$$ < $${60.18}$$ $${+0}$$ $${12.87}$$ < $${15.84}$$

@mbertrone mbertrone requested a review from usamasaqib June 13, 2025 10:53
@github-actions github-actions bot added long review PR is complex, plan time to review it and removed medium review PR review might take time labels Jun 13, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@usamasaqib usamasaqib Awaiting requested review from usamasaqib

At least 1 approving review is required to merge this pull request.

Assignees

@mbertrone mbertrone

Labels
long review PR is complex, plan time to review it qa/no-code-change No code change in Agent code requiring validation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@mbertrone @usamasaqib