From d6738691b4cd639b737dd900ae3bcffab2d1bf36 Mon Sep 17 00:00:00 2001 From: Norwin Roosen Date: Sat, 30 Jun 2018 16:00:22 +0200 Subject: [PATCH] update docs --- docs/osem_notify.md | 12 +++++-- docs/osem_notify_check.md | 12 +++++-- docs/osem_notify_check_boxes.md | 12 +++++-- docs/osem_notify_debug.md | 13 ++++++-- docs/osem_notify_debug_cache.md | 43 +++++++++++++++++++++++++ docs/osem_notify_debug_notifications.md | 15 ++++++--- docs/osem_notify_version.md | 12 +++++-- docs/osem_notify_watch.md | 14 +++++--- docs/osem_notify_watch_boxes.md | 14 +++++--- 9 files changed, 120 insertions(+), 27 deletions(-) create mode 100644 docs/osem_notify_debug_cache.md diff --git a/docs/osem_notify.md b/docs/osem_notify.md index 3746504..fe883b4 100644 --- a/docs/osem_notify.md +++ b/docs/osem_notify.md @@ -18,10 +18,16 @@ osem_notify [flags] -d, --debug enable verbose logging -h, --help help for osem_notify -l, --logformat string log format, can be plain or json (default "plain") - -n, --notify if set, will send out notifications. - Otherwise results are printed to stdout only. + --no-cache send all notifications, ignoring results from previous runs. also don't update the cache. + -n, --notify string If set, will send out notifications for the specified type of check result, + otherwise results are printed to stdout only. + Allowed values are "all", "error", "ok". You might want to run 'osem_notify debug notifications' first to verify everything works. + Notifications for failing checks are sent only once, and then cached until the issue got + resolved, unless --no-cache is set. + To clear the cache, run 'osem_notify debug cache --clear'. + ``` ### SEE ALSO @@ -31,4 +37,4 @@ osem_notify [flags] * [osem_notify version](osem_notify_version.md) - Get build and version information * [osem_notify watch](osem_notify_watch.md) - Watch boxes for events at an interval -###### Auto generated by spf13/cobra on 26-Jun-2018 +###### Auto generated by spf13/cobra on 30-Jun-2018 diff --git a/docs/osem_notify_check.md b/docs/osem_notify_check.md index 769d703..ffd3a5c 100644 --- a/docs/osem_notify_check.md +++ b/docs/osem_notify_check.md @@ -19,10 +19,16 @@ One-off check for events on boxes -c, --config string path to config file (default $HOME/.osem_notify.yml) -d, --debug enable verbose logging -l, --logformat string log format, can be plain or json (default "plain") - -n, --notify if set, will send out notifications. - Otherwise results are printed to stdout only. + --no-cache send all notifications, ignoring results from previous runs. also don't update the cache. + -n, --notify string If set, will send out notifications for the specified type of check result, + otherwise results are printed to stdout only. + Allowed values are "all", "error", "ok". You might want to run 'osem_notify debug notifications' first to verify everything works. + Notifications for failing checks are sent only once, and then cached until the issue got + resolved, unless --no-cache is set. + To clear the cache, run 'osem_notify debug cache --clear'. + ``` ### SEE ALSO @@ -30,4 +36,4 @@ One-off check for events on boxes * [osem_notify](osem_notify.md) - Root command displaying help * [osem_notify check boxes](osem_notify_check_boxes.md) - one-off check on one or more box IDs -###### Auto generated by spf13/cobra on 26-Jun-2018 +###### Auto generated by spf13/cobra on 30-Jun-2018 diff --git a/docs/osem_notify_check_boxes.md b/docs/osem_notify_check_boxes.md index d00608f..fefdc08 100644 --- a/docs/osem_notify_check_boxes.md +++ b/docs/osem_notify_check_boxes.md @@ -23,14 +23,20 @@ osem_notify check boxes [...] [flags] -c, --config string path to config file (default $HOME/.osem_notify.yml) -d, --debug enable verbose logging -l, --logformat string log format, can be plain or json (default "plain") - -n, --notify if set, will send out notifications. - Otherwise results are printed to stdout only. + --no-cache send all notifications, ignoring results from previous runs. also don't update the cache. + -n, --notify string If set, will send out notifications for the specified type of check result, + otherwise results are printed to stdout only. + Allowed values are "all", "error", "ok". You might want to run 'osem_notify debug notifications' first to verify everything works. + Notifications for failing checks are sent only once, and then cached until the issue got + resolved, unless --no-cache is set. + To clear the cache, run 'osem_notify debug cache --clear'. + ``` ### SEE ALSO * [osem_notify check](osem_notify_check.md) - One-off check for events on boxes -###### Auto generated by spf13/cobra on 26-Jun-2018 +###### Auto generated by spf13/cobra on 30-Jun-2018 diff --git a/docs/osem_notify_debug.md b/docs/osem_notify_debug.md index c63a2a8..b6b58ba 100644 --- a/docs/osem_notify_debug.md +++ b/docs/osem_notify_debug.md @@ -23,15 +23,22 @@ osem_notify debug [flags] -c, --config string path to config file (default $HOME/.osem_notify.yml) -d, --debug enable verbose logging -l, --logformat string log format, can be plain or json (default "plain") - -n, --notify if set, will send out notifications. - Otherwise results are printed to stdout only. + --no-cache send all notifications, ignoring results from previous runs. also don't update the cache. + -n, --notify string If set, will send out notifications for the specified type of check result, + otherwise results are printed to stdout only. + Allowed values are "all", "error", "ok". You might want to run 'osem_notify debug notifications' first to verify everything works. + Notifications for failing checks are sent only once, and then cached until the issue got + resolved, unless --no-cache is set. + To clear the cache, run 'osem_notify debug cache --clear'. + ``` ### SEE ALSO * [osem_notify](osem_notify.md) - Root command displaying help +* [osem_notify debug cache](osem_notify_debug_cache.md) - Print or clear the notifications cache * [osem_notify debug notifications](osem_notify_debug_notifications.md) - Verify that notifications are working -###### Auto generated by spf13/cobra on 26-Jun-2018 +###### Auto generated by spf13/cobra on 30-Jun-2018 diff --git a/docs/osem_notify_debug_cache.md b/docs/osem_notify_debug_cache.md new file mode 100644 index 0000000..9ec51f6 --- /dev/null +++ b/docs/osem_notify_debug_cache.md @@ -0,0 +1,43 @@ +## osem_notify debug cache + +Print or clear the notifications cache + +### Synopsis + +osem_notify debug cache prints the contents of the notifications cache + +``` +osem_notify debug cache [flags] +``` + +### Options + +``` + --clear reset the notifications cache + -h, --help help for cache +``` + +### Options inherited from parent commands + +``` + -a, --api string openSenseMap API to query against (default "https://api.opensensemap.org") + -c, --config string path to config file (default $HOME/.osem_notify.yml) + -d, --debug enable verbose logging + -l, --logformat string log format, can be plain or json (default "plain") + --no-cache send all notifications, ignoring results from previous runs. also don't update the cache. + -n, --notify string If set, will send out notifications for the specified type of check result, + otherwise results are printed to stdout only. + Allowed values are "all", "error", "ok". + You might want to run 'osem_notify debug notifications' first to verify everything works. + + Notifications for failing checks are sent only once, and then cached until the issue got + resolved, unless --no-cache is set. + To clear the cache, run 'osem_notify debug cache --clear'. + +``` + +### SEE ALSO + +* [osem_notify debug](osem_notify_debug.md) - Run some debugging checks on osem_notify itself + +###### Auto generated by spf13/cobra on 30-Jun-2018 diff --git a/docs/osem_notify_debug_notifications.md b/docs/osem_notify_debug_notifications.md index 14b5188..6392804 100644 --- a/docs/osem_notify_debug_notifications.md +++ b/docs/osem_notify_debug_notifications.md @@ -4,7 +4,8 @@ Verify that notifications are working ### Synopsis -osem_notify debug tests the functionality of the given feature +osem_notify debug notifications sends a test notification according +to healthchecks.default.notifications.options as defined in the config file ``` osem_notify debug notifications [flags] @@ -23,14 +24,20 @@ osem_notify debug notifications [flags] -c, --config string path to config file (default $HOME/.osem_notify.yml) -d, --debug enable verbose logging -l, --logformat string log format, can be plain or json (default "plain") - -n, --notify if set, will send out notifications. - Otherwise results are printed to stdout only. + --no-cache send all notifications, ignoring results from previous runs. also don't update the cache. + -n, --notify string If set, will send out notifications for the specified type of check result, + otherwise results are printed to stdout only. + Allowed values are "all", "error", "ok". You might want to run 'osem_notify debug notifications' first to verify everything works. + Notifications for failing checks are sent only once, and then cached until the issue got + resolved, unless --no-cache is set. + To clear the cache, run 'osem_notify debug cache --clear'. + ``` ### SEE ALSO * [osem_notify debug](osem_notify_debug.md) - Run some debugging checks on osem_notify itself -###### Auto generated by spf13/cobra on 26-Jun-2018 +###### Auto generated by spf13/cobra on 30-Jun-2018 diff --git a/docs/osem_notify_version.md b/docs/osem_notify_version.md index c5d6baf..6b8bb1e 100644 --- a/docs/osem_notify_version.md +++ b/docs/osem_notify_version.md @@ -23,14 +23,20 @@ osem_notify version [flags] -c, --config string path to config file (default $HOME/.osem_notify.yml) -d, --debug enable verbose logging -l, --logformat string log format, can be plain or json (default "plain") - -n, --notify if set, will send out notifications. - Otherwise results are printed to stdout only. + --no-cache send all notifications, ignoring results from previous runs. also don't update the cache. + -n, --notify string If set, will send out notifications for the specified type of check result, + otherwise results are printed to stdout only. + Allowed values are "all", "error", "ok". You might want to run 'osem_notify debug notifications' first to verify everything works. + Notifications for failing checks are sent only once, and then cached until the issue got + resolved, unless --no-cache is set. + To clear the cache, run 'osem_notify debug cache --clear'. + ``` ### SEE ALSO * [osem_notify](osem_notify.md) - Root command displaying help -###### Auto generated by spf13/cobra on 26-Jun-2018 +###### Auto generated by spf13/cobra on 30-Jun-2018 diff --git a/docs/osem_notify_watch.md b/docs/osem_notify_watch.md index 63e5187..f4775b6 100644 --- a/docs/osem_notify_watch.md +++ b/docs/osem_notify_watch.md @@ -10,7 +10,7 @@ Watch boxes for events at an interval ``` -h, --help help for watch - -i, --interval int interval to run checks in minutes (default 15) + -i, --interval int interval to run checks in minutes (default 30) ``` ### Options inherited from parent commands @@ -20,10 +20,16 @@ Watch boxes for events at an interval -c, --config string path to config file (default $HOME/.osem_notify.yml) -d, --debug enable verbose logging -l, --logformat string log format, can be plain or json (default "plain") - -n, --notify if set, will send out notifications. - Otherwise results are printed to stdout only. + --no-cache send all notifications, ignoring results from previous runs. also don't update the cache. + -n, --notify string If set, will send out notifications for the specified type of check result, + otherwise results are printed to stdout only. + Allowed values are "all", "error", "ok". You might want to run 'osem_notify debug notifications' first to verify everything works. + Notifications for failing checks are sent only once, and then cached until the issue got + resolved, unless --no-cache is set. + To clear the cache, run 'osem_notify debug cache --clear'. + ``` ### SEE ALSO @@ -31,4 +37,4 @@ Watch boxes for events at an interval * [osem_notify](osem_notify.md) - Root command displaying help * [osem_notify watch boxes](osem_notify_watch_boxes.md) - watch a list of box IDs for events -###### Auto generated by spf13/cobra on 26-Jun-2018 +###### Auto generated by spf13/cobra on 30-Jun-2018 diff --git a/docs/osem_notify_watch_boxes.md b/docs/osem_notify_watch_boxes.md index 160904d..12f56e5 100644 --- a/docs/osem_notify_watch_boxes.md +++ b/docs/osem_notify_watch_boxes.md @@ -22,16 +22,22 @@ osem_notify watch boxes [...] [flags] -a, --api string openSenseMap API to query against (default "https://api.opensensemap.org") -c, --config string path to config file (default $HOME/.osem_notify.yml) -d, --debug enable verbose logging - -i, --interval int interval to run checks in minutes (default 15) + -i, --interval int interval to run checks in minutes (default 30) -l, --logformat string log format, can be plain or json (default "plain") - -n, --notify if set, will send out notifications. - Otherwise results are printed to stdout only. + --no-cache send all notifications, ignoring results from previous runs. also don't update the cache. + -n, --notify string If set, will send out notifications for the specified type of check result, + otherwise results are printed to stdout only. + Allowed values are "all", "error", "ok". You might want to run 'osem_notify debug notifications' first to verify everything works. + Notifications for failing checks are sent only once, and then cached until the issue got + resolved, unless --no-cache is set. + To clear the cache, run 'osem_notify debug cache --clear'. + ``` ### SEE ALSO * [osem_notify watch](osem_notify_watch.md) - Watch boxes for events at an interval -###### Auto generated by spf13/cobra on 26-Jun-2018 +###### Auto generated by spf13/cobra on 30-Jun-2018