https://github.com/catvec/prometheus-canary
Intentionally trigger Prometheus alerts to test alerting.
https://github.com/catvec/prometheus-canary
Last synced: 7 months ago
JSON representation
Intentionally trigger Prometheus alerts to test alerting.
- Host: GitHub
- URL: https://github.com/catvec/prometheus-canary
- Owner: catvec
- License: mit
- Created: 2020-08-20T14:10:18.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2021-05-24T19:07:19.000Z (almost 5 years ago)
- Last Synced: 2025-08-22T02:28:22.628Z (7 months ago)
- Language: Go
- Size: 3.91 KB
- Stars: 2
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Project status: On-hold
- Not usable yet, no releases
- Configuration file loading implemented
- Metric firing TODO
# Prometheus Canary
Intentionally trigger Prometheus alerts to test alerting.
# Table Of Contents
- [Overview](#overview)
- [Build](#build)
- [Release Checklist](#release-checklist)
# Overview
Publishes a single metric at a set interval. A Prometheus alert should be setup
to fire when this metric is found.
This can be used to test the entire Prometheus alert flow.
# Build
Golang application. Build with:
```
% go build .
```
# Release Checklist
To create a new release:
1. Push to master
2. Build the tool for Linux x86_64:
```
go build -o prometheus-canary-vmajor.minor.patch-linux-x86_64 .
```
3. Create a new GitHub release
1. Tag it `vmajor.minor.patch`
2. Name it `vmajor.minor.patch`
3. Have a description like so:
```
Short one sentence release description.
# Change log
- More detailed change log
# Files
| File | SHA256 Checksum |
| - | - |
| `prometheus-canary-vmajor.minor.patch-linux-x86_64` | `checksum` |
```