ct_pc/packages/App.Metrics.Reporting.Console.4.3.0/lib/netstandard2.0/App.Metrics.Reporting.Console.xml

<?xml version="1.0"?>
<doc>
    <assembly>
        <name>App.Metrics.Reporting.Console</name>
    </assembly>
    <members>
        <member name="T:App.Metrics.MetricsConsoleReporterBuilder">
            <summary>
                Builder for configuring metrics console reporting using an
                <see cref="T:App.Metrics.Builder.IMetricsReportingBuilder" />.
            </summary>
        </member>
        <member name="M:App.Metrics.MetricsConsoleReporterBuilder.ToConsole(App.Metrics.Builder.IMetricsReportingBuilder,App.Metrics.Reporting.Console.MetricsReportingConsoleOptions)">
            <summary>
                Add the <see cref="T:App.Metrics.Reporting.Console.ConsoleMetricsReporter" /> allowing metrics to be reported to console.
            </summary>
            <param name="reportingBuilder">
                The <see cref="T:App.Metrics.Builder.IMetricsReportingBuilder" /> used to configure metrics reporters.
            </param>
            <param name="options">The console reporting options to use.</param>
            <returns>
                An <see cref="T:App.Metrics.IMetricsBuilder" /> that can be used to further configure App Metrics.
            </returns>
        </member>
        <member name="M:App.Metrics.MetricsConsoleReporterBuilder.ToConsole(App.Metrics.Builder.IMetricsReportingBuilder,System.Action{App.Metrics.Reporting.Console.MetricsReportingConsoleOptions})">
            <summary>
                Add the <see cref="T:App.Metrics.Reporting.Console.ConsoleMetricsReporter" /> allowing metrics to be reported to console.
            </summary>
            <param name="reportingBuilder">
                The <see cref="T:App.Metrics.Builder.IMetricsReportingBuilder" /> used to configure metrics reporters.
            </param>
            <param name="setupAction">The console reporting options to use.</param>
            <returns>
                An <see cref="T:App.Metrics.IMetricsBuilder" /> that can be used to further configure App Metrics.
            </returns>
        </member>
        <member name="M:App.Metrics.MetricsConsoleReporterBuilder.ToConsole(App.Metrics.Builder.IMetricsReportingBuilder)">
            <summary>
                Add the <see cref="T:App.Metrics.Reporting.Console.ConsoleMetricsReporter" /> allowing metrics to be reported to console.
            </summary>
            <param name="reportingBuilder">
                The <see cref="T:App.Metrics.Builder.IMetricsReportingBuilder" /> used to configure metrics reporters.
            </param>
            <returns>
                An <see cref="T:App.Metrics.IMetricsBuilder" /> that can be used to further configure App Metrics.
            </returns>
        </member>
        <member name="M:App.Metrics.MetricsConsoleReporterBuilder.ToConsole(App.Metrics.Builder.IMetricsReportingBuilder,System.TimeSpan)">
            <summary>
                Add the <see cref="T:App.Metrics.Reporting.Console.ConsoleMetricsReporter" /> allowing metrics to be reported to console.
            </summary>
            <param name="reportingBuilder">
                The <see cref="T:App.Metrics.Builder.IMetricsReportingBuilder" /> used to configure metrics reporters.
            </param>
            <param name="flushInterval">
                The <see cref="T:System.TimeSpan" /> interval used if intended to schedule metrics
                reporting.
            </param>
            <returns>
                An <see cref="T:App.Metrics.IMetricsBuilder" /> that can be used to further configure App Metrics.
            </returns>
        </member>
        <member name="P:App.Metrics.Reporting.Console.ConsoleMetricsReporter.Filter">
            <inheritdoc />
        </member>
        <member name="P:App.Metrics.Reporting.Console.ConsoleMetricsReporter.FlushInterval">
            <inheritdoc />
        </member>
        <member name="P:App.Metrics.Reporting.Console.ConsoleMetricsReporter.Formatter">
            <inheritdoc />
        </member>
        <member name="M:App.Metrics.Reporting.Console.ConsoleMetricsReporter.FlushAsync(App.Metrics.MetricsDataValueSource,System.Threading.CancellationToken)">
            <inheritdoc />
        </member>
        <member name="T:App.Metrics.Reporting.Console.MetricsReportingConsoleOptions">
            <summary>
                Provides programmatic configuration of Console Reporting in the App Metrics framework.
            </summary>
        </member>
        <member name="P:App.Metrics.Reporting.Console.MetricsReportingConsoleOptions.Filter">
            <summary>
                Gets or sets the <see cref="T:App.Metrics.Filters.IFilterMetrics" /> to use for just this reporter.
            </summary>
            <value>
                The <see cref="T:App.Metrics.Filters.IFilterMetrics" /> to use for this reporter.
            </value>
        </member>
        <member name="P:App.Metrics.Reporting.Console.MetricsReportingConsoleOptions.MetricsOutputFormatter">
            <summary>
                Gets or sets the <see cref="T:App.Metrics.Formatters.IMetricsOutputFormatter" /> used to write metrics.
            </summary>
            <value>
                The <see cref="T:App.Metrics.Formatters.IMetricsOutputFormatter" /> used to write metrics.
            </value>
        </member>
        <member name="P:App.Metrics.Reporting.Console.MetricsReportingConsoleOptions.FlushInterval">
            <summary>
                Gets or sets the interval between flushing metrics.
            </summary>
        </member>
    </members>
</doc>