papertrail 0.9.14 → 0.9.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6ec5dc941ee73d3ac3e4d09ceb251ce98f6636ff
-  data.tar.gz: a2608baf753fd3c8a53cde255be5a85aace18de7
+  metadata.gz: 96a2c3cc43ed9c786f12b7ae3eed670023acc879
+  data.tar.gz: 06802ee6a3b010b9d6cf236c16491b6537c5b194
 SHA512:
-  metadata.gz: 1f0ce6f6e3a6d38025129ba4204c88ecf5cc394fdae9d51360b4e28f5557d9c2690c4a72167058950db8712e93fee2f9954be167d59c0ab7609022781c9ad077
-  data.tar.gz: 9582577a546c365bbc50eaf397d99db3bef26726022ef08f099da462f0f9d64050f0f8a3ab6a24843a8660ca1b7cf053a8adcd4be017bd86e013e25d171b84f9
+  metadata.gz: ef5944bcc5c41bc1a76dec37c6d308e3afe86027d23fe499b9a0d0b63ec58d79d4c38ae6c4edf2c2c731f57fae17bb365ac95db641d8f1fc37cdd326a8c3dd85
+  data.tar.gz: bb6ebf3bfb8b46ce596a45f16cce0f23700b41663b30e739fecafd4923cd6fc35801861d4c14bcb231eabd34a936a3810523fc7039fd9909e2c6ecd92672123d

data/README.md

@@ -59,40 +59,42 @@ You may want to alias "pt" to "papertrail", like:
 
     echo "alias pt=papertrail" >> ~/.bashrc
 
-
 ## Usage & Examples
 
-    $ papertrail -h
+    $ papertrail --help
     papertrail - command-line tail and search for Papertrail log management service
         -h, --help                       Show usage
-        -f, --follow                     Continue running and print new events (off)
+        -f, --follow                     Continue running and printing new events (off)
+            --min-time MIN               Earliest time to search from
+            --max-time MAX               Latest time to search from
         -d, --delay SECONDS              Delay between refresh (2)
         -c, --configfile PATH            Path to config (~/.papertrail.yml)
-        -s, --system SYSTEM              System to search
         -g, --group GROUP                Group to search
         -S, --search SEARCH              Saved search to search
-        -j, --json                       Output raw json data
-        --min-time MIN                   Earliest time to search from.
-        --max-time MAX                   Latest time to search from.
-
-
-    Usage:
-      papertrail [-f] [-s system] [-g group] [-d seconds] [-c papertrail.yml] [-j] [--min-time mintime] [--max-time maxtime] [query]
-
-    Examples:
-      papertrail -f
-      papertrail something
-      papertrail --min-time "20 minutes ago" 1.2.3 Failure
-      papertrail -s ns1 "connection refused"
-      papertrail -f "(www OR db) (nginx OR pgsql) -accepted"
-      papertrail -f -g Production "(nginx OR pgsql) -accepted"
-      papertrail -S "Critical errors"
-      papertrail -g Production --min-time 'yesterday at noon' --max-time 'today at 4am'
-
-    Includes 4 binaries to change Papertrail settings: papertrail-add-system, papertrail-remove-system,
-      papertrail-add-group, papertrail-leave-group. Run with --help or see README.
-
-    More: http://papertrailapp.com/
+        -s, --system SYSTEM              System to search
+        -j, --json                       Output raw JSON data (off)
+            --color [program|system|all|off]
+                                         Attribute(s) to colorize based on (program)
+            --force-color                Force use of ANSI color characters even on non-tty outputs (off)
+        -V, --version                    Display the version and exit
+
+      Usage:
+        papertrail [-f] [--min-time time] [--max-time time] [-g group] [-S search]
+          [-s system] [-d seconds] [-c papertrail.yml] [-j] [--color attributes]
+          [--force-color] [--] [query]
+
+      Examples:
+        papertrail -f
+        papertrail something
+        papertrail 1.2.3 Failure
+        papertrail -s ns1 "connection refused"
+        papertrail -f "(www OR db) (nginx OR pgsql) -accepted"
+        papertrail -f -g Production --color all "(nginx OR pgsql) -accepted"
+        papertrail --min-time 'yesterday at noon' --max-time 'today at 4am' -g Production
+        papertrail -- -redis
+
+      More: https://github.com/papertrail/papertrail-cli
+            https://papertrailapp.com/
 
 
 ### Count, pivot, and summarize
@@ -125,34 +127,37 @@ For sum, mean, and statistics, see
 ANSI color codes are retained, so log messages which are already colorized
 will automatically render in color on ANSI-capable terminals.
 
-To colorize monochrome logs, pipe through [lnav]. Install `lnav` from your
+By default, the CLI will colorize the non-body portion of each log message
+based on the value of the program attribute. 5 colors are available, so colors
+may not be unique. When the sending system name is more important than the
+program, use `--color=system` to colorize based on its value. Use `--color=all`
+to colorize based on both together.
+
+For content-based colorization, pipe through [lnav]. Install `lnav` from your
 preferred package repository, such as `brew install lnav` or
 `apt-get install lnav`, then:
 
     $ papertrail -f | lnav
     $ papertrail --min-time "1 hour ago" error | lnav
 
-### Shorthand
+### Redirecting output
 
-If you're using bash, create a function that accepts arguments, then
-invoke `pt` with optional search operators:
+Since output is line-buffered, pipes and output redirection will automatically
+work:
 
