yanic/meshviewer/meshviewer.go

package meshviewer

import (
	"github.com/FreifunkBremen/yanic/data"
	"github.com/FreifunkBremen/yanic/jsontime"
)

// Node struct
type Node struct {
	Firstseen  jsontime.Time    `json:"firstseen"`
	Lastseen   jsontime.Time    `json:"lastseen"`
	Flags      Flags            `json:"flags"`
	Statistics *Statistics      `json:"statistics"`
	Nodeinfo   *data.NodeInfo   `json:"nodeinfo"`
	Neighbours *data.Neighbours `json:"-"`
}

// Flags status of node set by collector for the meshviewer
type Flags struct {
	Online  bool `json:"online"`
	Gateway bool `json:"gateway"`
}

// NodesV1 struct, to support legacy meshviewer (which are in master branch)
//  i.e. https://github.com/ffnord/meshviewer/tree/master
type NodesV1 struct {
	Version   int              `json:"version"`
	Timestamp jsontime.Time    `json:"timestamp"` // Timestamp of the generation
	List      map[string]*Node `json:"nodes"`     // the current nodemap, indexed by node ID
}

// NodesV2 struct, to support new version of meshviewer (which are in legacy develop branch or newer)
//  i.e. https://github.com/ffnord/meshviewer/tree/dev or https://github.com/ffrgb/meshviewer/tree/develop
type NodesV2 struct {
	Version   int           `json:"version"`
	Timestamp jsontime.Time `json:"timestamp"` // Timestamp of the generation
	List      []*Node       `json:"nodes"`     // the current nodemap, as array
}

// Statistics a meshviewer spezifisch struct, diffrent from respondd
type Statistics struct {
	NodeID      string  `json:"node_id"`
	Clients     uint32  `json:"clients"`
	RootFsUsage float64 `json:"rootfs_usage,omitempty"`
	LoadAverage float64 `json:"loadavg,omitempty"`
	MemoryUsage float64 `json:"memory_usage,omitempty"`
	Uptime      float64 `json:"uptime,omitempty"`
	Idletime    float64 `json:"idletime,omitempty"`
	GatewayIPv4 string  `json:"gateway,omitempty"`
	GatewayIPv6 string  `json:"gateway6,omitempty"`
	Processes   struct {
		Total   uint32 `json:"total"`
		Running uint32 `json:"running"`
	} `json:"processes,omitempty"`
	MeshVPN *data.MeshVPN `json:"mesh_vpn,omitempty"`
	Traffic struct {
		Tx      *data.Traffic `json:"tx"`
		Rx      *data.Traffic `json:"rx"`
		Forward *data.Traffic `json:"forward"`
		MgmtTx  *data.Traffic `json:"mgmt_tx"`
		MgmtRx  *data.Traffic `json:"mgmt_rx"`
	} `json:"traffic,omitempty"`
}

// NewStatistics transform respond Statistics to meshviewer Statistics
func NewStatistics(stats *data.Statistics) *Statistics {
	total := stats.Clients.Total
	if total == 0 {
		total = stats.Clients.Wifi24 + stats.Clients.Wifi5
	}
	/* The Meshviewer could not handle absolute memory output
	 * calc the used memory as a float which 100% equal 1.0
	 * calc is coppied from node statuspage (look discussion:
	 * https://github.com/FreifunkBremen/yanic/issues/35)
	 */
	memoryUsage := 1 - (float64(stats.Memory.Free)+float64(stats.Memory.Buffers)+float64(stats.Memory.Cached))/float64(stats.Memory.Total)

	return &Statistics{
		NodeID:      stats.NodeID,
		GatewayIPv4: stats.GatewayIPv4,
		GatewayIPv6: stats.GatewayIPv6,
		RootFsUsage: stats.RootFsUsage,
		LoadAverage: stats.LoadAverage,
		MemoryUsage: memoryUsage,
		Uptime:      stats.Uptime,
		Idletime:    stats.Idletime,
		Processes:   stats.Processes,
		MeshVPN:     stats.MeshVPN,
		Traffic:     stats.Traffic,
		Clients:     total,
	}
}