Skip to content

No field information or references? #3089

Open
@Setheck

Description

@Setheck

The documentation on the page is just frustrating. Looking at the Get the system performance statistics section, the extent of the documentation seem to be the json blob below, but where can I find information on what any of this means?

Is CpuLoad a percent? Is IOReadSpeed in bytes? is it a rate? Exposing these metrics is awesome, but I'm not sure what to do with it.
Same thing with EnginesUtilization, will the values always be in the same ordering? What engines are we referring to? It doesn't make any sense and there are no references to clarify.

{
    "AvailablePages": int,
    "CommitLimit": int,
    "CommittedPages": int,
    "CpuLoad": int,
    "IOOtherSpeed": int,
    "IOReadSpeed": int,
    "IOWriteSpeed": int,
    "NonPagedPoolPages": int,
    "PageSize": int,
    "PagedPoolPages": int,
    "TotalInstalledInKb": int,
    "TotalPages": int,
    "GPUData": 
    {
        "AvailableAdapters": [{ (One per detected adapter)
            "DedicatedMemory": int,
            "DedicatedMemoryUsed": int,
            "Description": string,
            "SystemMemory": int,
            "SystemMemoryUsed": int,
            "EnginesUtilization": [ float,... (One per detected engine)]
        },...
    ]},
    "NetworkingData": {
        "NetworkInBytes": int,
        "NetworkOutBytes": int
    }
}

Similarly, on page https://docs.microsoft.com/en-us/windows/uwp/xbox-apps/uwp-deployinfo-api
The request body does not make any sense

Request body

A JSON array in the following format:

* DeployInfo
  * PackageFullName - Name of the package that we are requesting information about.
  * OverlayFolder - Optional path to an overlay folder path if using this feature.

Can someone just provide an example? Not sure how you make an array out of object fields?
is this [{ "DeployInfo":{"PackageFullName":"mypackage","OverlayFolder":""}}]
or {"DeployInfo":[{"PackageFullName":"mypackage","OverlayFolder":""}]}
I have tried many variations and none of it works.


Document Details

Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

Metadata

Metadata

Labels

Pri2deployment/techdoc-bugfeedback is about something that is out of date, unclear, confusing, or broken in the articleuwp/prod

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions