opensensemap/osem_notify
1
0
Fork 0
Code Issues Pull requests Releases Activity

update docs

Browse source
This commit is contained in:
Norwin 2018-06-30 16:00:22 +02:00
parent 794ea5369d
commit d6738691b4
9 changed files with 120 additions and 27 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
docs/osem_notify.md
View file

@ -18,10 +18,16 @@ osem_notify [flags]
-d, --debug enable verbose logging -d, --debug enable verbose logging
-h, --help help for osem_notify -h, --help help for osem_notify
-l, --logformat string log format, can be plain or json (default "plain") -l, --logformat string log format, can be plain or json (default "plain")
-n, --notify if set, will send out notifications. --no-cache send all notifications, ignoring results from previous runs. also don't update the cache.
Otherwise results are printed to stdout only. -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. 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 ### SEE ALSO
@ -31,4 +37,4 @@ osem_notify [flags]
* [osem_notify version](osem_notify_version.md) - Get build and version information * [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 * [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

12
docs/osem_notify_check.md
View file

@ -19,10 +19,16 @@ One-off check for events on boxes
-c, --config string path to config file (default $HOME/.osem_notify.yml) -c, --config string path to config file (default $HOME/.osem_notify.yml)
-d, --debug enable verbose logging -d, --debug enable verbose logging
-l, --logformat string log format, can be plain or json (default "plain") -l, --logformat string log format, can be plain or json (default "plain")
-n, --notify if set, will send out notifications. --no-cache send all notifications, ignoring results from previous runs. also don't update the cache.
Otherwise results are printed to stdout only. -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. 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 ### SEE ALSO
@ -30,4 +36,4 @@ One-off check for events on boxes
* [osem_notify](osem_notify.md) - Root command displaying help * [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 * [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

12
docs/osem_notify_check_boxes.md
View file

@ -23,14 +23,20 @@ osem_notify check boxes <boxId> [...<boxIds>] [flags]
-c, --config string path to config file (default $HOME/.osem_notify.yml) -c, --config string path to config file (default $HOME/.osem_notify.yml)
-d, --debug enable verbose logging -d, --debug enable verbose logging
-l, --logformat string log format, can be plain or json (default "plain") -l, --logformat string log format, can be plain or json (default "plain")
-n, --notify if set, will send out notifications. --no-cache send all notifications, ignoring results from previous runs. also don't update the cache.
Otherwise results are printed to stdout only. -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. 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 ### SEE ALSO
* [osem_notify check](osem_notify_check.md) - One-off check for events on boxes * [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

13
docs/osem_notify_debug.md
View file

@ -23,15 +23,22 @@ osem_notify debug [flags]
-c, --config string path to config file (default $HOME/.osem_notify.yml) -c, --config string path to config file (default $HOME/.osem_notify.yml)
-d, --debug enable verbose logging -d, --debug enable verbose logging
-l, --logformat string log format, can be plain or json (default "plain") -l, --logformat string log format, can be plain or json (default "plain")
-n, --notify if set, will send out notifications. --no-cache send all notifications, ignoring results from previous runs. also don't update the cache.
Otherwise results are printed to stdout only. -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. 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 ### SEE ALSO
* [osem_notify](osem_notify.md) - Root command displaying help * [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 * [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

43
docs/osem_notify_debug_cache.md Normal file
View file

@ -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

15
docs/osem_notify_debug_notifications.md
View file

@ -4,7 +4,8 @@ Verify that notifications are working
### Synopsis ### Synopsis
osem_notify debug <feature> 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] 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) -c, --config string path to config file (default $HOME/.osem_notify.yml)
-d, --debug enable verbose logging -d, --debug enable verbose logging
-l, --logformat string log format, can be plain or json (default "plain") -l, --logformat string log format, can be plain or json (default "plain")
-n, --notify if set, will send out notifications. --no-cache send all notifications, ignoring results from previous runs. also don't update the cache.
Otherwise results are printed to stdout only. -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. 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 ### SEE ALSO
* [osem_notify debug](osem_notify_debug.md) - Run some debugging checks on osem_notify itself * [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

12
docs/osem_notify_version.md
View file

@ -23,14 +23,20 @@ osem_notify version [flags]
-c, --config string path to config file (default $HOME/.osem_notify.yml) -c, --config string path to config file (default $HOME/.osem_notify.yml)
-d, --debug enable verbose logging -d, --debug enable verbose logging
-l, --logformat string log format, can be plain or json (default "plain") -l, --logformat string log format, can be plain or json (default "plain")
-n, --notify if set, will send out notifications. --no-cache send all notifications, ignoring results from previous runs. also don't update the cache.
Otherwise results are printed to stdout only. -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. 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 ### SEE ALSO
* [osem_notify](osem_notify.md) - Root command displaying help * [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

14
docs/osem_notify_watch.md
View file

@ -10,7 +10,7 @@ Watch boxes for events at an interval
``` ```
-h, --help help for watch -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 ### 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) -c, --config string path to config file (default $HOME/.osem_notify.yml)
-d, --debug enable verbose logging -d, --debug enable verbose logging
-l, --logformat string log format, can be plain or json (default "plain") -l, --logformat string log format, can be plain or json (default "plain")
-n, --notify if set, will send out notifications. --no-cache send all notifications, ignoring results from previous runs. also don't update the cache.
Otherwise results are printed to stdout only. -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. 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 ### SEE ALSO
@ -31,4 +37,4 @@ Watch boxes for events at an interval
* [osem_notify](osem_notify.md) - Root command displaying help * [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 * [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

14
docs/osem_notify_watch_boxes.md
View file

@ -22,16 +22,22 @@ osem_notify watch boxes <boxId> [...<boxIds>] [flags]
-a, --api string openSenseMap API to query against (default "https://api.opensensemap.org") -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) -c, --config string path to config file (default $HOME/.osem_notify.yml)
-d, --debug enable verbose logging -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") -l, --logformat string log format, can be plain or json (default "plain")
-n, --notify if set, will send out notifications. --no-cache send all notifications, ignoring results from previous runs. also don't update the cache.
Otherwise results are printed to stdout only. -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. 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 ### SEE ALSO
* [osem_notify watch](osem_notify_watch.md) - Watch boxes for events at an interval * [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