🤬
  • Addressing BugBash suggestions (#11)

    * separate reference docs and adjust capitalization.
    
    * Addressing BugBash suggestions.
    
    * adjust path.
    
    * Update docs/profiler/application-capability-profiler.md
    
    Co-authored-by: Dylan DSilva <[email protected]>
    
    * Update docs/profiler/application-capability-profiler.md
    
    Co-authored-by: Dylan DSilva <[email protected]>
    
    ---------
    
    Co-authored-by: Matheus Cruz Correia de Carvalho Souza <[email protected]>
    Co-authored-by: Dylan DSilva <[email protected]>
  • Loading...
  • macruzco committed with GitHub 11 months ago
    a108f841
    1 parent 14db6c85
  • ■ ■ ■ ■ ■ ■
    docs/profiler/application-capability-profiler.md
    1  -# Application Capability Profiler (ACP)
     1 +# Application capability profiler (ACP)
    2 2  
    3 3  ## Overview
    4 4  
    5 5  Packaged applications may need to access resources outside of the sandbox. Examples of such resources include user files, pictures, registry items, camera, location, and microphone, among others. [Capability declaration](https://learn.microsoft.com/en-us/windows/uwp/packaging/app-capability-declarations) allows sandboxed applications to access some of those resources. Declarations are made in the sandboxed application's package manifest. See [msix-packaging-tool](../packaging/msix-packaging-tool.md) for reference.
    6 6  
    7  -Application Capability Profiler is a set of tools that help identify what capabilities may need to be declared by an application package, so it's granted the resource access it needs. Furthermore, it provides useful diagnostic information on failed access attempts by the application package.
     7 +Application capability profiler is a set of tools that help identify what capabilities may need to be declared by an application package, so it's granted the resource access it needs. Furthermore, it provides useful diagnostic information on failed access attempts by the application package.
    8 8  
    9 9  ## Profiling step 0: set up the target system for profiling
    10 10  
    skipped 4 lines
    15 15  #### 3. Install PowerShell 7
    16 16  
    17 17  See [Installing PowerShell on Windows](https://learn.microsoft.com/en-us/powershell/scripting/install/installing-powershell-on-windows?view=powershell-7.3) for instructions.
     18 +This is required for [Microsoft.Windows.Win32Isolation.ApplicationCapabilityProfiler](reference/Microsoft.Windows.Win32Isolation.ApplicationCapabilityProfiler.md) module compatibility.
    18 19  
    19 20  #### 4. Install Windows Performance Recorder (WPR) if not already installed and add it to PATH.
    20 21  
    skipped 5 lines
    26 27  
    27 28  ![image](images/acp-doc-get-command-wpr-output.png)
    28 29  
    29  -#### 5. Download the Application Capability Profiler archive and extract it to a convenient path.
     30 +#### 5. Download the application capability profiler archive and extract it to a convenient path.
    30 31  
    31  -The Application Capability Profiler archive can be downloaded from this project's release assets.
     32 +The application capability profiler archive can be downloaded from this project's [release assets](../../../..//releases).
    32 33  
    33 34  #### 6. Follow the instructions on [msix-packaging-tool](../packaging/msix-packaging-tool.md) to package the application and install it on the target system.
    34 35  
    skipped 19 lines
    54 55  
    55 56  ## Profiling step 1: import the PowerShell module
    56 57  
     58 +Module: [Microsoft.Windows.Win32Isolation.ApplicationCapabilityProfiler](reference/Microsoft.Windows.Win32Isolation.ApplicationCapabilityProfiler.md)
     59 +
    57 60  In administrator PowerShell 7:
    58 61  
    59 62  ```PowerShell
    skipped 4 lines
    64 67  
    65 68  The Start-Profiling cmdlet takes the path to the target application package manifest or the full name of the application package.
    66 69  Start-Profiling will instrument the target application package for trace logging and enable a trace logging provider for access attempts made by the target application package.
    67  -Start-Profiling requires administrator privileges and that Developer Mode be enabled. See [Start-Profiling](Start-Profiling.md) for details.
     70 +Start-Profiling requires administrator privileges and that Developer Mode be enabled. See [Start-Profiling](reference/Start-Profiling.md) for details.
    68 71  
    69 72  ```PowerShell
    70  -Start-Profiling -ManifestPath TestAppSilo-AppXManifest.xml
     73 +Start-Profiling -ManifestPath TestApp-AppXManifest.xml
     74 +
    71 75  ```
    72 76  
    73 77  ![image](images/acp-doc-start-profiling-output.png)
    skipped 6 lines
    80 84  
    81 85  The Stop-Profiling cmdlet stops an access attempt trace logging session that has been started and takes away the instrumentation for any application packages that had been instrumented for trace logging.
    82 86  Stop-Profiling takes an optional trace path parameter that controls the path used for the output Event Trace Log (.etl) file. &lt;current_directory&gt;\trace.etl by default.
    83  -Stop-Profiling requires administrator privileges and that Developer Mode be enabled. See [Stop-Profiling](Stop-Profiling.md) for details.
     87 +Stop-Profiling requires administrator privileges and that Developer Mode be enabled. See [Stop-Profiling](reference/Stop-Profiling.md) for details.
    84 88  
    85 89  ```PowerShell
    86 90  Stop-Profiling
    skipped 8 lines
    95 99  Get-ProfilingResults takes in the path to the trace file to parse. If none is provided, Get-ProfilingResults will attempt to Stop-Profiling to obtain a trace to parse.
    96 100  Get-ProfilingResults optionally takes a path to a target application manifest. If information in the parsed trace can be attributed to the target application package manifest, the file is edited directly with the output capabilities. Otherwise, a copy of the manifest is made for each of the packages identified in the trace and their identified capabilities.
    97 101  
    98  -See [Get-ProfilingResults](Get-ProfilingResults.md) for details.
     102 +See [Get-ProfilingResults](reference/Get-ProfilingResults.md) for details.
    99 103  
    100 104  ```PowerShell
    101  -Get-ProfilingResults -EtlFilePaths trace.etl -ManifestPath TestAppSilo-AppXManifest.xml
     105 +Get-ProfilingResults -EtlFilePaths trace.etl -ManifestPath TestApp-AppXManifest.xml
     106 +
    102 107  ```
    103 108  
    104 109  ![image](images/acp-doc-get-profilingresults-output.png)
    skipped 5 lines
    110 115  
    111 116  ## Helper cmdlets
    112 117  
    113  -The [Merge-ProfilingResults](Merge-ProfilingResults.md) cmdlet can be used to merge the output from multiple runs of Get-ProfilingResults.
     118 +The [Merge-ProfilingResults](reference/Merge-ProfilingResults.md) cmdlet can be used to merge the output from multiple runs of Get-ProfilingResults.
    114 119  
    115 120  ## Interpreting Get-ProfilingResults output
    116 121  
    skipped 41 lines
    158 163  
    159 164  ## RELATED LINKS
    160 165  
    161  -[Start-Profiling](Start-Profiling.md)
     166 +[Microsoft.Windows.Win32Isolation.ApplicationCapabilityProfiler](reference/Microsoft.Windows.Win32Isolation.ApplicationCapabilityProfiler.md)
    162 167  
    163  -[Stop-Profiling](Stop-Profiling.md)
     168 +[Start-Profiling](reference/Start-Profiling.md)
    164 169  
    165  -[Get-ProfilingResults](Get-ProfilingResults.md)
     170 +[Stop-Profiling](reference/Stop-Profiling.md)
     171 +
     172 +[Get-ProfilingResults](reference/Get-ProfilingResults.md)
    166 173  
    167  -[Merge-ProfilingResults](Merge-ProfilingResults.md)
     174 +[Merge-ProfilingResults](reference/Merge-ProfilingResults.md)
    168 175  
    169 176  [msix-packaging-tool](../packaging/msix-packaging-tool.md)
    170 177  
    skipped 7 lines
  • ■ ■ ■ ■ ■
    docs/profiler/Get-ProfilingResults.md docs/profiler/reference/Get-ProfilingResults.md
    1  ----
    2  -external help file: Microsoft.Windows.Win32Isolation.ApplicationCapabilityProfiler.dll-Help.xml
    3  -Locale: en-US
    4  -Module Name: Microsoft.Windows.Win32Isolation.ApplicationCapabilityProfiler
    5  -ms.date: 05/16/2023
    6  -online version:
    7  -schema: 2.0.0
    8  -title: Get-ProfilingResults
    9  ----
     1 +Module Name: [Microsoft.Windows.Win32Isolation.ApplicationCapabilityProfiler](Microsoft.Windows.Win32Isolation.ApplicationCapabilityProfiler.md)
    10 2  
    11 3  # Get-ProfilingResults
    12 4  
    skipped 217 lines
    230 222  
    231 223  ## RELATED LINKS
    232 224  
    233  -[Application Capability Profiler](application-capability-profiler.md)
     225 +[Application capability profiler](../application-capability-profiler.md)
    234 226  
    235 227  [Start-Profiling](Start-Profiling.md)
    236 228  
    skipped 3 lines
  • ■ ■ ■ ■ ■
    docs/profiler/Merge-ProfilingResults.md docs/profiler/reference/Merge-ProfilingResults.md
    1  ----
    2  -external help file: Microsoft.Windows.Win32Isolation.ApplicationCapabilityProfiler.dll-Help.xml
    3  -Locale: en-US
    4  -Module Name: Microsoft.Windows.Win32Isolation.ApplicationCapabilityProfiler
    5  -ms.date: 05/16/2023
    6  -online version:
    7  -schema: 2.0.0
    8  -title: Merge-ProfilingResults
    9  ----
     1 +Module Name: [Microsoft.Windows.Win32Isolation.ApplicationCapabilityProfiler](Microsoft.Windows.Win32Isolation.ApplicationCapabilityProfiler.md)
    10 2  
    11 3  # Merge-ProfilingResults
    12 4  
    skipped 186 lines
    199 191  
    200 192  ## RELATED LINKS
    201 193  
    202  -[Application Capability Profiler](application-capability-profiler.md)
     194 +[Application capability profiler](../application-capability-profiler.md)
    203 195  
    204 196  [Get-ProfilingResults](Get-ProfilingResults.md)
    205 197  
    skipped 3 lines
  • ■ ■ ■ ■ ■ ■
    docs/profiler/reference/Microsoft.Windows.Win32Isolation.ApplicationCapabilityProfiler.md
     1 +# Microsoft.Windows.Win32Isolation.ApplicationCapabilityProfiler Module
     2 +
     3 +## Description
     4 +
     5 +This section contains the help topics for the cmdlets that are installed with PowerShell
     6 +Microsoft.Windows.Win32Isolation.ApplicationCapabilityProfiler module. The module contains cmdlets that enable access attempt profiling for
     7 +an application package in order to identify what access capabilities should be declared the in application package manifest.
     8 +
     9 +## Microsoft.Windows.Win32Isolation.ApplicationCapabilityProfiler Cmdlets
     10 +
     11 +### [Get-ProfilingResults](Get-ProfilingResults.md)
     12 +Retrieves capability access information from input ETL files.
     13 +
     14 +### [Merge-ProfilingResults](Merge-ProfilingResults.md)
     15 +Merges multiple Get-ProfilingResults output files into a single output file.
     16 +
     17 +### [Start-Profiling](Start-Profiling.md)
     18 +Initiates access attempt profiling for a specified application package.
     19 +
     20 +### [Stop-Profiling](Stop-Profiling.md)
     21 +Stops access attempt profiling for a specified application package.
  • ■ ■ ■ ■ ■
    docs/profiler/Start-Profiling.md docs/profiler/reference/Start-Profiling.md
    1  ----
    2  -external help file: Microsoft.Windows.Win32Isolation.ApplicationCapabilityProfiler.dll-Help.xml
    3  -Locale: en-US
    4  -Module Name: Microsoft.Windows.Win32Isolation.ApplicationCapabilityProfiler
    5  -ms.date: 05/16/2023
    6  -online version:
    7  -schema: 2.0.0
    8  -title: Start-Profiling
    9  ----
     1 +Module Name: [Microsoft.Windows.Win32Isolation.ApplicationCapabilityProfiler](Microsoft.Windows.Win32Isolation.ApplicationCapabilityProfiler.md)
    10 2  
    11 3  # Start-Profiling
    12 4  
    skipped 142 lines
    155 147  
    156 148  ## RELATED LINKS
    157 149  
    158  -[Application Capability Profiler](application-capability-profiler.md)
     150 +[Application capability profiler](../application-capability-profiler.md)
    159 151  
    160 152  [Stop-Profiling](Stop-Profiling.md)
    161 153  
    skipped 5 lines
  • ■ ■ ■ ■ ■
    docs/profiler/Stop-Profiling.md docs/profiler/reference/Stop-Profiling.md
    1  ----
    2  -external help file: Microsoft.Windows.Win32Isolation.ApplicationCapabilityProfiler.dll-Help.xml
    3  -Locale: en-US
    4  -Module Name: Microsoft.Windows.Win32Isolation.ApplicationCapabilityProfiler
    5  -ms.date: 05/16/2023
    6  -online version:
    7  -schema: 2.0.0
    8  -title: Stop-Profiling
    9  ----
     1 +Module Name: [Microsoft.Windows.Win32Isolation.ApplicationCapabilityProfiler](Microsoft.Windows.Win32Isolation.ApplicationCapabilityProfiler.md)
    10 2  
    11 3  # Stop-Profiling
    12 4  
    skipped 143 lines
    156 148  
    157 149  ## RELATED LINKS
    158 150  
    159  -[Application Capability Profiler](application-capability-profiler.md)
     151 +[Application capability profiler](../application-capability-profiler.md)
    160 152  
    161 153  [Start-Profiling](Start-Profiling.md)
    162 154  
    skipped 5 lines
Please wait...
Page is in error, reload to recover