Revamp dotnet-pgo arguments #48680
Revamp dotnet-pgo arguments #48680
Conversation
davidwrighton
commented
Feb 24, 2021
- Add a document describing the behavior and how it is expected to be used.
- Rework the existing command line handling to implement the proposed create-mibc command. (the merge command is still entirely TBD).
- Revamp command line to more logical model where the options for jittrace collection and mibc collection are distinct - Fix error printing logic - Factor command line processing into its own file
|
@dotnet/crossgen-contrib @AndyAyersMS @briansull Andy, could you take a look at the spec I wrote up, and provide feedback? |
docs/design/features/dotnet-pgo.md
Outdated
|
|
||
| In order to use dotnet-pgo you will need to: | ||
|
|
||
| 1. Collect traces of you application with at least the following trace setting. `Microsoft-Windows-DotNETRuntime:0x1C000080018:4` |
There was a problem hiding this comment.
Maybe an example of doing this, say via dotnet-trace?
| If using trace file format that supports multiple process tracing, specify some combination of the `--pid`, `--process-name` and `--clr-instance-id` switches as needed. When run from the command line in situations where these arguments are needed, the valid args will be printed to the console. Usage of the nettrace file format is recommended for users attempting to run this tool as part of a CI system. | ||
|
|
||
| The `dotnet-pgo` tool is designed to run on a machine which has the same file system layout as the trace. If this is not the case, `dotnet-pgo` may not be able to find assemblies loaded by the application. In those cases, the `--reference` switch may be used to inform `dotnet-pgo` where to find assemblies that are part of the application. | ||
|
|
There was a problem hiding this comment.
Is the argument for --reference supposed to be a full path to an assembly, or a directory where the tool will search for missing assemblies, or ...?
There was a problem hiding this comment.
This argument is a file or path with wild cards. I'll add a note.
| --verbosity <arg> Adjust verbosity level. | ||
| --compressed Generate compressed mibc | ||
| -h, --help Display this usage message. | ||
| ``` |
There was a problem hiding this comment.
This is likely going to need some sort of weighting/prioritization capability. Without it the longer-running scenario profile data may dominate the merged results.
And to figure out suitable weights we may need some sort of analysis capability....
There was a problem hiding this comment.
Agreed, but I think we can bolt that on to this by adding paremeters to the input by adding a ,[flags] after the filename on input.
| --verbosity <arg> Adjust verbosity level. | ||
| --compressed Generate compressed mibc | ||
| -h, --help Display this usage message. | ||
| ``` |
There was a problem hiding this comment.
Agreed, but I think we can bolt that on to this by adding paremeters to the input by adding a ,[flags] after the filename on input.
| If using trace file format that supports multiple process tracing, specify some combination of the `--pid`, `--process-name` and `--clr-instance-id` switches as needed. When run from the command line in situations where these arguments are needed, the valid args will be printed to the console. Usage of the nettrace file format is recommended for users attempting to run this tool as part of a CI system. | ||
|
|
||
| The `dotnet-pgo` tool is designed to run on a machine which has the same file system layout as the trace. If this is not the case, `dotnet-pgo` may not be able to find assemblies loaded by the application. In those cases, the `--reference` switch may be used to inform `dotnet-pgo` where to find assemblies that are part of the application. | ||
|
|
There was a problem hiding this comment.
This argument is a file or path with wild cards. I'll add a note.