Skip to content
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.

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

Add '-enable_metrics' option to docs / examples #2911

Merged
merged 1 commit into from
Aug 20, 2021

Conversation

eero-t
Copy link
Contributor

@eero-t eero-t commented Jul 15, 2021

Fixes also -disable_metrics 'process' metric name in running.md, and updates list of '-disable_metrics' option metrics.

Note: I've followed the existing documentation convention of giving cAdvisor option names with two dashes (--enable_metrics) although current cAdvisor uses only one dash (-enable_metrics).

@k8s-ci-robot
Copy link
Collaborator

Hi @eero-t. Thanks for your PR.

I'm waiting for a google member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@Creatone
Copy link
Collaborator

/ok-to-test

@eero-t
Copy link
Contributor Author

eero-t commented Aug 16, 2021

Ping! This updates documentation for feature that went in over month ago...

Copy link
Collaborator

@Creatone Creatone left a comment

Choose a reason for hiding this comment

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

Only one nit.

@@ -125,7 +125,8 @@ cAdvisor stores the latest historical data in memory. How long of a history it s
--application_metrics_count_limit=100: Max number of application metrics to store (per container) (default 100)
--collector_cert="": Collector's certificate, exposed to endpoints for certificate based authentication.
--collector_key="": Key for the collector's certificate
--disable_metrics=referenced_memory,cpu_topology,resctrl,udp,advtcp,sched,hugetlb,memory_numa,tcp,process: comma-separated list of metrics to be disabled. Options are 'accelerator', 'cpu_topology','disk', 'diskIO', 'memory_numa', 'network', 'tcp', 'udp', 'percpu', 'sched', 'process', 'hugetlb', 'referenced_memory', 'resctrl', 'cpuset'. (default referenced_memory,cpu_topology,resctrl,udp,advtcp,sched,hugetlb,memory_numa,tcp,process)
--disable_metrics=<metrics>: comma-separated list of metrics to be disabled. Options are accelerator,advtcp,app,cpu,cpuLoad,cpu_topology,cpuset,disk,diskIO,hugetlb,memory,memory_numa,network,oom_event,percpu,perf_event,process,referenced_memory,resctrl,sched,tcp,udp. (default advtcp,cpu_topology,cpuset,hugetlb,memory_numa,process,referenced_memory,resctrl,sched,tcp,udp)
Copy link
Collaborator

Choose a reason for hiding this comment

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

You cannot disable app or cpu.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks, it's fixed now. This was originally part of my PR for removing the whitelist, but I forgot to remove those after splitting doc changes to PR of its own. I'll add separate doc update commit to the other PR.

I fixed "cadvisor-args.yaml" similarly.

Btw. I amended the changes to original commit and rebased the changes on master. Would you in future prefer me to do fixes in separate commits for easier review (with no rebases, unless there's a conflict)?

Copy link
Collaborator

Choose a reason for hiding this comment

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

Yes

Fixes also -disable_metrics 'process' metric name in running.md,
and updates list of '-disable_metrics' option metrics. Metrics
names are now listed in sorted order.

Note: I've followed the existing documentation convention of giving
cAdvisor option names with two dashes (--enable_metrics) although
current cAdvisor uses only one dash (-enable_metrics).
@Creatone Creatone merged commit 63d8378 into google:master Aug 20, 2021
@eero-t eero-t deleted the metrics-doc-updates branch August 20, 2021 14:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants