blob: ed5e50a7541a05ee04acc0da6983369e3a087d99 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
|
# Gogios - Agent Guidelines
## Project Overview
Gogios is a lightweight, minimalistic monitoring tool written in Go. It executes Nagios/Icinga monitoring plugins and sends email notifications on status changes.
## Commands
### Build
```bash
mage build # Build the gogios binary
go build -o gogios cmd/gogios/main.go # Alternative without mage
```
### Development Build (with race detector)
```bash
mage dev # Runs vet + lint, then builds with -race
```
### Test
```bash
mage test # Run all unit tests (clears test cache first)
go test ./... # Alternative without mage
```
### Lint & Vet
```bash
mage vet # Run go vet
mage lint # Run golangci-lint
mage lintInstall # Install golangci-lint
```
### Cross-compile for OpenBSD
```bash
mage openbsd # Build and deploy for OpenBSD
mage buildOpenbsd # Build only
```
## Project Structure
```
cmd/gogios/ # Main entry point
internal/ # Core implementation
check.go # Check execution logic
config.go # Configuration parsing
dependency.go # Check dependency handling
federated.go # Federated monitoring
html.go # HTML report generation
nagioscode.go # Nagios exit code handling
notify.go # Email notification
run.go # Main run logic
runchecks.go # Check orchestration
state.go # State persistence
```
## Code Conventions
- Go 1.24+
- Use standard Go formatting (`gofmt`)
- Tests use the standard `testing` package with `*_test.go` suffix
- Internal packages under `internal/` are not exported
- Module path: `codeberg.org/snonux/gogios`
## Testing
Tests exist in `internal/` with the `*_test.go` naming convention:
- `federated_test.go`
- `html_test.go`
- `state_test.go`
Run tests before committing changes.
For best practices also follow ~/git/conf/snippets/go/go-projects/go-projects.md if present.
|
