Compare commits

...

12 Commits

Author SHA1 Message Date
Henry Dollman
76cfaaa179 0.0.1-alpha.8 2024-07-23 20:09:50 -04:00
Henry Dollman
b89bec31b5 add check for no records 2024-07-23 20:09:09 -04:00
Henry Dollman
0355d9c654 refactoring agent 2024-07-23 20:07:46 -04:00
Henry Dollman
41df7b7392 update agent to use short container id 2024-07-23 19:51:35 -04:00
Henry Dollman
52c77dd361 readme / site style updates 2024-07-23 18:51:49 -04:00
Henry Dollman
ae0f5c938f 0.0.1-alpha.7 2024-07-23 15:47:45 -04:00
Henry Dollman
78dc269538 update logic for batch updating servers 2024-07-23 15:47:15 -04:00
Henry Dollman
f6967eab35 update gitignore / readme 2024-07-23 15:43:26 -04:00
Henry Dollman
e787b6ea1b update docker compose to make docker sock read only 2024-07-23 15:21:03 -04:00
Henry Dollman
844b95dfd0 get container stats synchronously 2024-07-23 15:19:04 -04:00
Henry Dollman
c5776541a0 style / chart axis updates 2024-07-23 14:48:33 -04:00
Henry Dollman
5ba7568acf update readme 2024-07-22 19:01:05 -04:00
13 changed files with 185 additions and 150 deletions

1
.gitignore vendored
View File

@@ -6,4 +6,5 @@ temp
beszel beszel
beszel-agent beszel-agent
beszel_data beszel_data
beszel_data*
dist dist

View File

@@ -5,7 +5,7 @@ services:
restart: unless-stopped restart: unless-stopped
network_mode: host network_mode: host
volumes: volumes:
- /var/run/docker.sock:/var/run/docker.sock - /var/run/docker.sock:/var/run/docker.sock:ro
environment: environment:
PORT: 45876 PORT: 45876
KEY: 'ssh-ed25519 YOUR_PUBLIC_KEY' KEY: 'ssh-ed25519 YOUR_PUBLIC_KEY'

View File

