Pegel

Style guide: how our release notes look

Every element a release note, incident report or post here can use, written the way David and I write them.

David asked for one page that shows how everything looks before he writes the next incident report. This is it. Each heading names the element below it.

Heading level two

Release sections such as Added and Fixed, and the parts of an incident report. They fill the table of contents.

Heading level three

A step inside a section, such as one config key. Indented in the table of contents.

Heading level four

Rare. Used once, for the two kinds of probe token.

Heading level five

Not used yet.

Heading level six

Not used yet either, but it has a size.

Paragraph with inline formats

An alert fires when two probes agree, not one, and the PEGEL_CONFIG variable is gone. Write keys as interval = 60. The probe list is ordered, p95 stays under 70 ms from home, 24 checks a minute is our own load, and false alarms went from 121 to 1. More in why an alert needs two probes.

Bulleted list

  • One binary, no database server.
  • Configured in pegel.toml.
  • A release every few weeks, notes on this site.

Numbered list

  1. Stop Pegel.
  2. Multiply every interval by 60.
  3. Run pegel check, then start it again.

Blockquote

A monitor that cries wolf every night is a monitor nobody reads in the morning.

Aside quote

David’s rule for incident reports: the timeline first, the reasons second, names never.

Code block with a file name

func Down(results []probe.Result, agree int) bool {
	failed := 0
	for _, r := range results {
		if !r.OK {
			failed++
		}
	}
	return failed >= agree
}

Terminal

$ pegel version
pegel 0.9.0 linux/arm64
$ pegel check --config pegel.toml
ok  shop  200  41 ms  home + vps

Diff

 [defaults]
-interval = 1
+interval = 60

Marked, added and removed lines

[defaults]
interval = 60 # [!code highlight]
timeout = 30 # [!code --]
timeout = 10 # [!code ++]

Tabs

$ curl -LO https://pegel.example.org/download/pegel_0.9.1_linux_amd64.tar.gz
$ curl -LO https://pegel.example.org/download/pegel_0.9.1_linux_arm64.tar.gz
$ go install pegel.example.org/pegel/cmd/[email protected]

Long block, folded

[defaults]
interval = 60
timeout = 10
agree = 2

[notify]
mail = ["[email protected]"]
webhook = "https://hooks.example.com/pegel"

[status]
title = "Pegel status"
checks = ["site", "downloads"]

[[check]]
name = "site"
url = "https://pegel.example.org/"
expect = 200

[[check]]
name = "downloads"
url = "https://pegel.example.org/download/"
expect = 200

[[probe]]
name = "home"

[[probe]]
name = "vps"

Wrapped lines

[[check]]
name = "shop"
url = "https://shop.example.org/health?probe=pegel&expect=ok&region=nordtal&timeout=10s&verbose=false"

Code with a caption

$ pegel check --config pegel.toml
Run it before every restart. It reads the config, runs each check once and exits.

Horizontal rule

Separates a postscript from the release notes.


Image, regular width

An editor with pegel.toml: interval = 60 under defaults with the comment seconds since 0.9.0, agree = 2, a check named shop and two probes, home and vps.
Our own `pegel.toml`, shortened to one check.
A terminal where pegel check refuses interval = 1 on line 2 and suggests 60, then reports shop and docs as ok from home and vps.
The upgrade check. The image links to the release notes of v0.9.0.

Image, wide

A diagram: probe home and probe vps each report down to a box labelled agree?, which points to example.org.
Two probes, one decision.

Image, full width

Dark chart paper with the prompt ~/pegel $ and the line Release notes and incidents of a small uptime monitor.
The prompt this site is named after.

Callouts

Note, tip, warning and danger take the colours of the code. In a release note, the red one is the breaking change. The others follow Ghost’s callout colours.

ℹ️
agree defaults to 2 when there are two probes or more, and to 1 otherwise.
✅
Put the second probe on a different network from the first, or both will agree about the same broken router.
⚠️
Intervals below 10 seconds are refused. A site checked every second notices.
🛑
interval counts seconds since 0.9.0. Multiply every value by 60 before you upgrade.
📎
The upgrade steps are attached to the release notes of v0.9.0 as a text file.
🧾
Latency numbers are p95 over one day, from both probes.
🎂
Pegel’s first commit is three years old on 2026-12-01.
🧪
Two probes ran from a branch from July and on main from October before they shipped.
📬
Release notes go out by mail on the day of the release.

Toggle

Why Go?

One static binary per architecture, and a standard library that covers HTTP, TLS and timers. Pegel has four dependencies.

Does it need a database?

No. History is kept in files under /var/lib/pegel, 90 days by default.

Bookmark

pegel
A small self-hosted uptime monitor. One binary, one config file, checks from two places.
The repository, one tag per release.

A second bookmark

Pegel releases
Binaries for amd64 and arm64, with SHA256SUMS next to them.

Button

Button, centred

Header card

Pegel 0.9.0

Checks from two places. Alerts only when both agree.

Read the release notes

Header card, split with image

Maintenance windows

Planned downtime stops paging you in 0.8.0.

Read the release notes

Header card, centred

121 false alarms

From one probe, May to October. Two probes sent one.

Signup card

Call to action

SPONSORED

Pegel’s site, downloads and second probe cost 14 euros a month. Sponsors pay for them.

Sponsor Pegel

Call to action for members

Only members see the card under this heading. Sign in and it shows up here.

Product

The Raspberry Pi in the hallway

Four cores, 4 GB, a USB disk for the history. It runs Pegel for 40 sites at 23 MB of memory.

Read how it is set up

Audio

audio-thumbnail
The dashboard sound for a check that goes down
0:00
/4.1

Video

0:00
/0:05
pegel watch shop: one probe times out, then both.

Looping video

0:00
/0:08

File

Embed

pegel.example.org: all checks green for 17 days.

The status page, embedded.

HTML card with a table

ReleaseDate
v0.8.02026-08-24
v0.8.22026-10-05
v0.9.02026-11-09

Markdown card with a table

Command What it does
pegel check reads the config, runs each check once
pegel probe runs checks for another Pegel

Typesetting

The first paragraph of a post is set larger. These posts show the other variants:

Members pages

Readers who sign up meet four pages: Sign up, Sign in, Account and Pricing.

Comments

Buy Logbuch