-    $ function pt() { papertrail -f -d 5 $* | lnav; }
-    $ pt 1.2.3 Failure
-
-Add the function line to your `~/.bashrc`.
+    $ papertrail | less
+    $ papertrail --min-time '2016-01-15 10:00:00' > logs.txt
 
-### Advanced
+If you frequently pipe output to a certain command, create a function which
+accepts optional arguments, invokes `papertrail` with any arguments, and pipes
+output to that command. For example, this `pt` function will pipe to `lnav`:
 
-For complete control, pipe through anything capable of inserting ANSI
-control characters. Here's an example that colorizes 3 fields separately
-(the first 15 characters for the date, a word for the hostname, and a
-word for the program name):
+    $ function pt() { papertrail -f -d 5 $* | lnav; }
 
-    $ papertrail | perl -pe 's/^(.{15})(.)([\S]+)(.)([\S]+)/\e[1;31;43m\1\e[0m\2\e[1;31;43m\3\e[0m\4\e[1;31;43m\5\e[0m/g'
+Add the `function` line to your `~/.bashrc`. It can be invoked with search
+parameters:
 
-the `1;31;43` are bold (1), foreground red (31), background yellow (43),
-and can be any ANSI [escape characters].
+    $ pt 1.2.3 Failure
 
 ### UTF-8 (non-English searches)
 
@@ -213,6 +218,20 @@ even though one is for 4 words (AND) while the other is for a phrase:
     papertrail -f Connection reset by peer
     papertrail -f '"Connection reset by peer"'
 
+### Multiple API tokens
+
+To use multiple API tokens (such as for separate home and work Papertrail
+accounts), create a `.papertrail.yml` configuration file in each project's
+working directory and invoke the CLI in that directory. The CLI checks for
+`.papertrail.yml` in the current working directory prior to using
+`~/.papertrail.yml`.
+
+Alternatively, use shell aliases with different `-c` paths. For example:
+
+    echo "alias pt1='papertrail -c /path/to/papertrail-home.yml'" >> ~/.bashrc
+    echo "alias pt2='papertrail -c /path/to/papertrail-work.yml'" >> ~/.bashrc
+
+
 ## Add/Remove Systems, Create Group, Join Group
 
 In addition to tail and search with the `papertrail` binary, the gem includes

data/lib/papertrail.rb

@@ -1,5 +1,5 @@
 module Papertrail
- VERSION = "0.9.14"
+  VERSION = "0.9.15"
 end
 
 require 'papertrail/connection'

data/lib/papertrail/cli.rb

@@ -3,6 +3,7 @@ require 'yaml'
 require 'chronic'
 require 'ansi/core'
 
+require 'papertrail'
 require 'papertrail/connection'
 require 'papertrail/cli_helpers'
 require 'papertrail/okjson'
@@ -34,7 +35,8 @@ module Papertrail
       end
 
       OptionParser.new do |opts|
-        opts.banner = "papertrail - command-line tail and search for Papertrail log management service"
+        opts.banner  = "papertrail - command-line tail and search for Papertrail log management service"
+        opts.version = Papertrail::VERSION
 
         opts.on("-h", "--help", "Show usage") do |v|
           puts opts
@@ -67,14 +69,18 @@ module Papertrail
         opts.on("-j", "--json", "Output raw JSON data (off)") do |v|
           options[:json] = true
         end
-        opts.on("--color [program|system|all|off] (program)",
+        opts.on("--color [program|system|all|off]",
                 [:program, :system, :all, :off],
-                "Attribute(s) to colorize based on") do |v|
+                "Attribute(s) to colorize based on (program)") do |v|
           options[:color] = v
         end
         opts.on("--force-color", "Force use of ANSI color characters even on non-tty outputs (off)") do |v|
           options[:force_color] = true
         end
+        opts.on("-V", "--version", "Display the version and exit") do |v|
+          puts "papertrail version #{Papertrail::VERSION}"
+          exit
+        end
 
         opts.separator usage
       end.parse!
@@ -194,7 +200,7 @@ module Papertrail
   Usage:
     papertrail [-f] [--min-time time] [--max-time time] [-g group] [-S search]
       [-s system] [-d seconds] [-c papertrail.yml] [-j] [--color attributes]
-      [--force-color] [query]
+      [--force-color] [--version] [--] [query]
 
   Examples:
     papertrail -f
@@ -204,6 +210,7 @@ module Papertrail
     papertrail -f "(www OR db) (nginx OR pgsql) -accepted"
     papertrail -f -g Production --color all "(nginx OR pgsql) -accepted"
     papertrail --min-time 'yesterday at noon' --max-time 'today at 4am' -g Production
+    papertrail -- -redis
 
   More: https://github.com/papertrail/papertrail-cli
         https://papertrailapp.com/

data/papertrail.gemspec

@@ -13,8 +13,8 @@ Gem::Specification.new do |s|
   ## If your rubyforge_project name is different, then edit it and comment out
   ## the sub! line in the Rakefile
   s.name              = 'papertrail'
-  s.version           = '0.9.14'
-  s.date              = '2015-12-14'
+  s.version           = '0.9.15'
+  s.date              = '2016-01-26'
   s.rubyforge_project = 'papertrail'
 
   ## Make sure your summary is short. The description may be as long

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: papertrail
 version: !ruby/object:Gem::Version
-  version: 0.9.14
+  version: 0.9.15
 platform: ruby
 authors:
 - Papertrail
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-14 00:00:00.000000000 Z
+date: 2016-01-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chronic
@@ -118,3 +118,4 @@ signing_key:
 specification_version: 2
 summary: Command-line client for Papertrail hosted log management service.
 test_files: []
+has_rdoc: