Skip to content

Conversation

@saschagrunert
Copy link
Member

What type of PR is this?

/kind documentation

What this PR does / why we need it:

This commit updates the crictl and benchmark documentation to include missing features and fix inaccuracies:

  • Add missing runtime-config command to command list
  • Document OpenTelemetry tracing flags (--enable-tracing, --tracing-endpoint, --tracing-sampling-rate-per-million)
  • Document profiling flags (--profile-cpu, --profile-mem)
  • Add --list flag to config command documentation
  • Update statsp command description to match actual implementation
  • Update config command description to include "list" capability
  • Fix typo in benchmark.md: "Should help" -> "Show help"

Which issue(s) this PR fixes:

None

Special notes for your reviewer:

None

Does this PR introduce a user-facing change?

Updated the docs to include missing features and fixes.

@k8s-ci-robot k8s-ci-robot added kind/documentation Categorizes issue or PR as related to documentation. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Nov 4, 2025
@k8s-ci-robot k8s-ci-robot added approved Indicates a PR has been approved by an approver from all required OWNERS files. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Nov 4, 2025
This commit updates the crictl and benchmark documentation to include
missing features and fix inaccuracies:

- Add missing runtime-config command to command list
- Document OpenTelemetry tracing flags (--enable-tracing,
  --tracing-endpoint, --tracing-sampling-rate-per-million)
- Document profiling flags (--profile-cpu, --profile-mem)
- Add --list flag to config command documentation
- Update statsp command description to match actual implementation
- Update config command description to include "list" capability
- Fix typo in benchmark.md: "Should help" -> "Show help"

These changes ensure the documentation accurately reflects the current
implementation and makes all features discoverable to users.

Signed-off-by: Sascha Grunert <[email protected]>
@k8s-ci-robot k8s-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Nov 4, 2025
@saschagrunert
Copy link
Member Author

@kubernetes-sigs/cri-tools-maintainers PTAL

Copy link
Member

@SergeyKanzhelev SergeyKanzhelev left a comment

Choose a reason for hiding this comment

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

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Nov 4, 2025
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: saschagrunert, SergeyKanzhelev

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot merged commit e9e057a into kubernetes-sigs:master Nov 4, 2025
58 of 61 checks passed
@saschagrunert saschagrunert deleted the update-documentation branch November 5, 2025 08:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/documentation Categorizes issue or PR as related to documentation. lgtm "Looks good to me", indicates that a PR is ready to be merged. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants