chronometer

1.0.1.22092324

en-US/chronometer-help.xml

                                <?xml version="1.0" encoding="utf-8"?>

<helpItems schema="maml" xmlns="http://msh">

  <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">

    <command:details>

      <command:name>Format-Chronometer</command:name>

      <command:verb>Format</command:verb>

      <command:noun>Chronometer</command:noun>

      <maml:description>

        <maml:para></maml:para>

      </maml:description>

    </command:details>

    <maml:description>

      <maml:para>Generates a report from a Chronometer</maml:para>

    </maml:description>

    <command:syntax>

      <command:syntaxItem>

        <maml:name>Format-Chronometer</maml:name>

        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">

          <maml:name>ErrorAt</maml:name>

          <maml:Description>

            <maml:para>If the average time of a comamand is more than this, the output is red</maml:para>

          </maml:Description>

          <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue>

          <dev:type>

            <maml:name>Int32</maml:name>

            <maml:uri />

          </dev:type>

          <dev:defaultValue>200</dev:defaultValue>

        </command:parameter>

        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none">

          <maml:name>InputObject</maml:name>

          <maml:Description>

            <maml:para>This is a MonitoredScript object from Get-Chronometer</maml:para>

          </maml:Description>

          <command:parameterValue required="true" variableLength="false">MonitoredScript[]</command:parameterValue>

          <dev:type>

            <maml:name>MonitoredScript[]</maml:name>

            <maml:uri />

          </dev:type>

          <dev:defaultValue>None</dev:defaultValue>

        </command:parameter>

        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">

          <maml:name>ShowAll</maml:name>

          <maml:Description>

            <maml:para>Forces the report to show scripts with no execution time</maml:para>

          </maml:Description>

          <dev:type>

            <maml:name>SwitchParameter</maml:name>

            <maml:uri />

          </dev:type>

          <dev:defaultValue>False</dev:defaultValue>

        </command:parameter>

        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">

          <maml:name>WarningAt</maml:name>

          <maml:Description>

            <maml:para>If the average time of a command is more than this, the output is yellow</maml:para>

          </maml:Description>

          <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue>

          <dev:type>

            <maml:name>Int32</maml:name>

            <maml:uri />

          </dev:type>

          <dev:defaultValue>20</dev:defaultValue>

        </command:parameter>

      </command:syntaxItem>

      <command:syntaxItem>

        <maml:name>Format-Chronometer</maml:name>

        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">

          <maml:name>ErrorAt</maml:name>

          <maml:Description>

            <maml:para>If the average time of a comamand is more than this, the output is red</maml:para>

          </maml:Description>

          <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue>

          <dev:type>

            <maml:name>Int32</maml:name>

            <maml:uri />

          </dev:type>

          <dev:defaultValue>200</dev:defaultValue>

        </command:parameter>

        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none">

          <maml:name>Line</maml:name>

          <maml:Description>

            <maml:para>This is a ScriptLine object from a MonitoredScript object</maml:para>

          </maml:Description>

          <command:parameterValue required="true" variableLength="false">ScriptLine[]</command:parameterValue>

          <dev:type>

            <maml:name>ScriptLine[]</maml:name>

            <maml:uri />

          </dev:type>

          <dev:defaultValue>None</dev:defaultValue>

        </command:parameter>

        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">

          <maml:name>ShowAll</maml:name>

          <maml:Description>

            <maml:para>Forces the report to show scripts with no execution time</maml:para>

          </maml:Description>

          <dev:type>

            <maml:name>SwitchParameter</maml:name>

            <maml:uri />

          </dev:type>

          <dev:defaultValue>False</dev:defaultValue>

        </command:parameter>

        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">

          <maml:name>WarningAt</maml:name>

          <maml:Description>

            <maml:para>If the average time of a command is more than this, the output is yellow</maml:para>

          </maml:Description>

          <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue>

          <dev:type>

            <maml:name>Int32</maml:name>

            <maml:uri />

          </dev:type>

          <dev:defaultValue>20</dev:defaultValue>

        </command:parameter>

      </command:syntaxItem>

    </command:syntax>

    <command:parameters>

      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">

        <maml:name>ErrorAt</maml:name>

        <maml:Description>

          <maml:para>If the average time of a comamand is more than this, the output is red</maml:para>

        </maml:Description>

        <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue>

        <dev:type>

          <maml:name>Int32</maml:name>

          <maml:uri />

        </dev:type>

        <dev:defaultValue>200</dev:defaultValue>

      </command:parameter>

      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none">

        <maml:name>InputObject</maml:name>

        <maml:Description>

          <maml:para>This is a MonitoredScript object from Get-Chronometer</maml:para>

        </maml:Description>

        <command:parameterValue required="true" variableLength="false">MonitoredScript[]</command:parameterValue>

        <dev:type>

          <maml:name>MonitoredScript[]</maml:name>

          <maml:uri />

        </dev:type>

        <dev:defaultValue>None</dev:defaultValue>

      </command:parameter>

      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none">

        <maml:name>Line</maml:name>

        <maml:Description>

          <maml:para>This is a ScriptLine object from a MonitoredScript object</maml:para>

        </maml:Description>

        <command:parameterValue required="true" variableLength="false">ScriptLine[]</command:parameterValue>

        <dev:type>

          <maml:name>ScriptLine[]</maml:name>

          <maml:uri />

        </dev:type>

        <dev:defaultValue>None</dev:defaultValue>

      </command:parameter>

      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">

        <maml:name>ShowAll</maml:name>

        <maml:Description>

          <maml:para>Forces the report to show scripts with no execution time</maml:para>

        </maml:Description>

        <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>

        <dev:type>

          <maml:name>SwitchParameter</maml:name>

          <maml:uri />

        </dev:type>

        <dev:defaultValue>False</dev:defaultValue>

      </command:parameter>

      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">

        <maml:name>WarningAt</maml:name>

        <maml:Description>

          <maml:para>If the average time of a command is more than this, the output is yellow</maml:para>

        </maml:Description>

        <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue>

        <dev:type>

          <maml:name>Int32</maml:name>

          <maml:uri />

        </dev:type>

        <dev:defaultValue>20</dev:defaultValue>

      </command:parameter>

    </command:parameters>

    <command:inputTypes />

    <command:returnValues />

    <maml:alertSet>

      <maml:alert>

        <maml:para></maml:para>

      </maml:alert>

    </maml:alertSet>

    <command:examples>

      <command:example>

        <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title>

        <dev:code>$script = ls C:\workspace\PSGraph\PSGraph -Recurse -Filter *.ps1</dev:code>

        <dev:remarks>

          <maml:para>$resultes = Get-Chronometer -Path $script.fullname  -ScriptBlock {Invoke-Pester C:\workspace\PSGraph} $results | Format-Chronometer -WarnAt 20 -ErrorAt 200</maml:para>

        </dev:remarks>

      </command:example>

    </command:examples>

    <command:relatedLinks />

  </command:command>

  <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">

    <command:details>

      <command:name>Get-Chronometer</command:name>

      <command:verb>Get</command:verb>

      <command:noun>Chronometer</command:noun>

      <maml:description>

        <maml:para></maml:para>

      </maml:description>

    </command:details>

    <maml:description>

      <maml:para>Loads a script and then tracks the line by line execution times</maml:para>

    </maml:description>

    <command:syntax>

      <command:syntaxItem>

        <maml:name>Get-Chronometer</maml:name>

        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="Script, CommandScript">

          <maml:name>ScriptBlock</maml:name>

          <maml:Description>

            <maml:para>The script to start the scrupt or execute other commands</maml:para>

          </maml:Description>

          <command:parameterValue required="true" variableLength="false">ScriptBlock</command:parameterValue>

          <dev:type>

            <maml:name>ScriptBlock</maml:name>

            <maml:uri />

          </dev:type>

          <dev:defaultValue>None</dev:defaultValue>

        </command:parameter>

        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">

          <maml:name>LineNumber</maml:name>

          <maml:Description>

            <maml:para>Line numbers within the script file to measure</maml:para>

          </maml:Description>

          <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue>

          <dev:type>

            <maml:name>Int32[]</maml:name>

            <maml:uri />

          </dev:type>

          <dev:defaultValue>None</dev:defaultValue>

        </command:parameter>

        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none">

          <maml:name>Path</maml:name>

          <maml:Description>

            <maml:para>Script file to measure execution times on</maml:para>

          </maml:Description>

          <command:parameterValue required="true" variableLength="false">Object[]</command:parameterValue>

          <dev:type>

            <maml:name>Object[]</maml:name>

            <maml:uri />

          </dev:type>

          <dev:defaultValue>None</dev:defaultValue>

        </command:parameter>

      </command:syntaxItem>

    </command:syntax>

    <command:parameters>

      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">

        <maml:name>LineNumber</maml:name>

        <maml:Description>

          <maml:para>Line numbers within the script file to measure</maml:para>

        </maml:Description>

        <command:parameterValue required="true" variableLength="false">Int32[]</command:parameterValue>

        <dev:type>

          <maml:name>Int32[]</maml:name>

          <maml:uri />

        </dev:type>

        <dev:defaultValue>None</dev:defaultValue>

      </command:parameter>

      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="named" aliases="none">

        <maml:name>Path</maml:name>

        <maml:Description>

          <maml:para>Script file to measure execution times on</maml:para>

        </maml:Description>

        <command:parameterValue required="true" variableLength="false">Object[]</command:parameterValue>

        <dev:type>

          <maml:name>Object[]</maml:name>

          <maml:uri />

        </dev:type>

        <dev:defaultValue>None</dev:defaultValue>

      </command:parameter>

      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="Script, CommandScript">

        <maml:name>ScriptBlock</maml:name>

        <maml:Description>

          <maml:para>The script to start the scrupt or execute other commands</maml:para>

        </maml:Description>

        <command:parameterValue required="true" variableLength="false">ScriptBlock</command:parameterValue>

        <dev:type>

          <maml:name>ScriptBlock</maml:name>

          <maml:uri />

        </dev:type>

        <dev:defaultValue>None</dev:defaultValue>

      </command:parameter>

    </command:parameters>

    <command:inputTypes />

    <command:returnValues />

    <maml:alertSet>

      <maml:alert>

        <maml:para></maml:para>

      </maml:alert>

    </maml:alertSet>

    <command:examples>

      <command:example>

        <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title>

        <dev:code>Get-Chronometer -Path .\example.ps1 -Script {</dev:code>

        <dev:remarks>

          <maml:para>.\example.ps1 }</maml:para>

        </dev:remarks>

      </command:example>

    </command:examples>

    <command:relatedLinks />

  </command:command>

</helpItems>