https://github.com/samn/run-and-report

Run a command and report to Riemann
https://github.com/samn/run-and-report

Last synced: about 21 hours ago
JSON representation

Run a command and report to Riemann

• Host: GitHub
• URL: https://github.com/samn/run-and-report
• Owner: samn
• License: mit
• Created: 2013-05-28T22:15:37.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2018-05-11T16:42:42.000Z (over 6 years ago)
• Last Synced: 2024-04-14T23:39:32.089Z (7 months ago)
• Language: Python
• Size: 12.7 KB
• Stars: 14
• Watchers: 2
• Forks: 4
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# run-and-report.py

## *Run a command and report to [Riemann](http://riemann.io).*

### Usage

````

Usage: run-and-report.py [options] -- command to run

Options:

  -h, --help            show this help message and exit

  --riemann-host=RIEMANN_HOST

                        The address of Riemann

  --riemann-port=RIEMANN_PORT

                        The port Riemann is running on

  --tags=TAGS           Optional tags for the event

  --ttl=TTL             An optional TTL for the event (in seconds)

  --states=STATES       Describes a mapping of return codes and event states.

                        e.g. ok:0,1|warn:2,3. Return codes without an explicit

                        mapping are assumed error. default=ok:0

  --service=SERVICE     An optional service to the event. Defaults to the

                        basename of the command that's run

  --debug               Output the event before it's sent to Riemann.

  --metric-from-stdout  Use stdout as the metric rather than the elapsed

                        command walltime.

  --state-from-stdout   Use stdout as the state rather than the elapsed

                        command walltime.

  --tcp                 Use TCP transport instead of UDP.

  --host=HOST           Specify hostname.

  --omit-metric         Do not send the metric.

  --attributes=ATTRIBUTES

                        Comma separated list of key=value attribute pairs.

                        e.g. foo=bar,biz=baz

  SSL Options:

    Setting all of these options will cause the connection to be created

    over SSL.

    --keyfile=KEYFILE   Path to PKCS8 private key file in PEM format

    --certfile=CERTFILE

                        Path to client certificate file in PEM format

    --cafile=CAFILE     Path to certificate authorities file in PEM format

````

    

`run-and-report.py` will run the command string and report that the event occurred.

The time it took to run the command will be the metric of the event, unless overridden by `--stdout`

The states argument defines the state of the event based on the return code of the command.

    

### Examples

````

samn@salmon:~ $ run-and-report.py --states "beauty:2,3|ok:0,1" --debug -- ls /dogs

{'description': '\n    STDOUT >>>\n    \n    <<<\n\n    STDERR >>>\n    ls: cannot access /dogs: No such file or directory\n\n    <<<\n    ', 'service': 'ls', 'tags': [], 'metric': 0.0027740001678466797, 'state': 'beauty', 'host': 'salmon', 'attributes': {'command': 'ls /dogs', 'return_code': 2}}

````    

````

samn@salmon:~ $ run-and-report.py --debug --service 'dogs are cool' --tags dogs,dogges -- 'echo 1 && ls /dogs || echo 2'

{'description': '\n    STDOUT >>>\n    1\n2\n\n    <<<\n\n    STDERR >>>\n    ls: cannot access /dogs: No such file or directory\n\n    <<<\n    ', 'service': 'dogs are cool', 'tags': ['dogs', 'dogges'], 'metric': 0.0026619434356689453, 'state': 'ok', 'host': 'salmon', 'attributes': {'command': 'echo 1 && ls /dogs || echo 2', 'return_code': 0}}

````

    

### Requirements

* `bernhard` - Python Riemann client

    * requires python-protobuf

### Is it any good?

sure