Bump version to v0.8 and update README to reflect Nagios output option

eripa · May 29, 2016 · 62ca895 · 62ca895
1 parent 03179d4
commit 62ca895
Show file tree

Hide file tree

Showing 2 changed files with 75 additions and 17 deletions.
diff --git a/README.md b/README.md
@@ -2,7 +2,7 @@
 
 Tool to verify Basic Auth status of multiple given endpoints, via TOML configuration file.
 
-## Usage
+## Get going
 
 
     go get github.com/eripa/ba_checker
@@ -14,21 +14,79 @@ Tool to verify Basic Auth status of multiple given endpoints, via TOML configura
 
 If any check results in `false` in the success column, the tool will exit with 1.
 
-## Example run
-
-                                               URL | Basic Auth |  Wanted BA |    Success | HTTP Status
-    -----------------------------------------------+------------+------------+------------+---------------------------------
-                 http://test.webdav.org/auth-basic |        yes |        yes |       true | 401 Authorization Required
-                        http://test.webdav.org/dav |         no |         no |       true | 404 Not Found
-                           http://test.webdav.org/ |         no |         no |       true | 200 OK
-    -----------------------------------------------+------------+------------+------------+---------------------------------
-                                               URL | Basic Auth |  Wanted BA |    Success | HTTP Status
-    -----------------------------------------------+------------+------------+------------+---------------------------------
-    https://httpbin.org//basic-auth/:user/:passwd  |        yes |        yes |       true | 401 UNAUTHORIZED
-                         https://httpbin.org//html |         no |         no |       true | 200 OK
-                             https://httpbin.org// |         no |         no |       true | 200 OK
-    -----------------------------------------------+------------+------------+------------+---------------------------------
+### Usage
 
+    Usage: ba_checker [--warning=<number>] [--critical=<number>] [--output=<table|nagios>] [--no-spinner] CONFIGFILE
+
+    Check HTTP Basic Auth status
+
+    Status can be determined by Exit codes:
+     0=Status OK
+     1=Above warning threshold
+     2=Above critical threshold
+     3=Unknown Basic Auth status (4xx or 5xx HTTP codes)
+
+    Arguments:
+      CONFIGFILE=""   Config file
+
+    Options:
+      -v, --version          Show the version and exit
+      --no-spinner=false     Disable spinner animation
+      -o, --output="table"   Output format, available formats: table, nagios
+      -w, --warning=1        Warning threshold
+      -c, --critical=2       Critical threshold
+
+## Example runs
+
+### Success run
+
+    ba_checker --no-spinner config-example.toml
+                          URL                      | Basic Auth | Wanted BA | Success |        HTTP Status
+    +----------------------------------------------+------------+-----------+---------+----------------------------+
+      https://httpbin.org/                         | no         | no        | true    | 200 OK
+      https://httpbin.org/basic-auth/:user/:passwd | yes        | yes       | true    | 401 UNAUTHORIZED
+      https://httpbin.org/html                     | no         | no        | true    | 200 OK
+      http://test.webdav.org/                      | no         | no        | true    | 200 OK
+      http://test.webdav.org/auth-basic            | yes        | yes       | true    | 401 Authorization Required
+      http://test.webdav.org/dav                   | unknown    | no        | true    | 404 Not Found
+    +----------------------------------------------+------------+-----------+---------+----------------------------+
+
+    Status: OK
+
+    echo $?
+    0
+
+### Critical set to 1, threshold 1
+
+    ba_checker --critical 1 --no-spinner config-example.toml
+                          URL                      | Basic Auth | Wanted BA | Success |        HTTP Status
+    +----------------------------------------------+------------+-----------+---------+----------------------------+
+      https://httpbin.org/                         | no         | no        | true    | 200 OK
+      https://httpbin.org/basic-auth/:user/:passwd | yes        | yes       | true    | 401 UNAUTHORIZED
+      https://httpbin.org/html                     | no         | no        | true    | 200 OK
+      http://test.webdav.org/                      | no         | yes       | false   | 200 OK
+      http://test.webdav.org/                      | no         | no        | true    | 200 OK
+      http://test.webdav.org/auth-basic            | yes        | yes       | true    | 401 Authorization Required
+    +----------------------------------------------+------------+-----------+---------+----------------------------+
+
+    Status: CRITICAL
+
+    echo $?
+    2
+
+### Warning unset, default is 1. Nagios output format
+
+    ba_checker --no-spinner --output nagios config-example.toml
+    BA check: WARNING - OK: 5/6
+
+    echo $?
+    1
+
+### Notes
+
+Status `UNKNOWN` is only flagged if Basic Auth was wanted, but a HTTP Code other than 401 was encountered. If Critical threshold is exceeded and there is an unknown, `CRITICAL` will be the end-status. `UNKNOWN` will be the end-status if there is an unknown while Warning threshold is exceeded. `WARNING` will be shown if there is no unknown and failures is below criical threshold.
+
+Priority is 1) critical 2) unknown 3) warning
 
 ## Example config file
 

diff --git a/ba_checker.go b/ba_checker.go
@@ -15,7 +15,7 @@ import (
 )
 
 const (
-	toolVersion = "v0.8-pre"
+	toolVersion = "v0.8"
 )
 
 var (
@@ -232,7 +232,7 @@ func checkStatus(sites []site, warningThreshold int, criticalThreshold int) (sta
 	switch {
 	case failures >= criticalThreshold:
 		return 2
-	case unknowns > 0:
+	case unknowns > 0 && failures != 0:
 		return 3
 	case failures >= warningThreshold:
 		return 1