Skip to content

Commit 34e33e4

Browse files
committed
Cleanup logging
Make sure all logging output is called via the main logger instead of stdlib `"log"` or `fmt.Print(f|ln)`. Signed-off-by: SuperQ <[email protected]>
1 parent c5cec99 commit 34e33e4

File tree

14 files changed

+92
-102
lines changed

14 files changed

+92
-102
lines changed

block_device.go

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@ package kvm
33
import (
44
"context"
55
"errors"
6-
"log"
76
"net"
87
"os"
98
"time"
@@ -94,7 +93,8 @@ func (d *NBDDevice) Start() error {
9493
// Remove the socket file if it already exists
9594
if _, err := os.Stat(nbdSocketPath); err == nil {
9695
if err := os.Remove(nbdSocketPath); err != nil {
97-
log.Fatalf("Failed to remove existing socket file %s: %v", nbdSocketPath, err)
96+
logger.Errorf("Failed to remove existing socket file %s: %v", nbdSocketPath, err)
97+
os.Exit(1)
9898
}
9999
}
100100

@@ -134,22 +134,22 @@ func (d *NBDDevice) runServerConn() {
134134
MaximumBlockSize: uint32(16 * 1024),
135135
SupportsMultiConn: false,
136136
})
137-
log.Println("nbd server exited:", err)
137+
logger.Infof("nbd server exited: %v", err)
138138
}
139139

140140
func (d *NBDDevice) runClientConn() {
141141
err := client.Connect(d.clientConn, d.dev, &client.Options{
142142
ExportName: "jetkvm",
143143
BlockSize: uint32(4 * 1024),
144144
})
145-
log.Println("nbd client exited:", err)
145+
logger.Infof("nbd client exited: %w", err)
146146
}
147147

