Skip to content

Commit

Permalink
Improvements
Browse files Browse the repository at this point in the history
  • Loading branch information
Anthony Green committed Dec 31, 2023
1 parent 74e8528 commit b18d667
Showing 1 changed file with 12 additions and 5 deletions.
17 changes: 12 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,10 @@
# Green Orb
> An 'Observe and Report Buddy' for your SRE toolbox
> [!WARNING]
> This is an experimental work in progress.
> Feedback/Issues/PRs are always welcome.
## Introduction

Green Orb monitors your program's console output for patterns that you
define and performs actions based on what it detects. It serves as a
define, and performs actions based on what it detects. It serves as a
versatile assistant, taking care of routine but critical monitoring
tasks. This tool is especially useful for System Reliability Engineers
(SREs) looking to automate and respond to the vital signs of their
Expand Down Expand Up @@ -96,6 +92,11 @@ channel.

## Channel Details

All channel definitions must have a `name` and a `type`. Signals
reference channels by `name`. The channel's `type` must be one of
`notify`, `kafka`, `exec`, `restart` or `kill`. These types are
described below.

### Sending notifications to messaging platforms

The channel type `notify` is for sending messages to popular messaging
Expand Down Expand Up @@ -201,6 +202,12 @@ The channel type `kill` is for killing your observed process.

The `orb` process will exit.

## Contributing

Green Orb is Free Software, and any and all contributions are welcome!
Please use github's Issue tracker and Pull Request systems for
feedback and improvements.

## Author and License

Green Orb was written by [Anthony
Expand Down

0 comments on commit b18d667

Please sign in to comment.