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.

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

docs(profilecli): clarifying the CLI help message and documentation for aggregate-callees #3638

Merged
merged 5 commits into from
Oct 23, 2024
Merged

docs(profilecli): clarifying the CLI help message and documentation for aggregate-callees #3638

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
dbef9f0
fix the PGO issue, modify the default value of aggregate-callees and …
JansonLv Oct 18, 2024
603dd14
Merge branch 'main' into fix/pgo-aggregate-callees
JansonLv Oct 18, 2024
702e20d
docs: clarifying the help message and documentation for aggregate-cal…
JansonLv Oct 19, 2024
62abd7a
Update docs/sources/view-and-analyze-profile-data/profile-cli.md
JansonLv Oct 21, 2024
474d1eb
Merge branch 'main' into fix/pgo-aggregate-callees
JansonLv Oct 21, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion cmd/profilecli/query.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -154,7 +154,7 @@ func addQueryGoPGOParams(queryCmd commander) *queryGoPGOParams {
params := new(queryGoPGOParams)
params.queryProfileParams = addQueryProfileParams(queryCmd)
queryCmd.Flag("keep-locations", "Number of leaf locations to keep.").Default("5").Uint32Var(&params.KeepLocations)
queryCmd.Flag("aggregate-callees", "Aggregate samples for the same callee by ignoring the line numbers in the leaf locations.").Default("true").BoolVar(&params.AggregateCallees)
queryCmd.Flag("aggregate-callees", "Default: true. Aggregate samples for the same callee by ignoring the line numbers in the leaf locations. Use --aggregate-callees to enable or --no-aggregate-callees to disable.").Default("true").BoolVar(&params.AggregateCallees)
return params
}

Expand Down
2 changes: 1 addition & 1 deletion docs/sources/view-and-analyze-profile-data/profile-cli.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -289,7 +289,7 @@ By default, it looks for samples within the last hour, though this can be contro
- You can provide a custom time range using the `--from` and `--to` flags, for example, `--from="now-3h" --to="now"`.
- You can specify the profile type via the `--profile-type` flag. The available profile types are listed in the output of the `profilecli query series` command.
- You can specify the number of leaf locations to keep via the `--keep-locations` flag. The default value is `5`. The Go compiler does not use the full stack trace. Reducing the number helps to minimize the profile size.
- You can specify whether the callee aggregation should be used via the `--aggregate-callees` flag. By default, samples are aggregated by the leaf location, ignoring callee line number. Go compiler ignores this information.
- You can specify whether the callee aggregation should be used via the `--aggregate-callees` flag. By default, this setting is true, samples are aggregated by the leaf location, ignoring callee line number. Go compiler ignores this information. You can use `--no-aggregate-callees` to disable aggregation. Try both options to see which gives better for your PGO.
JansonLv marked this conversation as resolved.
Show resolved Hide resolved

2. Construct and execute the command.

Expand Down