{"id":17832465,"url":"https://github.com/noerw/osem_notify","last_synced_at":"2025-07-11T19:36:00.032Z","repository":{"id":64306397,"uuid":"138512940","full_name":"noerw/osem_notify","owner":"noerw","description":"CLI to run health checks against sensor stations on openSenseMap.org","archived":false,"fork":false,"pushed_at":"2019-02-10T23:18:18.000Z","size":85,"stargazers_count":1,"open_issues_count":2,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-02T12:34:34.074Z","etag":null,"topics":["cli","healthcheck","notifications","opensensemap","sensebox"],"latest_commit_sha":null,"homepage":"https://noerw.github.io/osem_notify","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/noerw.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-06-24T20:24:37.000Z","updated_at":"2022-01-07T20:35:46.000Z","dependencies_parsed_at":"2023-01-15T10:45:23.867Z","dependency_job_id":null,"html_url":"https://github.com/noerw/osem_notify","commit_stats":null,"previous_names":[],"tags_count":11,"template":false,"template_full_name":null,"purl":"pkg:github/noerw/osem_notify","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/noerw%2Fosem_notify","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/noerw%2Fosem_notify/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/noerw%2Fosem_notify/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/noerw%2Fosem_notify/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/noerw","download_url":"https://codeload.github.com/noerw/osem_notify/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/noerw%2Fosem_notify/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":264887416,"owners_count":23678678,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cli","healthcheck","notifications","opensensemap","sensebox"],"created_at":"2024-10-27T19:58:28.041Z","updated_at":"2025-07-11T19:35:59.788Z","avatar_url":"https://github.com/noerw.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# osem_notify 🔆🌡📡📈  ⚠ 📲\n\nCross platform command line application to run health checks against sensor stations registered on [openSenseMap.org](https://opensensemap.org).\n\nThis tool lets you automatically check if senseBoxes are still runnning correctly,\nand when that's not the case, notifies you.\nCurrently, email notifications are implemented, but other transports can be added easily.\nImplemented health checks are [described below](#available-healthchecks), and new ones can be added just as easily (given some knowledge of programming).\n\nThe tool has multiple modes of operation:\n\n- `osem_notify check boxes`: run one-off checks on boxes\n- `osem_notify watch boxes`: check boxes continuously.\n\nRun `osem_notify help` or check the manual in the [docs/](docs/osem_notify.md) directory for more details.\n\n## get it\nDownload a build from the [releases page](https://github.com/noerw/osem_notify/releases/).\nYou can run the application by running `./osem_notify*` in a terminal in your downloads directory.\n\nOn unix platforms you may need to make it executable, and can add it to your `$PATH` for convenience, so it is always callable via `osem_notify`:\n```sh\nchmod +x osem_notify*\nsudo mv osem_notify* /usr/bin/osem_notify\n```\n\n## configure it\nThe tool works out of the box for basic functionality, but must be configured to set up notifications.\nConfiguration can be done via a YAML file located at `~/.osem_notify.yml` or through environment variables.\nRun `osem_notify help config` for details and an example configuration.\n\n### available healthchecks\n\n`type`               | description\n---------------------|------------\n`measurement_age`    | Alert when a sensor has not submitted measurements within a given duration.\n`measurement_faulty` | Alert when a sensor's last reading was a presumably faulty value (e.g. broken / disconnected sensor).\n`measurement_min`    | Alert when a sensor's last measurement is lower than a given value.\n`measurement_max`    | Alert when a sensor's last measurement is higher than a given value.\n\n### available notification transports\n`transport` | `options`\n------------|------------\n`email`     | `recipients`: list of email addresses\n`slack`     | -\n`xmpp`      | `recipients`: list of JIDs\n\nWant more? [add it](#contribute)!\n\n## build it\nWant to use `osem_notify` on a platform where no builds are provided?\n\nAssuming you have golang installed, run\n```sh\ngo get -v -d ./\ngo build main.go\n```\n\nFor cross-compilation, check [this guide](https://dave.cheney.net/2015/08/22/cross-compilation-with-go-1-5) out.\n\n## contribute\nContributions are welcome!\nCheck out the following locations for plugging in new functionality:\n\n- new notification transports: [core/notifiers.go](core/notifiers.go)\n- new health checks: [core/healthcheck*.go](core/healthchecks.go)\n- new commands: [cmd/](cmd/)\n\nBefore committing and submitting a pull request, please run `go fmt ./ cmd/ core/`.\n\n## license\nGPL-3.0 Norwin Roosen\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnoerw%2Fosem_notify","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnoerw%2Fosem_notify","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnoerw%2Fosem_notify/lists"}