sensu-run: A tool to send command execution results to Sensu
sensu-run is a command line tool to send command execution results to Sensu
monitoring server.
[Skip to Readme]
Downloads
- sensu-run-0.2.0.tar.gz [browse] (Cabal source package)
- Package description (as included in the package)
Maintainer's Corner
For package maintainers and hackage trustees
Candidates
| Versions [RSS] | 0.0.0, 0.1.0, 0.1.1, 0.1.1.3, 0.2.0, 0.3.0, 0.4.0, 0.4.0.1, 0.4.0.2, 0.4.0.3, 0.4.0.4, 0.4.0.5, 0.5.0, 0.5.0.1, 0.5.0.2, 0.5.0.3, 0.6.0, 0.6.0.1, 0.6.0.2, 0.6.0.3, 0.6.1, 0.6.1.1, 0.7.0, 0.7.0.2, 0.7.0.3, 0.7.0.4, 0.7.0.5 |
|---|---|
| Change log | CHANGELOG.md |
| Dependencies | aeson (>=0.11 && <1.3), base (>=4.9 && <4.11), bytestring (>=0.10 && <0.11), filepath (>=1.4.1 && <1.5), http-client (>=0.5.6 && <0.6), http-types (>=0.9.1 && <0.10), lens (>=4.15 && <4.16), network (>=2.2.3 && <2.7), optparse-applicative (>=0.12 && <0.15), process (>=1.4 && <1.7), temporary (>=1.1 && <1.3), text (>=1.2.2 && <1.3), time (>=1.5.0.1 && <1.9), unix, vector (>=0.11 && <0.13), wreq (>=0.5.0 && <0.6) [details] |
| Tested with | ghc ==8.0.2 |
| License | BSD-3-Clause |
| Copyright | Copyright (C) 2016-2017 Mitsutoshi Aoe |
| Author | Mitsutoshi Aoe |
| Maintainer | maoe@foldr.in |
| Uploaded | by MitsutoshiAoe at 2017-07-12T04:25:38Z |
| Category | System |
| Home page | https://github.com/maoe/sensu-run#readme |
| Bug tracker | https://github.com/maoe/sensu-run/issues |
| Distributions | |
| Reverse Dependencies | 1 direct, 0 indirect [details] |
| Executables | sensu-run |
| Downloads | 14552 total (75 in the last 30 days) |
| Rating | (no votes yet) [estimated by Bayesian average] |
| Your Rating | |
| Status | Docs not available [build log] Last success reported on 2017-07-12 [all 3 reports] |
Readme for sensu-run-0.2.0
[back to package description]sensu-run
sensu-run runs a command and send its result to Sensu server using the client socket input or via the Sensu API. It is useful to monitor cron jobs for example.
Installation
Install stack.
stack install --resolver=nightly sensu-run
will install the sensu-run command in ~/.local/bin.
Usage
% sensu-run --help
Usage: sensu-run ([-n|--name NAME] [--source SOURCE] [--ttl SECONDS]
[--timeout SECONDS] [--handler HANDLER] ([--port PORT] |
[--server URL]) [--dry|--dry-run] [-s|--shell] [COMMAND] |
[-v|--version])
Available options:
-h,--help Show this help text
-n,--name NAME The name of the check
--source SOURCE The check source, used to create a JIT Sensu client
for an external resource
--ttl SECONDS The time to live in seconds until check results are
considered stale
--timeout SECONDS The check executaion duration timeout in seconds
--handler HANDLER Sensu event handler(s) to use for events created by
the check
--port PORT Send results to the local sensu-client listening on
the specified port (default: 3030)
--server URL Send results to the specified Sensu server
-s,--shell Execute the command using the shell
--dry-run option is useful to check the JSON output:
% sensu-run --name check-home-src-size --handler foo --dry-run -- du -s $HOME/src | jq .
{
"name": "check-home-src-size",
"command": "du -s /home/maoe/src",
"issued": 1496966954,
"executed": 1496966954,
"duration": 1.235584,
"status": 0,
"output": "44567740\t/home/maoe/src\n",
"handlers": [
"foo"
]
}
Without the --dry-run option, sensu-run sends the output to localhost:PORT, which is expected to be listened by sensu-client.
sensu-run sets the status field depending on the command exit code and timeout:
| command exit code | status field |
|---|---|
| 0 | 0 (OK) |
| non-zero | 2 (CRITICAL) |
| command timed out | 3 (UNKNOWN) |
Sensu API
sensu-run supports posting check results via Sensu API as well. Use --server option to specify Sensu server addresses. If multiple servers are specified, sensu-run tries them one by one until it succeeds.
sensu-run --name check-true --handler foo --server sensu1.example.com --server sensu2.example.com --dry-run -- du -s $HOME/src