Azavea.Open.Common.Chronometer.TextTableReporter.ReportPrologue C# (CSharp) Method

ReportPrologue() public method

Display a text prologue.
public ReportPrologue ( bool printDisclaimer ) : void
printDisclaimer bool Show the disclaimer text.
return void
            public void ReportPrologue(bool printDisclaimer)
            {
                _log.Info("Begin Timing Report:");
                if ( printDisclaimer ) {
                    _log.Info("DISCLAIMER: Operations that ran a very small number of times, yet supposedly");
                    _log.Info("            took a very long time on average, may be ones that blocked on");
                    _log.Info("            another call or operation for a long time.  For example:");
                    _log.Info("            if every row that is read from a database is sent to a stone");
                    _log.Info("            tablet engraver that takes 5 minutes per tablet, and the next");
                    _log.Info("            row isn't read until the first one is finished being written,");
                    _log.Info("            this report will say it took 15 minutes to read 3 rows.  That");
                    _log.Info("            is technically true, but has nothing to do with the database");
                    _log.Info("            or the code.  This report is to give you a general idea where");
                    _log.Info("            to look for performance problems, not to be the One True ");
                    _log.Info("            Benchmarking Tool.");
                }
            }