Merge pull request #12 from msquee/feature/docker

msquee · web-flow · commit bba2064ce6fe · 2020-10-07T15:58:49.000-04:00
Add Docker development environment and Prometheus metrics exports
diff --git a/.docker/grafana/dashboards/go-websockify.json b/.docker/grafana/dashboards/go-websockify.json
diff --git a/.docker/grafana/grafana.ini b/.docker/grafana/grafana.ini
@@ -0,0 +1,13 @@
+instance_name = grafana
+http_port = 3000
+
+[dashboards]
+  versions_to_keep = 5
+  default_home_dashboard_path = /etc/grafana/dashboards/go-websockify.json
+ 
+[plugin.grafana-image-renderer]
+  rendering_ignore_https_errors = true
+
+[users]
+  allow_sign_up = false
+  default_theme = "dark"
diff --git a/.docker/grafana/provisioning/dashboards/go-websockify.yml b/.docker/grafana/provisioning/dashboards/go-websockify.yml
@@ -0,0 +1,12 @@
+apiVersion: 1
+
+providers:
+  - name: 'Go WebSockify'
+    orgId: 1
+    type: file
+    editable: true
+    updateIntervalSeconds: 5
+    allowUiUpdates: true
+    options:
+      path: /etc/grafana/dashboards
+      foldersFromFilesStructure: true
diff --git a/.docker/grafana/provisioning/datasources/prometheus.yaml b/.docker/grafana/provisioning/datasources/prometheus.yaml
@@ -0,0 +1,8 @@
+apiVersion: 1
+
+datasources:
+  - name: Prometheus
+    type: prometheus
+    access: proxy
+    url: http://prometheus:9090
+    isDefault: true
diff --git a/.docker/grafana/provisioning/notifiers/.keep b/.docker/grafana/provisioning/notifiers/.keep
diff --git a/.docker/grafana/provisioning/plugins/.keep b/.docker/grafana/provisioning/plugins/.keep
diff --git a/.docker/prometheus/prometheus.yml b/.docker/prometheus/prometheus.yml
@@ -0,0 +1,12 @@
+global:
+  scrape_interval: 1s
+
+scrape_configs:
+  - job_name: "prometheus"
+    static_configs:
+      - targets: ["localhost:9090"]
+
+  - job_name: "go-websockify"
+    scrape_interval: 1s
+    static_configs:
+      - targets: ["go-websockify:8080"]
diff --git a/.dockerignore b/.dockerignore
@@ -0,0 +1,4 @@
+client/
+.docker/
+screenshots/
+bin/
diff --git a/Dockerfile b/Dockerfile
@@ -0,0 +1,14 @@
+FROM golang:1.14.7 as build
+
+RUN mkdir /go-websockify
+WORKDIR /go-websockify
+COPY go.mod .
+COPY go.sum .
+
+RUN go mod download
+COPY . .
+
+RUN CGO_ENABLED=0 GOOS=linux GOARCH=amd64 go build -a -installsuffix cgo -ldflags="-w -s -X main.versionString=$(git describe --tags --first-parent --abbrev=6 --long --dirty --always) -X main.buildTime=$(date -Iseconds)" -o /go/bin/go-websockify
+FROM scratch
+COPY --from=build /go/bin/go-websockify /go/bin/go-websockify
+ENTRYPOINT ["/go/bin/go-websockify"]
diff --git a/Makefile b/Makefile
@@ -8,8 +8,7 @@
 all: build
 
 build:
-	GOOS=linux GOARCH=amd64
-	go build -ldflags="-w -s -X main.versionString=$$(git describe --tags --first-parent --abbrev=6 --long --dirty --always) -X main.buildTime=$$(date -Iseconds)" -o ./bin/go-websockify
+	GOOS=linux GOARCH=amd64 go build -ldflags="-w -s -X main.versionString=$$(git describe --tags --first-parent --abbrev=6 --long --dirty --always) -X main.buildTime=$(date)" -o ./bin/go-websockify
 
 clean:
 	rm -rf bin/
diff --git a/README.md b/README.md
@@ -1,17 +1,22 @@
 # Go WebSockify
