@glassmkr/crucible 0.9.4 → 0.10.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +18 -18
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
[](https://www.npmjs.com/package/@glassmkr/crucible)
|
|
5
5
|
|
|
6
6
|
<!-- Canonical rule count: see RULES_COUNT.md in the Glassmkr monorepo. -->
|
|
7
|
-
Lightweight bare metal server monitoring agent. Collects hardware and OS health every 5 minutes and pushes snapshots to a [
|
|
7
|
+
Lightweight bare metal server monitoring agent. Collects hardware and OS health every 5 minutes and pushes snapshots to a [Dashboard](https://app.glassmkr.com) dashboard, which evaluates 38 alert rules and sends notifications.
|
|
8
8
|
|
|
9
9
|
Open source. MIT licensed. Built by [Glassmkr](https://glassmkr.com). See also [Bench](https://github.com/glassmkr/bench), the MCP server collection.
|
|
10
10
|
|
|
@@ -14,7 +14,7 @@ Open source. MIT licensed. Built by [Glassmkr](https://glassmkr.com). See also [
|
|
|
14
14
|
|
|
15
15
|
## Screenshots
|
|
16
16
|
|
|
17
|
-

|
|
18
18
|
*Alerts grouped by server, with AI-generated fix commands for each rule.*
|
|
19
19
|
|
|
20
20
|

|
|
@@ -31,7 +31,7 @@ agent, and runs `glassmkr-crucible init` to validate your key, write
|
|
|
31
31
|
service.
|
|
32
32
|
|
|
33
33
|
```bash
|
|
34
|
-
curl -sf https://
|
|
34
|
+
curl -sf https://app.glassmkr.com/install | bash -s -- --api-key gmk_cru_live_<your-key>
|
|
35
35
|
```
|
|
36
36
|
|
|
37
37
|
Or run the steps yourself:
|
|
@@ -52,16 +52,16 @@ Run `glassmkr-crucible init --help` for the full flag list.
|
|
|
52
52
|
# Create config directory
|
|
53
53
|
sudo mkdir -p /etc/glassmkr
|
|
54
54
|
|
|
55
|
-
# Create config (replace with your
|
|
55
|
+
# Create config (replace with your Dashboard credentials)
|
|
56
56
|
sudo tee /etc/glassmkr/collector.yaml << 'EOF'
|
|
57
57
|
server_name: "web-01"
|
|
58
58
|
collection:
|
|
59
59
|
interval_seconds: 300
|
|
60
60
|
ipmi: true
|
|
61
61
|
smart: true
|
|
62
|
-
|
|
62
|
+
dashboard:
|
|
63
63
|
enabled: true
|
|
64
|
-
url: "https://
|
|
64
|
+
url: "https://app.glassmkr.com"
|
|
65
65
|
api_key: "col_YOUR_KEY_HERE"
|
|
66
66
|
EOF
|
|
67
67
|
|
|
@@ -77,7 +77,7 @@ Images are published to [ghcr.io/glassmkr/crucible](https://github.com/glassmkr/
|
|
|
77
77
|
|
|
78
78
|
## Quick Start
|
|
79
79
|
|
|
80
|
-
1. Create an API key in the
|
|
80
|
+
1. Create an API key in the Dashboard dashboard (Servers → Add server).
|
|
81
81
|
2. Run `init`:
|
|
82
82
|
|
|
83
83
|
```bash
|
|
@@ -90,7 +90,7 @@ Images are published to [ghcr.io/glassmkr/crucible](https://github.com/glassmkr/
|
|
|
90
90
|
you want to inspect the unit before enabling it. Pass `--api-key -`
|
|
91
91
|
to read the key from stdin (handy for password-manager pipes).
|
|
92
92
|
|
|
93
|
-
Snapshots appear in the
|
|
93
|
+
Snapshots appear in the Dashboard dashboard within seconds of the first
|
|
94
94
|
push.
|
|
95
95
|
|
|
96
96
|
If you can't or won't run `init` (config-management is doing it for
|
|
@@ -123,9 +123,9 @@ collection:
|
|
|
123
123
|
interval_seconds: 300
|
|
124
124
|
ipmi: true
|
|
125
125
|
smart: true
|
|
126
|
-
|
|
126
|
+
dashboard:
|
|
127
127
|
enabled: true
|
|
128
|
-
url: "https://
|
|
128
|
+
url: "https://app.glassmkr.com"
|
|
129
129
|
api_key: "gmk_cru_live_<...>_<4>"
|
|
130
130
|
```
|
|
131
131
|
|
|
@@ -163,7 +163,7 @@ sudo glassmkr-crucible mark-reboot --reason "kernel update"
|
|
|
163
163
|
sudo reboot
|
|
164
164
|
```
|
|
165
165
|
|
|
166
|
-
Both write a short-lived marker to `/var/lib/crucible/reboot-expected`. The agent reads it once on startup, sets `expected_reboot: true` on the first post-boot snapshot, and deletes the file.
|
|
166
|
+
Both write a short-lived marker to `/var/lib/crucible/reboot-expected`. The agent reads it once on startup, sets `expected_reboot: true` on the first post-boot snapshot, and deletes the file. Dashboard reads that flag and suppresses the `server_rebooted_unexpectedly` alert for that boot only.
|
|
167
167
|
|
|
168
168
|
The marker is single-use and expires 10 minutes after it is written (override with `--ttl 5m` / `--ttl 1h`), so a forgotten marker cannot silence a genuine crash reboot next week. If systemd fails to reboot the host, the marker simply expires on its own.
|
|
169
169
|
|
|
@@ -216,7 +216,7 @@ sudo systemctl status glassmkr-crucible
|
|
|
216
216
|
|
|
217
217
|
If you ever upgrade `@glassmkr/crucible` and the binary moves (rare, but
|
|
218
218
|
possible on a distro change), re-run the `command -v` step and update the
|
|
219
|
-
unit file. The bootstrap script at `https://
|
|
219
|
+
unit file. The bootstrap script at `https://app.glassmkr.com/install` does
|
|
220
220
|
this detection automatically; the manual flow above is just the equivalent.
|
|
221
221
|
|
|
222
222
|
## What It Collects
|
|
@@ -239,7 +239,7 @@ this detection automatically; the manual flow above is just the equivalent.
|
|
|
239
239
|
| File descriptors | System-wide allocation |
|
|
240
240
|
|
|
241
241
|
<!-- Canonical rule count: see RULES_COUNT.md in the Glassmkr monorepo. -->
|
|
242
|
-
|
|
242
|
+
Dashboard evaluates 38 alert rules server-side across OS, Storage, Network, Hardware, ZFS, Security, and Service Health, with priorities P1 Urgent through P4 Low. Full list: [app.glassmkr.com/docs/alerts](https://app.glassmkr.com/docs/alerts).
|
|
243
243
|
|
|
244
244
|
## Requirements
|
|
245
245
|
|
|
@@ -250,11 +250,11 @@ Forge evaluates 38 alert rules server-side across OS, Storage, Network, Hardware
|
|
|
250
250
|
|
|
251
251
|
## Documentation
|
|
252
252
|
|
|
253
|
-
- [Getting Started](https://
|
|
254
|
-
- [Configuration Reference](https://
|
|
255
|
-
- [Alert Rules (38)](https://
|
|
256
|
-
- [Troubleshooting](https://
|
|
257
|
-
- [API Reference](https://
|
|
253
|
+
- [Getting Started](https://app.glassmkr.com/docs/getting-started)
|
|
254
|
+
- [Configuration Reference](https://app.glassmkr.com/docs/configuration)
|
|
255
|
+
- [Alert Rules (38)](https://app.glassmkr.com/docs/alerts)
|
|
256
|
+
- [Troubleshooting](https://app.glassmkr.com/docs/troubleshooting)
|
|
257
|
+
- [API Reference](https://app.glassmkr.com/docs/api)
|
|
258
258
|
|
|
259
259
|
## License
|
|
260
260
|
|