Add statistics dashboard
This commit is contained in:
Space-Banane
12
Readme.md
12
Readme.md
@@ -5,6 +5,8 @@ A simple clipboard synchronization tool built with Go. It consists of a server a
|
||||
- Real-time clipboard synchronization
|
||||
- Cross-platform support (Windows, macOS, Linux)
|
||||
- Easy to set up and use
|
||||
- Lightweight and efficient
|
||||
- Optional statistics dashboard for monitoring connected clients and message relay counts
|
||||
|
||||
## Prerequisites
|
||||
- Go programming language installed (version 1.16 or higher)
|
||||
@@ -27,6 +29,7 @@ const (
|
||||
// Update these values before building
|
||||
EmbeddedServerIP = "0.0.0.0"
|
||||
EmbeddedServerPort = "8080"
|
||||
EmbeddedServerStats = true
|
||||
)
|
||||
```
|
||||
|
||||
@@ -58,6 +61,15 @@ I use this on my home server, which i can connect to with tailscale, so i don't
|
||||
|
||||
Clients are identified by the `EmbeddedIdentification` value in the client config file. Make sure to set this to a unique value for each USER you want to sync. If you want to sync multiple devices for the same user, just run multiple instances of the client with the same `EmbeddedIdentification`.
|
||||
|
||||
## Statistics Dashboard
|
||||
|
||||
If `EmbeddedServerStats` is set, the server will serve a live statistics dashboard at [http://localhost:8080/stats](http://localhost:8080/stats) showing:
|
||||
|
||||
- Number of connected clients
|
||||
- Number of messages relayed
|
||||
|
||||
The dashboard uses [Tailwind CSS CDN](https://cdn.tailwindcss.com) for styling and updates live every second.
|
||||
|
||||
## License
|
||||
This project is licensed under the MIT License.
|
||||
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
package main
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"log"
|
||||
"net/http"
|
||||
"sync"
|
||||
@@ -8,11 +9,50 @@ import (
|
||||
"github.com/gorilla/websocket"
|
||||
)
|
||||
|
||||
var upgrader = websocket.Upgrader{
|
||||
CheckOrigin: func(r *http.Request) bool {
|
||||
return true
|
||||
},
|
||||
}
|
||||
var (
|
||||
upgrader = websocket.Upgrader{
|
||||
CheckOrigin: func(r *http.Request) bool {
|
||||
return true
|
||||
},
|
||||
}
|
||||
|
||||
dashboardHTML = `
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<title>Clipboard On The Go - Stats</title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<script src="https://cdn.tailwindcss.com"></script>
|
||||
</head>
|
||||
<body class="bg-gray-100 min-h-screen flex flex-col items-center justify-center">
|
||||
<div class="bg-white shadow-md rounded px-8 pt-6 pb-8 mb-4 w-full max-w-md">
|
||||
<h1 class="text-2xl font-bold mb-4 text-center">Clipboard On The Go - Server Stats</h1>
|
||||
<div class="mb-2 flex justify-between">
|
||||
<span class="font-semibold">Connected Clients:</span>
|
||||
<span id="clients" class="font-mono">0</span>
|
||||
</div>
|
||||
<div class="mb-2 flex justify-between">
|
||||
<span class="font-semibold">Messages Relayed:</span>
|
||||
<span id="messages" class="font-mono">0</span>
|
||||
</div>
|
||||
</div>
|
||||
<script>
|
||||
function updateStats() {
|
||||
fetch('/stats/data')
|
||||
.then(r => r.json())
|
||||
.then(d => {
|
||||
document.getElementById('clients').textContent = d.clients;
|
||||
document.getElementById('messages').textContent = d.messages;
|
||||
});
|
||||
}
|
||||
setInterval(updateStats, 1000);
|
||||
updateStats();
|
||||
</script>
|
||||
</body>
|
||||
</html>
|
||||
`
|
||||
)
|
||||
|
||||
type Client struct {
|
||||
conn *websocket.Conn
|
||||
@@ -26,6 +66,10 @@ type Server struct {
|
||||
unregister chan *Client
|
||||
broadcast chan *Message
|
||||
mu sync.RWMutex
|
||||
|
||||
// Statistics
|
||||
statsEnabled bool
|
||||
messagesRelayed uint64
|
||||
}
|
||||
|
||||
type Message struct {
|
||||
@@ -36,10 +80,11 @@ type Message struct {
|
||||
|
||||
func newServer() *Server {
|
||||
return &Server{
|
||||
clients: make(map[*Client]bool),
|
||||
register: make(chan *Client),
|
||||
unregister: make(chan *Client),
|
||||
broadcast: make(chan *Message),
|
||||
clients: make(map[*Client]bool),
|
||||
register: make(chan *Client),
|
||||
unregister: make(chan *Client),
|
||||
broadcast: make(chan *Message),
|
||||
statsEnabled: EmbeddedServerStats,
|
||||
}
|
||||
}
|
||||
|
||||
@@ -74,6 +119,11 @@ func (s *Server) run() {
|
||||
}
|
||||
}
|
||||
s.mu.RUnlock()
|
||||
if s.statsEnabled {
|
||||
s.mu.Lock()
|
||||
s.messagesRelayed++
|
||||
s.mu.Unlock()
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -157,7 +207,26 @@ func main() {
|
||||
handleWebSocket(server, w, r)
|
||||
})
|
||||
|
||||
// Serve stats dashboard if enabled
|
||||
if EmbeddedServerStats {
|
||||
http.HandleFunc("/stats", func(w http.ResponseWriter, r *http.Request) {
|
||||
w.Header().Set("Content-Type", "text/html; charset=utf-8")
|
||||
fmt.Fprint(w, dashboardHTML)
|
||||
})
|
||||
http.HandleFunc("/stats/data", func(w http.ResponseWriter, r *http.Request) {
|
||||
server.mu.RLock()
|
||||
clients := len(server.clients)
|
||||
messages := server.messagesRelayed
|
||||
server.mu.RUnlock()
|
||||
w.Header().Set("Content-Type", "application/json")
|
||||
fmt.Fprintf(w, `{"clients":%d,"messages":%d}`, clients, messages)
|
||||
})
|
||||
}
|
||||
|
||||
log.Printf("Server starting on port %s", port)
|
||||
if EmbeddedServerStats {
|
||||
log.Printf("Stats dashboard enabled at /stats")
|
||||
}
|
||||
err := http.ListenAndServe(":"+port, nil)
|
||||
if err != nil {
|
||||
log.Fatal("ListenAndServe error:", err)
|
||||
|
||||
Reference in New Issue
Block a user