-> RFC 6455 compliant TCP and Unix socket proxy to WebSockets.
+> RFC 6455 compliant TCP to WebSocket proxy.
 
-Go WebSockify is a pure Go implementation of [novnc/websockify](https://github.com/novnc/websockify) TCP/Unix to WebSocket proxy with improved connection handling. Runs on Linux, Windows and MacOS.
+Go WebSockify is a pure Go implementation of [novnc/websockify](https://github.com/novnc/websockify) TCP to WebSocket proxy with improved connection handling. Runs on Linux, Windows and MacOS.
 
 ## Table of Contents
 - [Installation](#installation)
   - [Build from source](#build-from-source)
+- [Features](#features)
+- [Use Cases](#use-cases)
 - [Usage](#usage)
 - [Development](#development)
   - [Dependencies](#dependencies)
   - [Development environment](#development-environment)
   - [Control plane](#control-plane)
+  - [Docker](#docker)
   - [Screenshots](#screenshots)
+- [Prometheus Metrics](#prometheus-metrics)
+- [Roadmap](#roadmap)
 - [Contributing](#contributing)
 - [License](#license)
 
@@ -24,10 +29,18 @@ $ cd go-websockify
 $ make
 ```
 
+## Features
+- Runs in user space.
+- Proxy any TCP connection to a WebSocket connection.
+- `go-websockify` can be ran as a daemon by passing the command line flag `-D` or `--daemon` to run in the background.
+
+## Use Cases
+The most common use case for `go-websockify` is alongside [novnc](https://github.com/novnc) to enable fast virtual desktop experiences in the browser. 
+
 ## Usage
 ```shell
 $ go-websockify --help
-Starts a TCP/Unix to WebSocket proxy.
+Starts a TCP to WebSocket proxy.
 
 Usage:
   go-websockify [flags]
@@ -36,16 +49,17 @@ Flags:
       --bind-addr string     bind address (default "0.0.0.0:8080")
       --buffer int           buffer size (default 65536)
   -D, --daemon               run Go WebSockify as daemon
-      --echo                 run sidecar echo server
+      --echo                 sidecar echo server
   -h, --help                 help for go-websockify
-      --remote-addr string   remote address (default "127.0.0.1:3000")
+      --remote-addr string   remote address (default "127.0.0.1:1984")
   -v, --version              print Go WebSockify version
 ```
 
 ## Development
 
 ### Dependencies
 - [Go 1.14](https://golang.org/doc/devel/release.html#go1.14)
+- [Docker](https://docs.docker.com/get-docker/)
 - [Yarn](https://yarnpkg.com/getting-started/install)
 - [Modd](https://github.com/cortesi/modd)
 
@@ -55,6 +69,7 @@ Flags:
 ### Control plane
 `go-websockify` has a simple JavaScript based frontend control plane for development and is available at http://127.0.0.1:1234.
 
+To start the control plane run:
 ```shell
 $ cd client
 $ yarn install
@@ -63,10 +78,49 @@ $ yarn dev
 
 > For the frontend to automatically connect to Go WebSockify you have to pass `--echo` as a command line flag to `go-websockify`. **This is done for you if you're using Modd.**
 
+### Docker
+A batteries included Docker environment is included with this repository to show off Go WebSockify in a psuedo production environment.
+
+**Docker environment features:**
+- Prometheus
+- Grafana with preconfigured dashboard
+- Go WebSockify
+- TCP Echo Server
+
+|IP|Description|
+--|--
+|http://127.0.0.1:9090|Prometheus|
+|http://127.0.0.1:3000|Grafana|
+|http://127.0.0.1:8080|Go WebSockify|
+|http://127.0.0.1:1984|TCP Echo Server|
+
+To start the Docker environment run:
+```shell
+$ docker-compose up
+```
+
+> Grafana login is `admin/admin`
+
 ### Screenshots
-<img align="center" src="screenshots/go-websockify-control-plane.jpg">
+<img align="center" src="screenshots/go-websockify-control-plane.png" style="padding-bottom: 1em;">
+
+> The control plane is **not** included with binary distributions.
+
+## Prometheus Metrics
+<img align="center" src="screenshots/metrics.png" style="padding-bottom: 1em;">
+
+Go WebSockify exports the following Prometheus metrics at `/metrics`:
+- go_websockify_websocket_bytes_tx_total
+- go_websockify_websocket_bytes_rx_total
+- go_websockify_websocket_connections_active
+- go_websockify_tcp_connections_active
 
-> The development control plane is not included with binary distributions.
+## Roadmap
+- [ ] Support TLS on WebSocket connections.
+- [ ] Support authenticating WebSocket connections through a plugin system (https://github.com/traefik/yaegi).
+- [ ] Support for proxying UNIX sockets to WebSockets.
+- [ ] Support backend TCP connection reuse.
+- [ ] Wrapping any program with the `LD_PRELOAD` trick to catch `bind()` system calls. See: https://jvns.ca/blog/2014/11/27/ld-preload-is-super-fun-and-easy/.
 
 ## Contributing
 Both pull requests and issues are welcome on [GitHub](https://github.com/msquee/go-websockify). No set rules for contributing, just keep it clean.
diff --git a/client/app.js b/client/app.js
@@ -4,7 +4,6 @@ import fontfaceobserver from 'fontfaceobserver'
 const prettyBytes = require('pretty-bytes')
 
 new fontfaceobserver('Iosevka').load().then(() => {
-  terminal.loadAddon(fitAddon)
   terminal.open(document.getElementById('terminal'))
   fitAddon.fit()
 })
@@ -13,7 +12,7 @@ const terminal = new Terminal({
   fontSize: 16,
   fontFamily: 'Iosevka',
   letterSpacing: 0,
-})
+}) 
 const fitAddon = new FitAddon()
 
 const WS_URL = 'ws://localhost:8080/ws'
@@ -38,8 +37,11 @@ document.addEventListener('DOMContentLoaded', function () {
 
   document.getElementById('benchmark').addEventListener('click', () => {
     if (ws.readyState == ws.OPEN) {
-      let buf = Buffer.alloc(65536)
-      sendWsMessage(buf)
+      setInterval(function() {
+        let buf = Buffer.alloc(Math.floor(Math.random() * 35325) + 1)
+        sendWsMessage(buf)
+        buf = null
+      }, 1000)
     }
   })
 
diff --git a/client/index.html b/client/index.html
@@ -26,7 +26,7 @@ <h2 class="text-xl text-gray-500">Control Plane</h2>
         <div class="py-4">
           <button type="button" class="btn bg-gray-200" id="reconnect">Reconnect</button>
           <button type="button" class="btn btn-indigo" id="ping">Ping</button>
-          <button type="button" class="btn btn-indigo" id="benchmark">Send 65 kB</button>
+          <button type="button" class="btn btn-indigo" id="benchmark">Send Bytes</button>
           <div id="terminal" class="py-4 w-auto"></div>
         </div>
       </div>
diff --git a/docker-compose.yml b/docker-compose.yml
@@ -0,0 +1,48 @@
+version: '3.8'
+
+networks:
+  lan:
+
+volumes:
+  data: {}
+
+services:
+  # Prometheus
+  prometheus:
+    image: prom/prometheus:latest
+    volumes:
+      - ./.docker/prometheus/:/etc/prometheus/
+    command:
+      - "--config.file=/etc/prometheus/prometheus.yml"
+      - "--storage.tsdb.path=/prometheus"
+    ports:
+      - "9090:9090"
+    expose:
+      - 9090
+    networks:
+      - lan
+
+  # Grafana
+  grafana:
+    image: grafana/grafana:latest
+    volumes:
+      - ./.docker/grafana/:/etc/grafana/
+    command:
+      - "--config=/etc/grafana/grafana.ini"
+    ports:
+      - "3000:3000"
+    expose:
+      - 3000
+    networks:
+      - lan
+
+  # Go WebSockify
+  go-websockify:
+    build: .
+    command: "--bind-addr 0.0.0.0:8080 --remote-addr 127.0.0.1:1984 --echo"
+    ports:
+      - "8080:8080"
+    expose:
+      - 8080
+    networks:
+      - lan
diff --git a/go.mod b/go.mod
@@ -5,6 +5,7 @@ go 1.14
 require (
 	github.com/gorilla/websocket v1.4.2
 	github.com/kardianos/osext v0.0.0-20190222173326-2bc1f35cddc0 // indirect
+	github.com/prometheus/client_golang v0.9.3
 	github.com/sevlyar/go-daemon v0.1.5
 	github.com/spf13/cobra v1.0.0
 	golang.org/x/sys v0.0.0-20200625212154-ddb9806d33ae // indirect
diff --git a/http.go b/http.go
@@ -9,6 +9,9 @@ import (
 	"time"
 
 	"github.com/gorilla/websocket"
+
+	"github.com/prometheus/client_golang/prometheus"
+	"github.com/prometheus/client_golang/prometheus/promhttp"
 )
 
 var (
@@ -30,6 +33,11 @@ func StartHTTP() {
 	defer stopHTTP()
 
 	router := http.NewServeMux()
+	router.Handle("/metrics", promhttp.HandlerFor(
+		prometheus.DefaultGatherer,
+		promhttp.HandlerOpts{},
+	))
+
 	router.HandleFunc("/ws", webSocketHandler)
 
 	server = &http.Server{
@@ -65,6 +73,8 @@ func webSocketHandler(w http.ResponseWriter, r *http.Request) {
 		return
 	}
 
+	wsConnCounter.Inc()
+
 	host, port, err := net.SplitHostPort(remoteAddr)
 	if err != nil {
 		log.Println("Failed to parse remote address")
@@ -81,10 +91,11 @@ func webSocketHandler(w http.ResponseWriter, r *http.Request) {
 	}
 
 	proxyServer = NewWebSocketProxy(wsConn, tcpAddr)
-	err = proxyServer.Dial()
-	if err != nil {
+
+	if err := proxyServer.Dial(); err != nil {
 		log.Println(err)
 		return
 	}
+
 	go proxyServer.Start()
 }
diff --git a/main.go b/main.go
@@ -46,7 +46,7 @@ func main() {
 var rootCmd = &cobra.Command{
 	TraverseChildren: true,
 	Use:              "go-websockify",
-	Long:             `Starts a TCP/Unix to WebSocket proxy.`,
+	Long:             `Starts a TCP to WebSocket proxy.`,
 	Run: func(cmd *cobra.Command, args []string) {
 		if showVersion {
 			fmt.Println(fmt.Sprintf("Go WebSockify version %s built on %s", versionString, buildTime))
diff --git a/metrics.go b/metrics.go
@@ -0,0 +1,42 @@
+package main
+
+import (
+	"github.com/prometheus/client_golang/prometheus"
+)
+
+var (
+	bytesTx = prometheus.NewCounter(
+		prometheus.CounterOpts{
+			Namespace: "go_websockify",
+			Name:      "websocket_bytes_tx_total",
+		},
+	)
+
+	bytesRx = prometheus.NewCounter(
+		prometheus.CounterOpts{
+			Namespace: "go_websockify",
+			Name:      "websocket_bytes_rx_total",
+		},
+	)
+
+	wsConnCounter = prometheus.NewGauge(
+		prometheus.GaugeOpts{
+			Namespace: "go_websockify",
+			Name:      "websocket_connections_active",
+			Help:      "Active WebSocket connections",
+		})
+
+	tcpConnCounter = prometheus.NewGauge(
+		prometheus.GaugeOpts{
+			Namespace: "go_websockify",
+			Name:      "tcp_connections_active",
+			Help:      "Active TCP connections",
+		})
+)
+
+func init() {
+	prometheus.MustRegister(bytesTx)
+	prometheus.MustRegister(bytesRx)
+	prometheus.MustRegister(wsConnCounter)
+	prometheus.MustRegister(tcpConnCounter)
+}
diff --git a/proxy.go b/proxy.go
diff --git a/screenshots/go-websockify-control-plane.jpg b/screenshots/go-websockify-control-plane.jpg
diff --git a/screenshots/go-websockify-control-plane.png b/screenshots/go-websockify-control-plane.png
diff --git a/screenshots/metrics.png b/screenshots/metrics.png

-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +client/
 +.docker/
 +screenshots/
 +bin/