Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hylandsoftware/spot
The watchdog for your build agents
https://github.com/hylandsoftware/spot
bamboo golang jenkins mattermost-bot monitoring slack-bot
Last synced: about 2 months ago
JSON representation
The watchdog for your build agents
- Host: GitHub
- URL: https://github.com/hylandsoftware/spot
- Owner: HylandSoftware
- License: mit
- Created: 2018-07-05T14:02:22.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2020-10-02T16:23:08.000Z (over 4 years ago)
- Last Synced: 2024-05-28T19:29:31.698Z (7 months ago)
- Topics: bamboo, golang, jenkins, mattermost-bot, monitoring, slack-bot
- Language: Go
- Size: 61.5 KB
- Stars: 2
- Watchers: 9
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Spot - The Watchdog for your Build Agents
[](https://travis-ci.org/HylandSoftware/spot) [](https://coveralls.io/github/HylandSoftware/spot?branch=master) [](https://goreportcard.com/report/github.com/hylandsoftware/spot)
Spot is a watchdog for build agents in Jenkins and Bamboo
## Building
Spot makes use of [go modules](https://github.com/golang/go/wiki/Modules),
meaning you will need `vgo` or `go` 1.11+. The easiest way to build is to run
`make`, which will generate linux and windows binaries in `dist/`.
If you don't have `make`, you can build manually:
```bash
# linux
go mod download
go build -o dist/spot -v ./cmd/spot
# windows
go mod download
go build -o dist/spot.exe -v ./cmd/spot
```
You can also build the docker container if you do not have `go` / `make` / `dep` installed:
```bash
docker build . -t spot
```
## Usage
```txt
alerts for disconnected build agents
Usage: main.exe [--bamboo BAMBOO] [--jenkins JENKINS] [--slack SLACK] [--template TEMPLATE] [--verbosity VERBOSITY] [--period PERIOD] [--once] [--warmup] [--jenkinsclasswhitelist JENKINSCLASSWHITELIST]
Options:
--bamboo BAMBOO, -b BAMBOO
Bamboo Url & credentials in the form of https://bamboo/,username,password
--jenkins JENKINS, -j JENKINS
Jenkins Url & credentials in the form of https://jenkins/,username,password
--slack SLACK, -s SLACK
Slack-Compatible Incoming Webhook URL
--template TEMPLATE, -t TEMPLATE
Path to template for notifications
--verbosity VERBOSITY, -v VERBOSITY
Verbosity [panic, fatal, error, warn, info, debug] [default: info]
--period PERIOD, -p PERIOD
How long to wait between checks
--once, -o Run checks once and exit
--warmup, -w Run checks without notifications once before starting the watchdog
--jenkinsclasswhitelist JENKINSCLASSWHITELIST, -c JENKINSCLASSWHITELIST
Only consider jenkins agents with the specified class(es)
--help, -h display this help and exit
```
### Example
```txt
$ docker run -it --rm hylandsoftware/spot:latest --jenkins "https://devops.jenkins.hylandqa.net,username,password" --jenkins "https://csp.jenkins.hylandqa.net/" --once --verbosity debug
INFO[0000] Hello, World!
DEBU[0000] Trying to parse jenkins instance jenkins="https://devops.jenkins.hylandqa.net,username,password"
DEBU[0000] Trying to parse jenkins instance jenkins="https://csp.jenkins.hylandqa.net/"
INFO[0000] Running Watchdog Task
DEBU[0000] Checking for offline agents detector="[jenkins] https://devops.jenkins.hylandqa.net"
DEBU[0001] Node is online agent=master detector="[jenkins] https://devops.jenkins.hylandqa.net"
DEBU[0001] Node is online agent=RDV-003960.hylandqa.net detector="[jenkins] https://devops.jenkins.hylandqa.net"
DEBU[0001] Node is online agent=RDV-004063.hylandqa.net detector="[jenkins] https://devops.jenkins.hylandqa.net"
DEBU[0001] Check Complete detector="[jenkins] https://devops.jenkins.hylandqa.net"
DEBU[0001] Checking for offline agents detector="[jenkins] https://csp.jenkins.hylandqa.net"
DEBU[0001] Node is online agent=master detector="[jenkins] https://csp.jenkins.hylandqa.net"
DEBU[0001] Node is online agent="RDV-004097.hylandqa.net (QAV Performance)" detector="[jenkins] https://csp.jenkins.hylandqa.net"
DEBU[0001] Node is online agent="Ubuntu-Docker (10.40.0.120)" detector="[jenkins] https://csp.jenkins.hylandqa.net"
DEBU[0001] Node is online agent=Windows-Server-1709-Docker-0 detector="[jenkins] https://csp.jenkins.hylandqa.net"
DEBU[0001] Node is online agent=Windows-Server-1709-Docker-1 detector="[jenkins] https://csp.jenkins.hylandqa.net"
DEBU[0001] Node is online agent=Windows-Server-1709-Docker-2 detector="[jenkins] https://csp.jenkins.hylandqa.net"
DEBU[0001] Node is online agent=Windows-Server-1709-Docker-3 detector="[jenkins] https://csp.jenkins.hylandqa.net"
DEBU[0001] Node is online agent=Windows-Server-1709-Docker-4 detector="[jenkins] https://csp.jenkins.hylandqa.net"
DEBU[0001] Check Complete detector="[jenkins] https://csp.jenkins.hylandqa.net"
INFO[0001] Goodbye
```
## License
Spot is licensed under the MIT License. See [`LICENSE`](./LICENSE) for details.
Spot makes use of [`go modules`](https://github.com/golang/go/wiki/Modules) for package management.
Packages restored by `go mod` have their own license which may differ from the terms
of the MIT license that we use.
[Dog](https://thenounproject.com/term/dog/61386/) logo by `Buena Buena` from
the Noun Project, licensed under the Creative Commons CC BY License.