@@ -2,7 +2,6 @@ package main
import ( import (
"encoding/json" "encoding/json"
"errors"
"fmt" "fmt"
"io" "io"
"log" "log"
@@ -11,7 +10,6 @@ import (
"net/http" "net/http"
"os" "os"
"strings" "strings"
"sync"
"time" "time"
sshServer "github.com/gliderlabs/ssh" sshServer "github.com/gliderlabs/ssh"
@@ -23,10 +21,11 @@ import (
psutilNet "github.com/shirou/gopsutil/v4/net" psutilNet "github.com/shirou/gopsutil/v4/net"
) )
var Version = "0.0.1-alpha.6" var Version = "0.0.1-alpha.8"
var containerCpuMap = make(map[string][2]uint64) var containerCpuMap = make(map[string][2]uint64)
var containerCpuMutex = &sync.Mutex{}
// var containerCpuMutex = &sync.Mutex{}
var diskIoStats = DiskIoStats{ var diskIoStats = DiskIoStats{
Read: 0, Read: 0,
@@ -44,59 +43,20 @@ var netIoStats = NetIoStats{
// client for docker engine api // client for docker engine api
var client = &http.Client{ var client = &http.Client{
Timeout: time.Second * 5, Timeout: time.Second,
Transport: &http.Transport{ Transport: &http.Transport{
Dial: func(proto, addr string) (net.Conn, error) { Dial: func(proto, addr string) (net.Conn, error) {
return net.Dial("unix", "/var/run/docker.sock") return net.Dial("unix", "/var/run/docker.sock")
}, },
ForceAttemptHTTP2: false, ForceAttemptHTTP2: false,
MaxIdleConns: 100, IdleConnTimeout: 90 * time.Second,
MaxIdleConnsPerHost: 100, DisableCompression: true,
IdleConnTimeout: 90 * time.Second, MaxIdleConns: 10,
DisableKeepAlives: false, DisableKeepAlives: false,
}, },
} }
type SystemData struct { func getSystemStats() (*SystemInfo, *SystemStats) {
Stats SystemStats `json:"stats"`
Info SystemInfo `json:"info"`
Containers []ContainerStats `json:"container"`
}
type SystemInfo struct {
Cores int `json:"c"`
Threads int `json:"t"`
CpuModel string `json:"m"`
// Os string `json:"o"`
Uptime uint64 `json:"u"`
Cpu float64 `json:"cpu"`
MemPct float64 `json:"mp"`
DiskPct float64 `json:"dp"`
}
type SystemStats struct {
Cpu float64 `json:"cpu"`
Mem float64 `json:"m"`
MemUsed float64 `json:"mu"`
MemPct float64 `json:"mp"`
MemBuffCache float64 `json:"mb"`
Disk float64 `json:"d"`
DiskUsed float64 `json:"du"`
DiskPct float64 `json:"dp"`
DiskRead float64 `json:"dr"`
DiskWrite float64 `json:"dw"`
NetworkSent float64 `json:"ns"`
NetworkRecv float64 `json:"nr"`
}
type ContainerStats struct {
Name string `json:"n"`
Cpu float64 `json:"c"`
Mem float64 `json:"m"`
// MemPct float64 `json:"mp"`
}
func getSystemStats() (SystemInfo, SystemStats) {
c, _ := cpu.Percent(0, false) c, _ := cpu.Percent(0, false)
v, _ := mem.VirtualMemory() v, _ := mem.VirtualMemory()
d, _ := disk.Usage("/") d, _ := disk.Usage("/")
@@ -105,7 +65,7 @@ func getSystemStats() (SystemInfo, SystemStats) {
memPct := twoDecimals(v.UsedPercent) memPct := twoDecimals(v.UsedPercent)
diskPct := twoDecimals(d.UsedPercent) diskPct := twoDecimals(d.UsedPercent)
systemStats := SystemStats{ systemStats := &SystemStats{
Cpu: cpuPct, Cpu: cpuPct,
Mem: bytesToGigabytes(v.Total), Mem: bytesToGigabytes(v.Total),
MemUsed: bytesToGigabytes(v.Used), MemUsed: bytesToGigabytes(v.Used),
@@ -116,7 +76,7 @@ func getSystemStats() (SystemInfo, SystemStats) {
DiskPct: diskPct, DiskPct: diskPct,
} }
systemInfo := SystemInfo{ systemInfo := &SystemInfo{
Cpu: cpuPct, Cpu: cpuPct,
MemPct: memPct, MemPct: memPct,
DiskPct: diskPct, DiskPct: diskPct,
@@ -182,54 +142,52 @@ func getSystemStats() (SystemInfo, SystemStats) {
} }
func getDockerStats() ([]ContainerStats, error) { func getDockerStats() ([]*ContainerStats, error) {
resp, err := client.Get("http://localhost/containers/json") resp, err := client.Get("http://localhost/containers/json")
if err != nil { if err != nil {
return []ContainerStats{}, err return []*ContainerStats{}, err
} }
defer resp.Body.Close() defer resp.Body.Close()
var containers []Container var containers []*Container
if err := json.NewDecoder(resp.Body).Decode(&containers); err != nil { if err := json.NewDecoder(resp.Body).Decode(&containers); err != nil {
panic(err) panic(err)
} }
var wg sync.WaitGroup containerStats := make([]*ContainerStats, 0, len(containers))
var containerStats []ContainerStats
for _, ctr := range containers { for _, ctr := range containers {
wg.Add(1) ctr.IdShort = ctr.ID[:12]
go func() { cstats, err := getContainerStats(ctr)
defer wg.Done() if err != nil {
cstats, err := getContainerStats(ctr) // retry once
cstats, err = getContainerStats(ctr)
if err != nil { if err != nil {
log.Printf("Error getting container stats: %+v\n", err) log.Printf("Error getting container stats: %+v\n", err)
return continue
} }
containerStats = append(containerStats, cstats) }
}() containerStats = append(containerStats, cstats)
} }
// clean up old containers from map // clean up old container ids from map
validNames := make(map[string]struct{}, len(containers)) validIds := make(map[string]struct{}, len(containers))
for _, ctr := range containers { for _, ctr := range containers {
validNames[ctr.Names[0][1:]] = struct{}{} validIds[ctr.IdShort] = struct{}{}
} }
for name := range containerCpuMap { for id := range containerCpuMap {
if _, exists := validNames[name]; !exists { if _, exists := validIds[id]; !exists {
delete(containerCpuMap, name) delete(containerCpuMap, id)
} }
} }
wg.Wait()
return containerStats, nil return containerStats, nil
} }
func getContainerStats(ctr Container) (ContainerStats, error) { func getContainerStats(ctr *Container) (*ContainerStats, error) {
resp, err := client.Get("http://localhost/containers/" + ctr.ID + "/stats?stream=0&one-shot=1") resp, err := client.Get("http://localhost/containers/" + ctr.IdShort + "/stats?stream=0&one-shot=1")
if err != nil { if err != nil {
return ContainerStats{}, err return &ContainerStats{}, err
} }
defer resp.Body.Close() defer resp.Body.Close()
@@ -246,20 +204,20 @@ func getContainerStats(ctr Container) (ContainerStats, error) {
// cpu // cpu
// add default values to containerCpu if it doesn't exist // add default values to containerCpu if it doesn't exist
containerCpuMutex.Lock() // containerCpuMutex.Lock()
defer containerCpuMutex.Unlock() // defer containerCpuMutex.Unlock()
if _, ok := containerCpuMap[name]; !ok { if _, ok := containerCpuMap[ctr.IdShort]; !ok {
containerCpuMap[name] = [2]uint64{0, 0} containerCpuMap[ctr.IdShort] = [2]uint64{0, 0}
} }
cpuDelta := statsJson.CPUStats.CPUUsage.TotalUsage - containerCpuMap[name][0] cpuDelta := statsJson.CPUStats.CPUUsage.TotalUsage - containerCpuMap[ctr.IdShort][0]
systemDelta := statsJson.CPUStats.SystemUsage - containerCpuMap[name][1] systemDelta := statsJson.CPUStats.SystemUsage - containerCpuMap[ctr.IdShort][1]
cpuPct := float64(cpuDelta) / float64(systemDelta) * 100 cpuPct := float64(cpuDelta) / float64(systemDelta) * 100
if cpuPct > 100 { if cpuPct > 100 {
return ContainerStats{}, errors.New("cpu pct is greater than 100") return &ContainerStats{}, fmt.Errorf("%s cpu pct greater than 100: %+v", name, cpuPct)
} }
containerCpuMap[name] = [2]uint64{statsJson.CPUStats.CPUUsage.TotalUsage, statsJson.CPUStats.SystemUsage} containerCpuMap[ctr.IdShort] = [2]uint64{statsJson.CPUStats.CPUUsage.TotalUsage, statsJson.CPUStats.SystemUsage}
cStats := ContainerStats{ cStats := &ContainerStats{
Name: name, Name: name,
Cpu: twoDecimals(cpuPct), Cpu: twoDecimals(cpuPct),
Mem: bytesToMegabytes(float64(usedMemory)), Mem: bytesToMegabytes(float64(usedMemory)),
@@ -268,12 +226,12 @@ func getContainerStats(ctr Container) (ContainerStats, error) {
return cStats, nil return cStats, nil
} }
func gatherStats() SystemData { func gatherStats() *SystemData {
systemInfo, systemStats := getSystemStats() systemInfo, systemStats := getSystemStats()
stats := SystemData{ stats := &SystemData{
Stats: systemStats, Stats: systemStats,
Info: systemInfo, Info: systemInfo,
Containers: []ContainerStats{}, Containers: []*ContainerStats{},
} }
containerStats, err := getDockerStats() containerStats, err := getDockerStats()
if err == nil { if err == nil {

View File

@@ -2,8 +2,48 @@ package main
import "time" import "time"
type SystemData struct {
Stats *SystemStats `json:"stats"`
Info *SystemInfo `json:"info"`
Containers []*ContainerStats `json:"container"`
}
type SystemInfo struct {
Cores int `json:"c"`
Threads int `json:"t"`
CpuModel string `json:"m"`
// Os string `json:"o"`
Uptime uint64 `json:"u"`
Cpu float64 `json:"cpu"`
MemPct float64 `json:"mp"`
DiskPct float64 `json:"dp"`
}
type SystemStats struct {
Cpu float64 `json:"cpu"`
Mem float64 `json:"m"`
MemUsed float64 `json:"mu"`
MemPct float64 `json:"mp"`
MemBuffCache float64 `json:"mb"`
Disk float64 `json:"d"`
DiskUsed float64 `json:"du"`
DiskPct float64 `json:"dp"`
DiskRead float64 `json:"dr"`
DiskWrite float64 `json:"dw"`
NetworkSent float64 `json:"ns"`
NetworkRecv float64 `json:"nr"`
}
type ContainerStats struct {
Name string `json:"n"`
Cpu float64 `json:"c"`
Mem float64 `json:"m"`
// MemPct float64 `json:"mp"`
}
type Container struct { type Container struct {
ID string `json:"Id"` ID string `json:"Id"`
IdShort string
Names []string Names []string
Image string Image string
ImageID string ImageID string

View File

@@ -15,24 +15,26 @@ import (
"net/url" "net/url"
"os" "os"
"strings" "strings"
"sync"
"time" "time"
"github.com/labstack/echo/v5" "github.com/labstack/echo/v5"
"github.com/pocketbase/dbx"
"github.com/pocketbase/pocketbase" "github.com/pocketbase/pocketbase"
"github.com/pocketbase/pocketbase/apis" "github.com/pocketbase/pocketbase/apis"
"github.com/pocketbase/pocketbase/core" "github.com/pocketbase/pocketbase/core"
"github.com/pocketbase/pocketbase/models" "github.com/pocketbase/pocketbase/models"
"github.com/pocketbase/pocketbase/plugins/migratecmd" "github.com/pocketbase/pocketbase/plugins/migratecmd"
"github.com/pocketbase/pocketbase/tools/cron" "github.com/pocketbase/pocketbase/tools/cron"
"github.com/pocketbase/pocketbase/tools/types"
"github.com/spf13/cobra" "github.com/spf13/cobra"
"golang.org/x/crypto/ssh" "golang.org/x/crypto/ssh"
) )
var Version = "0.0.1-alpha.6" var Version = "0.0.1-alpha.8"
var app *pocketbase.PocketBase var app *pocketbase.PocketBase
var serverConnections = make(map[string]Server) var serverConnections = make(map[string]*Server)
var serverConnectionsLock = sync.Mutex{}
func main() { func main() {
app = pocketbase.NewWithConfig(pocketbase.Config{ app = pocketbase.NewWithConfig(pocketbase.Config{
@@ -207,49 +209,53 @@ func startSystemUpdateTicker() {
} }
func updateSystems() { func updateSystems() {
// handle max of 1/3 + 1 servers at a time
numServers := len(serverConnections)/3 + 1
// find systems that are not paused and updated more than 58 seconds ago
fiftyEightSecondsAgo := time.Now().UTC().Add(-58 * time.Second).Format("2006-01-02 15:04:05")
records, err := app.Dao().FindRecordsByFilter( records, err := app.Dao().FindRecordsByFilter(
"2hz5ncl8tizk5nx", // collection "2hz5ncl8tizk5nx", // collection
"status != 'paused' && updated < {:updated}", // filter "status != 'paused'", // filter
"updated", // sort "updated", // sort
numServers, // limit -1, // limit
0, // offset 0, // offset
dbx.Params{"updated": fiftyEightSecondsAgo},
) )
if err != nil { // log.Println("records", len(records))
app.Logger().Error("Failed to query systems: ", "err", err.Error()) if err != nil || len(records) == 0 {
// app.Logger().Error("Failed to query systems")
return return
} }
for _, record := range records { fiftyFiveSecondsAgo := time.Now().UTC().Add(-55 * time.Second)
updateSystem(record) batchSize := len(records)/4 + 1
for i := 0; i < batchSize; i++ {
if records[i].Get("updated").(types.DateTime).Time().After(fiftyFiveSecondsAgo) {
break
}
// log.Println("updating", records[i].Get(("name")))
go updateSystem(records[i])
} }
} }
func updateSystem(record *models.Record) { func updateSystem(record *models.Record) {
var server Server var server *Server
// check if server connection data exists // check if server connection data exists
if _, ok := serverConnections[record.Id]; ok { if _, ok := serverConnections[record.Id]; ok {
server = serverConnections[record.Id] server = serverConnections[record.Id]
} else { } else {
// create server connection struct // create server connection struct
server = Server{ server = &Server{
Host: record.Get("host").(string), Host: record.Get("host").(string),
Port: record.Get("port").(string), Port: record.Get("port").(string),
} }
client, err := getServerConnection(&server) client, err := getServerConnection(server)
if err != nil { if err != nil {
app.Logger().Error("Failed to connect:", "err", err.Error(), "server", server.Host, "port", server.Port) app.Logger().Error("Failed to connect:", "err", err.Error(), "server", server.Host, "port", server.Port)
updateServerStatus(record, "down") updateServerStatus(record, "down")
return return
} }
server.Client = client server.Client = client
serverConnectionsLock.Lock()
serverConnections[record.Id] = server serverConnections[record.Id] = server
serverConnectionsLock.Unlock()
} }
// get server stats from agent // get server stats from agent
systemData, err := requestJson(&server) systemData, err := requestJson(server)
if err != nil { if err != nil {
if err.Error() == "retry" { if err.Error() == "retry" {
// if previous connection was closed, try again // if previous connection was closed, try again
@@ -310,6 +316,8 @@ func deleteServerConnection(record *models.Record) {
if serverConnections[record.Id].Client != nil { if serverConnections[record.Id].Client != nil {
serverConnections[record.Id].Client.Close() serverConnections[record.Id].Client.Close()
} }
serverConnectionsLock.Lock()
defer serverConnectionsLock.Unlock()
delete(serverConnections, record.Id) delete(serverConnections, record.Id)
} }
} }

View File

@@ -32,7 +32,7 @@ export function AddSystemButton() {
restart: unless-stopped restart: unless-stopped
network_mode: host network_mode: host
volumes: volumes:
- /var/run/docker.sock:/var/run/docker.sock - /var/run/docker.sock:/var/run/docker.sock:ro
environment: environment:
PORT: ${port} PORT: ${port}
KEY: "${publicKey}" KEY: "${publicKey}"

View File

@@ -47,7 +47,13 @@ export default function BandwidthChart({
<YAxis <YAxis
className="tracking-tighter" className="tracking-tighter"
width={75} width={75}
domain={[0, (max: number) => (max < 0.4 ? 0.4 : Math.ceil(max))]} domain={[0, (max: number) => (max <= 0.4 ? 0.4 : Math.ceil(max))]}
tickFormatter={(value) => {
if (value >= 100) {
return value.toFixed(0)
}
return value.toFixed((value * 100) % 1 === 0 ? 1 : 2)
}}
tickLine={false} tickLine={false}
axisLine={false} axisLine={false}
unit={' MB/s'} unit={' MB/s'}
@@ -66,7 +72,8 @@ export default function BandwidthChart({
tickFormatter={hourWithMinutes} tickFormatter={hourWithMinutes}
/> />
<ChartTooltip <ChartTooltip
// cursor={false} animationEasing="ease-out"
animationDuration={150}
content={ content={
<ChartTooltipContent <ChartTooltipContent
unit=" MB/s" unit=" MB/s"

View File

@@ -69,7 +69,7 @@ export default function ContainerCpuChart({
> >
<CartesianGrid vertical={false} /> <CartesianGrid vertical={false} />
<YAxis <YAxis
domain={[0, (max: number) => Math.max(Math.ceil(max), 0.4)]} // domain={[0, (max: number) => Math.max(Math.ceil(max), 0.4)]}
width={47} width={47}
tickLine={false} tickLine={false}
axisLine={false} axisLine={false}

View File

@@ -77,7 +77,8 @@ export default function DiskChart({
tickFormatter={hourWithMinutes} tickFormatter={hourWithMinutes}
/> />
<ChartTooltip <ChartTooltip
// cursor={false} animationEasing="ease-out"
animationDuration={150}
content={ content={
<ChartTooltipContent <ChartTooltipContent
unit=" GB" unit=" GB"

View File

@@ -47,7 +47,7 @@ export default function DiskIoChart({
<YAxis <YAxis
className="tracking-tighter" className="tracking-tighter"
width={75} width={75}
domain={[0, (max: number) => (max < 0.4 ? 0.4 : Math.ceil(max))]} domain={[0, (max: number) => (max <= 0.4 ? 0.4 : Math.ceil(max))]}
tickFormatter={(value) => { tickFormatter={(value) => {
if (value >= 100) { if (value >= 100) {
return value.toFixed(0) return value.toFixed(0)
@@ -72,7 +72,8 @@ export default function DiskIoChart({
tickFormatter={hourWithMinutes} tickFormatter={hourWithMinutes}
/> />
<ChartTooltip <ChartTooltip
// cursor={false} animationEasing="ease-out"
animationDuration={150}
content={ content={
<ChartTooltipContent <ChartTooltipContent
unit=" MB/s" unit=" MB/s"

View File

@@ -304,7 +304,7 @@ export default function SystemsTable() {
? 'auto' ? 'auto'
: cell.column.getSize(), : cell.column.getSize(),
}} }}
className={'overflow-hidden relative py-3'} className={'overflow-hidden relative py-2.5'}
> >
{flexRender(cell.column.columnDef.cell, cell.getContext())} {flexRender(cell.column.columnDef.cell, cell.getContext())}
</TableCell> </TableCell>

View File

@@ -71,21 +71,21 @@ export default function AlertsButton({ system }: { system: SystemRecord }) {
system={system} system={system}
alerts={systemAlerts} alerts={systemAlerts}
name="CPU" name="CPU"
title="CPU usage" title="CPU Usage"
description="Triggers when CPU usage exceeds a threshold." description="Triggers when CPU usage exceeds a threshold."
/> />
<AlertWithSlider <AlertWithSlider
system={system} system={system}
alerts={systemAlerts} alerts={systemAlerts}
name="Memory" name="Memory"
title="Memory usage" title="Memory Usage"
description="Triggers when memory usage exceeds a threshold." description="Triggers when memory usage exceeds a threshold."
/> />
<AlertWithSlider <AlertWithSlider
system={system} system={system}
alerts={systemAlerts} alerts={systemAlerts}
name="Disk" name="Disk"
title="Disk usage" title="Disk Usage"
description="Triggers when disk usage exceeds a threshold." description="Triggers when disk usage exceeds a threshold."
/> />
</div> </div>
@@ -104,11 +104,11 @@ function AlertStatus({ system, alerts }: { system: SystemRecord; alerts: AlertRe
return ( return (
<label <label
htmlFor="alert-status" htmlFor="alert-status"
className="space-y-2 flex flex-row items-center justify-between rounded-lg border p-4 cursor-pointer" className="flex flex-row items-center justify-between gap-4 rounded-lg border p-4 cursor-pointer"
> >
<div className="grid gap-0.5 select-none"> <div className="grid gap-1 select-none">
<p className="font-medium text-[1.05em]">System status</p> <p className="font-semibold">System Status</p>
<span className="block text-[0.85em] text-foreground opacity-80"> <span className="block text-sm text-foreground opacity-80">
Triggers when status switches between up and down. Triggers when status switches between up and down.
</span> </span>
</div> </div>
@@ -171,13 +171,13 @@ function AlertWithSlider({
<div className="rounded-lg border"> <div className="rounded-lg border">
<label <label
htmlFor={`alert-${name}`} htmlFor={`alert-${name}`}
className={cn('space-y-2 flex flex-row items-center justify-between cursor-pointer p-4', { className={cn('flex flex-row items-center justify-between gap-4 cursor-pointer p-4', {
'pb-0': !!alert, 'pb-0': !!alert,
})} })}
> >
<div className="grid gap-0.5 select-none"> <div className="grid gap-1 select-none">
<p className="font-medium text-[1.05em]">{title}</p> <p className="font-semibold">{title}</p>
<span className="block text-[0.85em] text-foreground opacity-80">{description}</span> <span className="block text-sm text-foreground opacity-80">{description}</span>
</div> </div>
<Switch <Switch
id={`alert-${name}`} id={`alert-${name}`}

View File

@@ -1,28 +1,22 @@
# Beszel \*WIP\* # Beszel
A lightweight server resource monitoring hub with historical data, docker stats, and alerts. A lightweight server resource monitoring hub with historical data, docker stats, and alerts.
<!-- <table width="100%"> [![Docker Image Size (tag)](https://img.shields.io/docker/image-size/henrygd/beszel-agent/0.0.1-alpha.6?logo=docker&label=agent%20image%20size)](https://hub.docker.com/r/henrygd/beszel-agent)
<tbody> [![Docker Image Size (tag)](https://img.shields.io/docker/image-size/henrygd/beszel/0.0.1-alpha.6?logo=docker&label=hub%20image%20size)](https://hub.docker.com/r/henrygd/beszel)
<tr>
<td width="50%"><img src="https://henrygd-assets.b-cdn.net/social-image-server/before-capture.png" alt="example of turso.tech/pricing link which is missing an og:image as of may 11 2024"/></td>
<td width="50%"><img src="https://henrygd-assets.b-cdn.net/social-image-server/after-capture.webp" alt="example of turso.tech/pricing link using an image generated by the server as it's og:image"/></td>
</tr>
</tbody>
</table> -->
<!-- ## Features ![Screenshot of the hub](https://henrygd-assets.b-cdn.net/beszel/screenshot.png)
## Features
- **Lightweight**: Much smaller and less demanding than leading solutions. - **Lightweight**: Much smaller and less demanding than leading solutions.
- **Historical data**: Stats are available for up to 30 days.
- **Docker stats**: CPU and memory usage history for each container. - **Docker stats**: CPU and memory usage history for each container.
- **Alerts**: Lorem ipsum dolor sit amet, consectetur adipiscing elit. - **Alerts**: Configurable alerts for CPU, memory, and disk usage, and system status.
- **Simple**: Lorem ipsum dolor sit amet, consectetur adipiscing elit.
- **Multi-user**: Each user has their own systems. Admins can share systems across users. - **Multi-user**: Each user has their own systems. Admins can share systems across users.
- **Secure**: Lorem ipsum dolor sit amet, consectetur adipiscing elit. - **Simple**: Easy setup and doesn't require anything to be publicly available online.
- **Oauth / OIDC**: Supports many OAuth2 providers and password auth can be disabled. - **OAuth / OIDC**: Supports many OAuth2 providers. Password auth can be disabled.
- **Automated backups**: Automatically back up your data to S3-compatible storage. - **Automated backups**: Automatically back up your data to disk or S3-compatible storage.
- **Open source**: MIT license and no paywalled features. --> - **REST API**: Use your metrics in your own scripts and applications.
## Introduction ## Introduction
@@ -32,9 +26,6 @@ The hub is a web application that provides a dashboard to view and manage your c
The agent runs on each system you want to monitor. It creates a minimal SSH server through which it communicates system metrics to the hub. The agent runs on each system you want to monitor. It creates a minimal SSH server through which it communicates system metrics to the hub.
[![Docker Image Size (tag)](https://img.shields.io/docker/image-size/henrygd/beszel-agent/0.0.1-alpha.3?logo=docker&label=agent%20image%20size)](https://hub.docker.com/r/henrygd/beszel-agent)
[![Docker Image Size (tag)](https://img.shields.io/docker/image-size/henrygd/beszel/0.0.1-alpha.3?logo=docker&label=hub%20image%20size)](https://hub.docker.com/r/henrygd/beszel)
## Getting started ## Getting started
If using the binary instead of docker, ignore 4-5 and run the agent using the binary instead. If using the binary instead of docker, ignore 4-5 and run the agent using the binary instead.
@@ -104,8 +95,9 @@ Use `beszel update` and `beszel-agent update` to update to the latest version.
Beszel supports OpenID Connect and many OAuth2 authentication providers (see list below). To enable, do the following: Beszel supports OpenID Connect and many OAuth2 authentication providers (see list below). To enable, do the following:
1. Create an OAuth2 application using your provider of choice. The redirect / callback URL should be `<your-beszel-url>/api/oauth2-redirect`. 1. Make sure your "Application URL" is set correctly in the PocketBase settings.
2. When you have the client ID and secret, go to the "Auth providers" page and enable your provider. 2. Create an OAuth2 application using your provider of choice. The redirect / callback URL should be `<your-beszel-url>/api/oauth2-redirect`.
3. When you have the client ID and secret, go to the "Auth providers" page and enable your provider.
<details> <details>
<summary>Supported provider list</summary> <summary>Supported provider list</summary>
@@ -146,6 +138,24 @@ When the hub is started for the first time, it generates an ED25519 key pair.
The agent's SSH server is configured to accept connections only using this key. It does not provide a pty or accept any input, so it is not possible to execute commands on the agent even if your private key is compromised. The agent's SSH server is configured to accept connections only using this key. It does not provide a pty or accept any input, so it is not possible to execute commands on the agent even if your private key is compromised.
## User roles
### Admin
Assumed to have an admin account in PocketBase, so links to backups, SMTP settings, etc., are shown in the hub.
The first user created automatically becomes an admin and can log into PocketBase.
Please note that changing a user's role will not create a PocketBase admin account for them. If you want to do that, go to Settings > Admins in PocketBase and add them there.
### User
Can create their own systems and alerts. Links to PocketBase settings are not shown in the hub.
### Read only
Cannot create systems, but can view any system that has been shared with them by an admin. Can create alerts.
## FAQ / Troubleshooting ## FAQ / Troubleshooting
### Agent is not connecting ### Agent is not connecting
@@ -164,8 +174,17 @@ If it's not set, the agent will try to find the filesystem mounted on `/` and us
- Run `lsblk` and choose an option under "NAME" - Run `lsblk` and choose an option under "NAME"
- Run `sudo fdisk -l` and choose an option under "Device" - Run `sudo fdisk -l` and choose an option under "Device"
### Docker containers are not populating reliably
Try upgrading your docker version on the agent system. I had this issue on a machine running docker 24. It was fixed by upgrading to version 27.
### Month / week records are not populating reliably ### Month / week records are not populating reliably
Records for longer time periods are made by averaging stats from the shorter time periods. They require the agent to be running uninterrupted for long enough to get a full set of data. Records for longer time periods are made by averaging stats from the shorter time periods. They require the agent to be running uninterrupted for long enough to get a full set of data.
If you pause / unpause the agent for longer than one minute, the data will be incomplete and the timing for the current interval will reset. If you pause / unpause the agent for longer than one minute, the data will be incomplete and the timing for the current interval will reset.
<!--
## Support
My country, the USA, and many others, are actively involved in the genocide of the Palestinian people. I would greatly appreciate any effort you could make to pressure your government to stop enabling this violence. -->