148148
func (d *NBDDevice) Close() {
149149
if d.dev != nil {
150150
err := client.Disconnect(d.dev)
151151
if err != nil {
152-
log.Println("error disconnecting nbd client:", err)
152+
logger.Warnf("error disconnecting nbd client: %v", err)
153153
}
154154
_ = d.dev.Close()
155155
}

cloud.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -151,7 +151,7 @@ func runWebsocketClient() error {
151151
return err
152152
}
153153
defer c.CloseNow()
154-
cloudLogger.Infof("websocket connected to %s", wsURL.String())
154+
cloudLogger.Infof("websocket connected to %s", wsURL)
155155
runCtx, cancelRun := context.WithCancel(context.Background())
156156
defer cancelRun()
157157
go func() {

display.go

Lines changed: 14 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@ package kvm
33
import (
44
"errors"
55
"fmt"
6-
"log"
76
"os"
87
"strconv"
98
"time"
@@ -25,7 +24,7 @@ const (
2524
func switchToScreen(screen string) {
2625
_, err := CallCtrlAction("lv_scr_load", map[string]interface{}{"obj": screen})
2726
if err != nil {
28-
log.Printf("failed to switch to screen %s: %v", screen, err)
27+
logger.Warnf("failed to switch to screen %s: %v", screen, err)
2928
return
3029
}
3130
currentScreen = screen
@@ -41,7 +40,7 @@ func updateLabelIfChanged(objName string, newText string) {
4140
}
4241

4342
func switchToScreenIfDifferent(screenName string) {
44-
fmt.Println("switching screen from", currentScreen, screenName)
43+
logger.Infof("switching screen from %s to %s", currentScreen, screenName)
4544
if currentScreen != screenName {
4645
switchToScreen(screenName)
4746
}
@@ -75,12 +74,12 @@ var displayInited = false
7574

7675
func requestDisplayUpdate() {
7776
if !displayInited {
78-
fmt.Println("display not inited, skipping updates")
77+
logger.Info("display not inited, skipping updates")
7978
return
8079
}
8180
go func() {
8281
wakeDisplay(false)
83-
fmt.Println("display updating........................")
82+
logger.Info("display updating")
8483
//TODO: only run once regardless how many pending updates
8584
updateDisplay()
8685
}()
@@ -119,7 +118,7 @@ func setDisplayBrightness(brightness int) error {
119118
return err
120119
}
121120

122-
fmt.Printf("display: set brightness to %v\n", brightness)
121+
logger.Infof("display: set brightness to %v", brightness)
123122
return nil
124123
}
125124

@@ -128,7 +127,7 @@ func setDisplayBrightness(brightness int) error {
128127
func tick_displayDim() {
129128
err := setDisplayBrightness(config.DisplayMaxBrightness / 2)
130129
if err != nil {
131-
fmt.Printf("display: failed to dim display: %s\n", err)
130+
logger.Warnf("display: failed to dim display: %s", err)
132131
}
133132

134133
dimTicker.Stop()
@@ -141,7 +140,7 @@ func tick_displayDim() {
141140
func tick_displayOff() {
142141
err := setDisplayBrightness(0)
143142
if err != nil {
144-
fmt.Printf("display: failed to turn off display: %s\n", err)
143+
logger.Warnf("display: failed to turn off display: %s", err)
145144
}
146145

147146
offTicker.Stop()
@@ -164,7 +163,7 @@ func wakeDisplay(force bool) {
164163

165164
err := setDisplayBrightness(config.DisplayMaxBrightness)
166165
if err != nil {
167-
fmt.Printf("display wake failed, %s\n", err)
166+
logger.Warnf("display wake failed, %s", err)
168167
}
169168

170169
if config.DisplayDimAfterSec != 0 {
@@ -184,7 +183,7 @@ func wakeDisplay(force bool) {
184183
func watchTsEvents() {
185184
ts, err := os.OpenFile(touchscreenDevice, os.O_RDONLY, 0666)
186185
if err != nil {
187-
fmt.Printf("display: failed to open touchscreen device: %s\n", err)
186+
logger.Warnf("display: failed to open touchscreen device: %s", err)
188187
return
189188
}
190189

@@ -197,7 +196,7 @@ func watchTsEvents() {
197196
for {
198197
_, err := ts.Read(buf)
199198
if err != nil {
200-
fmt.Printf("display: failed to read from touchscreen device: %s\n", err)
199+
logger.Warnf("display: failed to read from touchscreen device: %s", err)
201200
return
202201
}
203202

@@ -217,7 +216,7 @@ func startBacklightTickers() {
217216
}
218217

219218
if dimTicker == nil && config.DisplayDimAfterSec != 0 {
220-
fmt.Printf("display: dim_ticker has started\n")
219+
logger.Info("display: dim_ticker has started")
221220
dimTicker = time.NewTicker(time.Duration(config.DisplayDimAfterSec) * time.Second)
222221
defer dimTicker.Stop()
223222

@@ -232,7 +231,7 @@ func startBacklightTickers() {
232231
}
233232

234233
if offTicker == nil && config.DisplayOffAfterSec != 0 {
235-
fmt.Printf("display: off_ticker has started\n")
234+
logger.Info("display: off_ticker has started")
236235
offTicker = time.NewTicker(time.Duration(config.DisplayOffAfterSec) * time.Second)
237236
defer offTicker.Stop()
238237

@@ -252,11 +251,11 @@ func init() {
252251

253252
go func() {
254253
waitCtrlClientConnected()
255-
fmt.Println("setting initial display contents")
254+
logger.Info("setting initial display contents")
256255
time.Sleep(500 * time.Millisecond)
257256
updateStaticContents()
258257
displayInited = true
259-
fmt.Println("display inited")
258+
logger.Info("display inited")
260259
startBacklightTickers()
261260
wakeDisplay(true)
262261
requestDisplayUpdate()

fuse.go

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@ package kvm
22

33
import (
44
"context"
5-
"fmt"
65
"os"
76
"sync"
87
"syscall"
@@ -104,7 +103,7 @@ func RunFuseServer() {
104103
var err error
105104
fuseServer, err = fs.Mount(fuseMountPoint, &FuseRoot{}, opts)
106105
if err != nil {
107-
fmt.Println("failed to mount fuse: %w", err)
106+
logger.Warnf("failed to mount fuse: %v", err)
108107
}
109108
fuseServer.Wait()
110109
}

jsonrpc.go

Lines changed: 16 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,6 @@ import (
66
"errors"
77
"fmt"
88
"kvm/internal/usbgadget"
9-
"log"
109
"os"
1110
"os/exec"
1211
"path/filepath"
@@ -47,12 +46,12 @@ type BacklightSettings struct {
4746
func writeJSONRPCResponse(response JSONRPCResponse, session *Session) {
4847
responseBytes, err := json.Marshal(response)
4948
if err != nil {
50-
log.Println("Error marshalling JSONRPC response:", err)
49+
logger.Warnf("Error marshalling JSONRPC response: %v", err)
5150
return
5251
}
5352
err = session.RPCChannel.SendText(string(responseBytes))
5453
if err != nil {
55-
log.Println("Error sending JSONRPC response:", err)
54+
logger.Warnf("Error sending JSONRPC response: %v", err)
5655
return
5756
}
5857
}
@@ -65,16 +64,16 @@ func writeJSONRPCEvent(event string, params interface{}, session *Session) {
6564
}
6665
requestBytes, err := json.Marshal(request)
6766
if err != nil {
68-
log.Println("Error marshalling JSONRPC event:", err)
67+
logger.Warnf("Error marshalling JSONRPC event: %v", err)
6968
return
7069
}
7170
if session == nil || session.RPCChannel == nil {
72-
log.Println("RPC channel not available")
71+
logger.Info("RPC channel not available")
7372
return
7473
}
7574
err = session.RPCChannel.SendText(string(requestBytes))
7675
if err != nil {
77-
log.Println("Error sending JSONRPC event:", err)
76+
logger.Warnf("Error sending JSONRPC event: %v", err)
7877
return
7978
}
8079
}
@@ -95,7 +94,7 @@ func onRPCMessage(message webrtc.DataChannelMessage, session *Session) {
9594
return
9695
}
9796

98-
//log.Printf("Received RPC request: Method=%s, Params=%v, ID=%d", request.Method, request.Params, request.ID)
97+
//logger.Infof("Received RPC request: Method=%s, Params=%v, ID=%d", request.Method, request.Params, request.ID)
9998
handler, ok := rpcHandlers[request.Method]
10099
if !ok {
101100
errorResponse := JSONRPCResponse{
@@ -148,7 +147,7 @@ func rpcGetStreamQualityFactor() (float64, error) {
148147
}
149148

150149
func rpcSetStreamQualityFactor(factor float64) error {
151-
log.Printf("Setting stream quality factor to: %f", factor)
150+
logger.Infof("Setting stream quality factor to: %f", factor)
152151
var _, err = CallCtrlAction("set_video_quality_factor", map[string]interface{}{"quality_factor": factor})
153152
if err != nil {
154153
return err
@@ -184,10 +183,10 @@ func rpcGetEDID() (string, error) {
184183

185184
func rpcSetEDID(edid string) error {
186185
if edid == "" {
187-
log.Println("Restoring EDID to default")
186+
logger.Info("Restoring EDID to default")
188187
edid = "00ffffffffffff0052620188008888881c150103800000780a0dc9a05747982712484c00000001010101010101010101010101010101023a801871382d40582c4500c48e2100001e011d007251d01e206e285500c48e2100001e000000fc00543734392d6648443732300a20000000fd00147801ff1d000a202020202020017b"
189188
} else {
190-
log.Printf("Setting EDID to: %s", edid)
189+
logger.Infof("Setting EDID to: %s", edid)
191190
}
192191
_, err := CallCtrlAction("set_edid", map[string]interface{}{"edid": edid})
193192
if err != nil {
@@ -258,7 +257,7 @@ func rpcSetBacklightSettings(params BacklightSettings) error {
258257
return fmt.Errorf("failed to save config: %w", err)
259258
}
260259

261-
log.Printf("rpc: display: settings applied, max_brightness: %d, dim after: %ds, off after: %ds", config.DisplayMaxBrightness, config.DisplayDimAfterSec, config.DisplayOffAfterSec)
260+
logger.Infof("rpc: display: settings applied, max_brightness: %d, dim after: %ds, off after: %ds", config.DisplayMaxBrightness, config.DisplayDimAfterSec, config.DisplayOffAfterSec)
262261

263262
// If the device started up with auto-dim and/or auto-off set to zero, the display init
264263
// method will not have started the tickers. So in case that has changed, attempt to start the tickers now.
@@ -479,23 +478,23 @@ type RPCHandler struct {
479478
}
480479

481480
func rpcSetMassStorageMode(mode string) (string, error) {
482-
log.Printf("[jsonrpc.go:rpcSetMassStorageMode] Setting mass storage mode to: %s", mode)
481+
logger.Infof("[jsonrpc.go:rpcSetMassStorageMode] Setting mass storage mode to: %s", mode)
483482
var cdrom bool
484483
if mode == "cdrom" {
485484
cdrom = true
486485
} else if mode != "file" {
487-
log.Printf("[jsonrpc.go:rpcSetMassStorageMode] Invalid mode provided: %s", mode)
486+
logger.Infof("[jsonrpc.go:rpcSetMassStorageMode] Invalid mode provided: %s", mode)
488487
return "", fmt.Errorf("invalid mode: %s", mode)
489488
}
490489

491-
log.Printf("[jsonrpc.go:rpcSetMassStorageMode] Setting mass storage mode to: %s", mode)
490+
logger.Infof("[jsonrpc.go:rpcSetMassStorageMode] Setting mass storage mode to: %s", mode)
492491

493492
err := setMassStorageMode(cdrom)
494493
if err != nil {
495494
return "", fmt.Errorf("failed to set mass storage mode: %w", err)
496495
}
497496

498-
log.Printf("[jsonrpc.go:rpcSetMassStorageMode] Mass storage mode set to %s", mode)
497+
logger.Infof("[jsonrpc.go:rpcSetMassStorageMode] Mass storage mode set to %s", mode)
499498

500499
// Get the updated mode after setting
501500
return rpcGetMassStorageMode()
@@ -564,7 +563,7 @@ func rpcResetConfig() error {
564563
return fmt.Errorf("failed to reset config: %w", err)
565564
}
566565

567-
log.Println("Configuration reset to default")
566+
logger.Info("Configuration reset to default")
568567
return nil
569568
}
570569

@@ -580,7 +579,7 @@ func rpcGetDCPowerState() (DCPowerState, error) {
580579
}
581580

582581
func rpcSetDCPowerState(enabled bool) error {
583-
log.Printf("[jsonrpc.go:rpcSetDCPowerState] Setting DC power state to: %v", enabled)
582+
logger.Infof("[jsonrpc.go:rpcSetDCPowerState] Setting DC power state to: %v", enabled)
584583
err := setDCPowerState(enabled)
585584
if err != nil {
586585
return fmt.Errorf("failed to set DC power state: %w", err)

main.go

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@ package kvm
22

33
import (
44
"context"
5-
"log"
65
"net/http"
76
"os"
87
"os/signal"
@@ -77,15 +76,15 @@ func Main() {
7776
sigs := make(chan os.Signal, 1)
7877
signal.Notify(sigs, syscall.SIGINT, syscall.SIGTERM)
7978
<-sigs
80-
log.Println("JetKVM Shutting Down")
79+
logger.Info("JetKVM Shutting Down")
8180
//if fuseServer != nil {
8281
// err := setMassStorageImage(" ")
8382
// if err != nil {
84-
// log.Printf("Failed to unmount mass storage image: %v", err)
83+
// logger.Infof("Failed to unmount mass storage image: %v", err)
8584
// }
8685
// err = fuseServer.Unmount()
8786
// if err != nil {
88-
// log.Printf("Failed to unmount fuse: %v", err)
87+
// logger.Infof("Failed to unmount fuse: %v", err)
8988
// }
9089

9190
// os.Exit(0)

0 commit comments

Comments
 (0)