Bug Fixes (#7)

new release

Author: gsquire

CHANGELOG.md

@@ -0,0 +1,13 @@
+## 0.3.0
+- Pull Requests
+  - https://github.com/gsquire/topngx/pull/7
+- Change `--no-follow` to `--follow` allowing users to explicitly opt in for tailing log files.
+- Change `-t` to `-i` for the interval argument.
+- Bug Fixes
+  - Only restore the cursor when running in tail mode.
+  - Return an error if a user tries to tail standard input.
+
+## 0.2.0
+- Pull Requests
+  - https://github.com/gsquire/topngx/pull/6
+- Implement the first cut of log tailing.

Cargo.lock

@@ -1,6 +1,6 @@
 [package]
 name = "topngx"
-version = "0.2.0"
+version = "0.3.0"
 authors = ["Garrett Squire <github@garrettsquire.com>"]
 edition = "2018"
 description = "Top for NGINX"

Cargo.toml

@@ -31,26 +31,29 @@ brew install sqlite
 sudo apt-get update && sudo apt-get install libsqlite3-dev
 ```
 
+## CHANGELOG
+[See here](CHANGELOG.md)
+
 ## Usage
 ```sh
-topngx 0.1.0
+topngx 0.3.0
 Garrett Squire <github@garrettsquire.com>
 top for NGINX
 
 USAGE:
     topngx [FLAGS] [OPTIONS] [SUBCOMMAND]
 
 FLAGS:
-    -h, --help         Prints help information
-    -n, --no-follow    Do not tail the log file and only report what is currently there
-    -V, --version      Prints version information
+    -t, --follow     Tail the specified log file. You cannot tail standard input
+    -h, --help       Prints help information
+    -V, --version    Prints version information
 
 OPTIONS:
     -a, --access-log <access-log>    The access log to parse
     -f, --format <format>            The specific log format with which to parse [default: combined]
     -g, --group-by <group-by>        Group by this variable [default: request_path]
     -w, --having <having>            Having clause [default: 1]
-    -t, --interval <interval>        Refresh the statistics using this interval which is given in seconds [default: 2]
+    -i, --interval <interval>        Refresh the statistics using this interval which is given in seconds [default: 2]
     -l, --limit <limit>              The number of records to limit for each query [default: 10]
     -o, --order-by <order-by>        Order of output for the default queries [default: count]
 

README.md

@@ -52,17 +52,17 @@ struct Options {
     having: u64,
 
     /// Refresh the statistics using this interval which is given in seconds.
-    #[structopt(short = "t", long, conflicts_with = "no_follow", default_value = "2")]
+    #[structopt(short, long, default_value = "2")]
     interval: u64,
 
+    /// Tail the specified log file. You cannot tail standard input.
+    #[structopt(short = "t", long)]
+    follow: bool,
+
     /// The number of records to limit for each query.
     #[structopt(short, long, default_value = "10")]
     limit: u64,
 
-    /// Do not tail the log file and only report what is currently there.
-    #[structopt(short, long)]
-    no_follow: bool,
-
     /// Order of output for the default queries.
     #[structopt(short, long, default_value = "count")]
     order_by: String,
@@ -165,7 +165,7 @@ fn tail(
             }
             recv(ticker) -> _ => {
                 execute!(io::stdout(), Clear(ClearType::All))?;
-                processor.report()?;
+                processor.report(opts.follow)?;
             }
         }
     }
@@ -193,8 +193,13 @@ fn run(opts: &Options, fields: Option<Vec<String>>, queries: Option<Vec<String>>
     info!("access log: {}", access_log);
     info!("access log format: {}", opts.format);
 
+    // We cannot tail STDIN.
+    if opts.follow && access_log == STDIN {
+        return Err(anyhow!("cannot tail STDIN"));
+    }
+
     // We need to tail the log file.
-    if !opts.no_follow {
+    if opts.follow {
         return tail(opts, access_log, fields, queries);
     }
 
@@ -206,7 +211,7 @@ fn run(opts: &Options, fields: Option<Vec<String>>, queries: Option<Vec<String>>
     let pattern = format_to_pattern(&opts.format)?;
     let processor = generate_processor(opts, fields, queries)?;
     parse_input(&lines, &pattern, &processor)?;
-    processor.report()
+    processor.report(opts.follow)
 }
 
 fn parse_input(lines: &[String], pattern: &Regex, processor: &Processor) -> Result<()> {

src/main.rs

@@ -81,7 +81,7 @@ impl Processor {
     }
 
     /// Run the queries as specified by the user.
-    pub(crate) fn report(&self) -> Result<()> {
+    pub(crate) fn report(&self, save_cursor: bool) -> Result<()> {
         for query in &self.queries {
             debug!("report query: {}", query);
 
@@ -127,8 +127,10 @@ impl Processor {
             tw.flush()?;
         }
 
-        // Restore our original cursor position.
-        execute!(io::stdout(), RestorePosition)?;
+        // Restore our original cursor position only in tail mode.
+        if save_cursor {
+            execute!(io::stdout(), RestorePosition)?;
+        }
 
         Ok(())
     }