feat: add vpn_user_start_time_seconds metric

* added metric giving user session start time in seconds since unix
  epoch

Author: fdomain

cmd/ocserv-exporter/exporter.go

@@ -98,6 +98,7 @@ func (e *Exporter) updateUsers() {
 	for _, user := range users {
 		vpnUserTX.WithLabelValues(user.Username, user.RemoteIP, user.MTU, user.VPNIPv4, user.VPNIPv6, user.Device).Set(float64(user.RawTX))
 		vpnUserRX.WithLabelValues(user.Username, user.RemoteIP, user.MTU, user.VPNIPv4, user.VPNIPv6, user.Device).Set(float64(user.RawRX))
+		vpnUserStartTime.WithLabelValues(user.Username, user.RemoteIP, user.MTU, user.VPNIPv4, user.VPNIPv6, user.Device).Set(float64(user.RawConnectedAt))
 	}
 }
 

cmd/ocserv-exporter/main.go

@@ -90,6 +90,10 @@ var (
 		Name: "vpn_user_rx_bytes",
 		Help: "Total RX usage in bytes of a user.",
 	}, []string{"username", "remote_ip", "mtu", "vpn_ipv4", "vpn_ipv6", "device"})
+	vpnUserStartTime = prometheus.NewGaugeVec(prometheus.GaugeOpts{
+		Name: "vpn_user_start_time_seconds",
+		Help: "Start time of user session since unix epoch in seconds.",
+	}, []string{"username", "remote_ip", "mtu", "vpn_ipv4", "vpn_ipv6", "device"})
 )
 
 func main() {
@@ -120,6 +124,7 @@ func main() {
 		vpnRX,
 		vpnUserTX,
 		vpnUserRX,
+		vpnUserStartTime,
 	)
 
 	occtlCli, err := occtl.NewClient(&occtl.OcctlCommander{})

lib/occtl/occtl.go

@@ -38,18 +38,19 @@ type StatusMessage struct {
 
 // UsersMessage is a structure to decode JSON returned by "occtl --json show users"
 type UsersMessage struct {
-	ID        int64  `json:"ID"`
-	Username  string `json:"Username"`
-	Vhost     string `json:"vhost"`
-	Device    string `json:"Device"`
-	MTU       string `json:"MTU"`
-	RemoteIP  string `json:"Remote IP"`
-	VPNIPv4   string `json:"IPv4"`
-	VPNIPv6   string `json:"IPv6"`
-	RawRX     int64  `json:"RX,string"`
-	RawTX     int64  `json:"TX,string"`
-	AverageRX string `json:"Average RX"`
-	AverageTX string `json:"Average TX"`
+	ID             int64  `json:"ID"`
+	Username       string `json:"Username"`
+	Vhost          string `json:"vhost"`
+	Device         string `json:"Device"`
+	MTU            string `json:"MTU"`
+	RemoteIP       string `json:"Remote IP"`
+	VPNIPv4        string `json:"IPv4"`
+	VPNIPv6        string `json:"IPv6"`
+	RawRX          int64  `json:"RX,string"`
+	RawTX          int64  `json:"TX,string"`
+	AverageRX      string `json:"Average RX"`
+	AverageTX      string `json:"Average TX"`
+	RawConnectedAt int64  `json:"raw_connected_at"`
 }
 
 // Commander is an interface implementing exec commands

lib/occtl/occtl_test.go

@@ -97,6 +97,7 @@ var (
 			"Hostname": "laptop",
 			"Connected at": "2020-07-06 08:08",
 			"_Connected at": " 8h:17m",
+			"raw_connected_at": 1594015680,
 			"Full session": "930gAhoVKQRcCIOf34rnpRj9Pyg=",
 			"Session": "930gAh",
 			"TLS ciphersuite": "(TLS1.2)-(ECDHE-ECDSA-SECP384R1)-(AES-256-GCM)",
@@ -141,6 +142,7 @@ var (
 			"Hostname": "localhost",
 			"Connected at": "2020-07-06 06:55",
 			"_Connected at": " 9h:30m",
+			"raw_connected_at": 1594011300,
 			"Full session": "8HxOQEoXrjegoTkwioLK41ceims=",
 			"Session": "8HxOQE",
 			"TLS ciphersuite": "(TLS1.2)-(ECDHE-ECDSA-SECP384R1)-(AES-256-GCM)",
@@ -164,32 +166,34 @@ var (
 	`)
 	validShowUsersMessage = []UsersMessage{
 		{
-			ID:        4100,
-			Username:  "alice",
-			Vhost:     "default",
-			Device:    "vpns9",
-			MTU:       "1434",
-			RemoteIP:  "192.0.2.1",
-			VPNIPv4:   "198.51.100.59",
-			VPNIPv6:   "",
-			RawRX:     9447052,
-			RawTX:     328664295,
-			AverageRX: "316 bytes/sec",
-			AverageTX: "11.0 KB/sec",
+			ID:             4100,
+			Username:       "alice",
+			Vhost:          "default",
+			Device:         "vpns9",
+			MTU:            "1434",
+			RemoteIP:       "192.0.2.1",
+			VPNIPv4:        "198.51.100.59",
+			VPNIPv6:        "",
+			RawRX:          9447052,
+			RawTX:          328664295,
+			AverageRX:      "316 bytes/sec",
+			AverageTX:      "11.0 KB/sec",
+			RawConnectedAt: 1594015680,
 		},
 		{
-			ID:        15313,
-			Username:  "bob",
-			Device:    "vpns2",
-			Vhost:     "default",
-			MTU:       "1340",
-			RemoteIP:  "192.0.2.2",
-			VPNIPv4:   "198.51.100.41",
-			VPNIPv6:   "",
-			RawRX:     351042944,
-			RawTX:     18291460815,
-			AverageRX: "10.2 KB/sec",
-			AverageTX: "534.1 KB/sec",
+			ID:             15313,
+			Username:       "bob",
+			Device:         "vpns2",
+			Vhost:          "default",
+			MTU:            "1340",
+			RemoteIP:       "192.0.2.2",
+			VPNIPv4:        "198.51.100.41",
+			VPNIPv6:        "",
+			RawRX:          351042944,
+			RawTX:          18291460815,
+			AverageRX:      "10.2 KB/sec",
+			AverageTX:      "534.1 KB/sec",
+			RawConnectedAt: 1594011300,
 		},
 	}
 )