PoShLog.Sinks.Http

1.0.0-preview1

bin/PoShLog.Sinks.Http.dll-Help.xml

<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh">
  <!-- Cmdlet: Get-ApiKeyHttpClient -->
  <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">
    <command:details>
      <command:name>Get-ApiKeyHttpClient</command:name>
      <command:verb>Get</command:verb>
      <command:noun>ApiKeyHttpClient</command:noun>
      <maml:description>
        <maml:para>Gets instance of ApiKeyHttpClient</maml:para>
      </maml:description>
    </command:details>
    <maml:description>
      <maml:para>Gets instance of ApiKeyHttpClient that is then used by Add-SinkHttp cmdlet.</maml:para>
    </maml:description>
    <command:syntax>
      <!-- Parameter set: __AllParameterSets -->
      <command:syntaxItem>
        <maml:name>Get-ApiKeyHttpClient</maml:name>
        <!-- Parameter: ApiKey -->
        <command:parameter required="false" globbing="false" pipelineInput="false" position="named">
          <maml:name>ApiKey</maml:name>
          <command:parameterValue required="true">string</command:parameterValue>
          <dev:type>
            <maml:name>System.String</maml:name>
            <maml:uri />
          </dev:type>
        </command:parameter>
      </command:syntaxItem>
    </command:syntax>
    <command:parameters>
      <!-- Parameter: ApiKey -->
      <command:parameter required="false" globbing="false" pipelineInput="false" position="named">
        <maml:name>ApiKey</maml:name>
        <command:parameterValue required="true">string</command:parameterValue>
        <dev:type>
          <maml:name>System.String</maml:name>
          <maml:uri />
        </dev:type>
      </command:parameter>
    </command:parameters>
    <command:inputTypes />
    <command:returnValues>
      <!-- OutputType: ApiKeyHttpClient -->
      <command:returnValue>
        <dev:type>
          <maml:name>PoShLog.Sinks.Http.HttpClients.ApiKeyHttpClient</maml:name>
          <maml:uri />
        </dev:type>
      </command:returnValue>
    </command:returnValues>
    <command:examples>
      <command:example>
        <maml:title>---------- EXAMPLE 1 ----------</maml:title>
        <dev:code>PS&gt; New-Logger | Add-SinkHttp -RequestUri 'https://requestbin.net/r/6y06j5z8' -HttpClient (Get-ApiKeyHttpClient -ApiKey '...') | Start-Logger</dev:code>
      </command:example>
    </command:examples>
  </command:command>
  <!-- Cmdlet: Add-SinkHttp -->
  <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">
    <command:details>
      <command:name>Add-SinkHttp</command:name>
      <command:verb>Add</command:verb>
      <command:noun>SinkHttp</command:noun>
      <maml:description>
        <maml:para>Writes log events into given server over the network using HTTP</maml:para>
      </maml:description>
    </command:details>
    <maml:description>
      <maml:para>Adds a non-durable sink that sends log events using HTTP POST over the network.</maml:para>
      <maml:para>A non-durable sink will lose data after a system or process restart.</maml:para>
    </maml:description>
    <command:syntax>
      <!-- Parameter set: __AllParameterSets -->
      <command:syntaxItem>
        <maml:name>Add-SinkHttp</maml:name>
        <!-- Parameter: LoggerConfig -->
        <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0">
          <maml:name>LoggerConfig</maml:name>
          <command:parameterValue required="true">LoggerConfiguration</command:parameterValue>
          <dev:type>
            <maml:name>Serilog.LoggerConfiguration</maml:name>
            <maml:uri />
          </dev:type>
        </command:parameter>
        <!-- Parameter: RequestUri -->
        <command:parameter required="true" globbing="false" pipelineInput="false" position="named">
          <maml:name>RequestUri</maml:name>
          <command:parameterValue required="true">string</command:parameterValue>
          <dev:type>
            <maml:name>System.String</maml:name>
            <maml:uri />
          </dev:type>
        </command:parameter>
        <!-- Parameter: BatchFormatter -->
        <command:parameter required="false" globbing="false" pipelineInput="false" position="named">
          <maml:name>BatchFormatter</maml:name>
          <command:parameterValue required="true">IBatchFormatter</command:parameterValue>
          <dev:type>
            <maml:name>Serilog.Sinks.Http.IBatchFormatter</maml:name>
            <maml:uri />
          </dev:type>
        </command:parameter>
        <!-- Parameter: BatchPostingLimit -->
        <command:parameter required="false" globbing="false" pipelineInput="false" position="named">
          <maml:name>BatchPostingLimit</maml:name>
          <command:parameterValue required="true">int</command:parameterValue>
          <dev:type>
            <maml:name>System.Int32</maml:name>
            <maml:uri />
          </dev:type>
          <dev:defaultValue>1000</dev:defaultValue>
        </command:parameter>
        <!-- Parameter: Configuration -->
        <command:parameter required="false" globbing="false" pipelineInput="false" position="named">
          <maml:name>Configuration</maml:name>
          <command:parameterValue required="true">IConfiguration</command:parameterValue>
          <dev:type>
            <maml:name>Microsoft.Extensions.Configuration.IConfiguration</maml:name>
            <maml:uri />
          </dev:type>
        </command:parameter>
        <!-- Parameter: HttpClient -->
        <command:parameter required="false" globbing="false" pipelineInput="false" position="named">
          <maml:name>HttpClient</maml:name>
          <command:parameterValue required="true">IHttpClient</command:parameterValue>
          <dev:type>
            <maml:name>Serilog.Sinks.Http.IHttpClient</maml:name>
            <maml:uri />
          </dev:type>
        </command:parameter>
        <!-- Parameter: Period -->
        <command:parameter required="false" globbing="false" pipelineInput="false" position="named">
          <maml:name>Period</maml:name>
          <command:parameterValue required="true">TimeSpan</command:parameterValue>
          <dev:type>
            <maml:name>System.TimeSpan</maml:name>
            <maml:uri />
          </dev:type>
        </command:parameter>
        <!-- Parameter: QueueLimit -->
        <command:parameter required="false" globbing="false" pipelineInput="false" position="named">
          <maml:name>QueueLimit</maml:name>
          <command:parameterValue required="true">int</command:parameterValue>
          <dev:type>
            <maml:name>System.Int32</maml:name>
            <maml:uri />
          </dev:type>
        </command:parameter>
        <!-- Parameter: RestrictedToMinimumLevel -->
        <command:parameter required="false" globbing="false" pipelineInput="false" position="named">
          <maml:name>RestrictedToMinimumLevel</maml:name>
          <maml:description>
            <maml:para>Possible values: Verbose, Debug, Information, Warning, Error, Fatal</maml:para>
          </maml:description>
          <command:parameterValue required="true">LogEventLevel</command:parameterValue>
          <dev:type>
            <maml:name>Serilog.Events.LogEventLevel</maml:name>
            <maml:uri />
          </dev:type>
          <dev:defaultValue>Verbose</dev:defaultValue>
          <command:parameterValueGroup>
            <command:parameterValue required="false" variableLength="false">Verbose</command:parameterValue>
            <command:parameterValue required="false" variableLength="false">Debug</command:parameterValue>
            <command:parameterValue required="false" variableLength="false">Information</command:parameterValue>
            <command:parameterValue required="false" variableLength="false">Warning</command:parameterValue>
            <command:parameterValue required="false" variableLength="false">Error</command:parameterValue>
            <command:parameterValue required="false" variableLength="false">Fatal</command:parameterValue>
          </command:parameterValueGroup>
        </command:parameter>
        <!-- Parameter: TextFormatter -->
        <command:parameter required="false" globbing="false" pipelineInput="false" position="named">
          <maml:name>TextFormatter</maml:name>
          <command:parameterValue required="true">ITextFormatter</command:parameterValue>
          <dev:type>
            <maml:name>Serilog.Formatting.ITextFormatter</maml:name>
            <maml:uri />
          </dev:type>
        </command:parameter>
      </command:syntaxItem>
    </command:syntax>
    <command:parameters>
      <!-- Parameter: LoggerConfig -->
      <command:parameter required="true" globbing="false" pipelineInput="true (ByValue)" position="0">
        <maml:name>LoggerConfig</maml:name>
        <command:parameterValue required="true">LoggerConfiguration</command:parameterValue>
        <dev:type>
          <maml:name>Serilog.LoggerConfiguration</maml:name>
          <maml:uri />
        </dev:type>
      </command:parameter>
      <!-- Parameter: RequestUri -->
      <command:parameter required="true" globbing="false" pipelineInput="false" position="named">
        <maml:name>RequestUri</maml:name>
        <command:parameterValue required="true">string</command:parameterValue>
        <dev:type>
          <maml:name>System.String</maml:name>
          <maml:uri />
        </dev:type>
      </command:parameter>
      <!-- Parameter: BatchPostingLimit -->
      <command:parameter required="false" globbing="false" pipelineInput="false" position="named">
        <maml:name>BatchPostingLimit</maml:name>
        <command:parameterValue required="true">int</command:parameterValue>
        <dev:type>
          <maml:name>System.Int32</maml:name>
          <maml:uri />
        </dev:type>
        <dev:defaultValue>1000</dev:defaultValue>
      </command:parameter>
      <!-- Parameter: QueueLimit -->
      <command:parameter required="false" globbing="false" pipelineInput="false" position="named">
        <maml:name>QueueLimit</maml:name>
        <command:parameterValue required="true">int</command:parameterValue>
        <dev:type>
          <maml:name>System.Int32</maml:name>
          <maml:uri />
        </dev:type>
      </command:parameter>
      <!-- Parameter: Period -->
      <command:parameter required="false" globbing="false" pipelineInput="false" position="named">
        <maml:name>Period</maml:name>
        <command:parameterValue required="true">TimeSpan</command:parameterValue>
        <dev:type>
          <maml:name>System.TimeSpan</maml:name>
          <maml:uri />
        </dev:type>
      </command:parameter>
      <!-- Parameter: TextFormatter -->
      <command:parameter required="false" globbing="false" pipelineInput="false" position="named">
        <maml:name>TextFormatter</maml:name>
        <command:parameterValue required="true">ITextFormatter</command:parameterValue>
        <dev:type>
          <maml:name>Serilog.Formatting.ITextFormatter</maml:name>
          <maml:uri />
        </dev:type>
      </command:parameter>
      <!-- Parameter: BatchFormatter -->
      <command:parameter required="false" globbing="false" pipelineInput="false" position="named">
        <maml:name>BatchFormatter</maml:name>
        <command:parameterValue required="true">IBatchFormatter</command:parameterValue>
        <dev:type>
          <maml:name>Serilog.Sinks.Http.IBatchFormatter</maml:name>
          <maml:uri />
        </dev:type>
      </command:parameter>
      <!-- Parameter: RestrictedToMinimumLevel -->
      <command:parameter required="false" globbing="false" pipelineInput="false" position="named">
        <maml:name>RestrictedToMinimumLevel</maml:name>
        <maml:description>
          <maml:para>Possible values: Verbose, Debug, Information, Warning, Error, Fatal</maml:para>
        </maml:description>
        <command:parameterValue required="true">LogEventLevel</command:parameterValue>
        <dev:type>
          <maml:name>Serilog.Events.LogEventLevel</maml:name>
          <maml:uri />
        </dev:type>
        <dev:defaultValue>Verbose</dev:defaultValue>
        <command:parameterValueGroup>
          <command:parameterValue required="false" variableLength="false">Verbose</command:parameterValue>
          <command:parameterValue required="false" variableLength="false">Debug</command:parameterValue>
          <command:parameterValue required="false" variableLength="false">Information</command:parameterValue>
          <command:parameterValue required="false" variableLength="false">Warning</command:parameterValue>
          <command:parameterValue required="false" variableLength="false">Error</command:parameterValue>
          <command:parameterValue required="false" variableLength="false">Fatal</command:parameterValue>
        </command:parameterValueGroup>
      </command:parameter>
      <!-- Parameter: HttpClient -->
      <command:parameter required="false" globbing="false" pipelineInput="false" position="named">
        <maml:name>HttpClient</maml:name>
        <command:parameterValue required="true">IHttpClient</command:parameterValue>
        <dev:type>
          <maml:name>Serilog.Sinks.Http.IHttpClient</maml:name>
          <maml:uri />
        </dev:type>
      </command:parameter>
      <!-- Parameter: Configuration -->
      <command:parameter required="false" globbing="false" pipelineInput="false" position="named">
        <maml:name>Configuration</maml:name>
        <command:parameterValue required="true">IConfiguration</command:parameterValue>
        <dev:type>
          <maml:name>Microsoft.Extensions.Configuration.IConfiguration</maml:name>
          <maml:uri />
        </dev:type>
      </command:parameter>
    </command:parameters>
    <command:inputTypes>
      <command:inputType>
        <dev:type>
          <maml:name>Serilog.LoggerConfiguration</maml:name>
          <maml:uri />
        </dev:type>
      </command:inputType>
    </command:inputTypes>
    <command:returnValues>
      <!-- OutputType: LoggerConfiguration -->
      <command:returnValue>
        <dev:type>
          <maml:name>Serilog.LoggerConfiguration</maml:name>
          <maml:uri />
        </dev:type>
      </command:returnValue>
    </command:returnValues>
    <command:examples>
      <command:example>
        <maml:title>---------- EXAMPLE 1 ----------</maml:title>
        <dev:code>PS&gt; New-Logger | Add-SinkHttp -RequestUri 'https://requestbin.net/r/6y06j5z8' | Start-Logger</dev:code>
      </command:example>
    </command:examples>
  </command:command>
</helpItems>