Skip to content

Logging.md

Latest commit

 

History

History
70 lines (53 loc) · 2.73 KB

Logging.md

File metadata and controls

70 lines (53 loc) · 2.73 KB
Raw

Logging

To keep things simple:

  • no additional logging config file required
  • logging level set via env vars (QSV_LOG_LEVEL and QSV_LOG_DIR)
  • logging can be disabled completely (default behavior for qsv/qsvlite/qsvdp; qsvmcp defaults to info level to capture process-level START/END entries)
  • logging goes to specified directory with auto log rotation (default: current directory)
  • if specified directory doesn't exist, qsv will attempt to create it
  • logs to qsv_rCURRENT.log - rotating at 20mb, keeping 10 most recent log files uncompressed, and 100 gz-compressed log files named sequentially (e.g. qsv_r00001.log, qsv_r00010.log.gz)
  • only requires standard Log trait to add log traces in code

Enable Logging

Set environment variable QSV_LOG_LEVEL to desired level. Default is off (qsvmcp defaults to info to capture process-level START/END entries in qsv_rCURRENT.log).

Note: QSV_LOG_LEVEL controls the standard qsv_rCURRENT.log file (process-level entries). The MCP audit trail (qsvmcp.log) is a separate log produced by the qsv log command and is controlled by QSV_MCP_LOG_LEVEL on the MCP server side.

  • off - no logging
  • error
  • warn
  • info
  • trace
  • debug

Examples

enable WARN for all modules

$ QSV_LOG_LEVEL=warn qsv count ~/tmp/csv/Data7602DescendingYearOrder.cs

# Last line in qsv_rCURRENT.log file
[2021-12-05 09:10:18.976948 -05:00] ERROR [qsv] src\main.rs:233: failed to open /home/mhuang/tmp/csv/Data7602DescendingYearOrder.cs: The system cannot find the file specified. (os error 2)

enable WARN for all, and DEBUG for count command only

$ QSV_LOG_LEVEL=warn,qsv::cmd::count=debug qsv count ~/tmp/csv/Data7602DescendingYearOrder.csv
# Last two lines in qsv_rCURRENT.log file
[2021-12-05 09:14:46.496051 -05:00] DEBUG [qsv::cmd::count] src\cmd\count.rs:37: input: "/home/mhuang/tmp/csv/Data7602DescendingYearOrder.csv", no_header: false, delimiter: None 
[2021-12-05 09:14:46.498044 -05:00] ERROR [qsv] src\main.rs:233: failed to open /home/mhuang/tmp/csv/Data7602DescendingYearOrder.csv: The system cannot find the file specified. (os error 2)

enable INFO to log invocations and elapsed time

$ QSV_LOG_LEVEL=info qsv count 311-10k.csv
# Last two lines of qsv_rCURRENT.log file
[2021-12-01 10:28:28.925011 -05:00] INFO [qsv] src\main.rs:177: START: count .\311-10k.csv
[2021-12-01 10:28:28.997835 -05:00] INFO [qsv] src\main.rs:215: END elapsed: 0.0729002

Add log traces

Just use the Log trait macros!

See count command as example.

use log::{debug, info};

<snip>
    debug!("input: {:?}, no_header: {}, delimiter: {:?}", 
            (&args.arg_input).clone().unwrap(),
            &args.flag_no_headers,
            &args.flag_delimiter
        );
<snip>