go-ethereum/dashboard/message.go

// Copyright 2017 The go-ethereum Authors
// This file is part of the go-ethereum library.
//
// The go-ethereum library is free software: you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// The go-ethereum library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with the go-ethereum library. If not, see <http://www.gnu.org/licenses/>.

package dashboard

import (
	"container/list"
	"encoding/json"
	"time"
)

type Message struct {
	General *GeneralMessage `json:"general,omitempty"`
	Home    *HomeMessage    `json:"home,omitempty"`
	Chain   *ChainMessage   `json:"chain,omitempty"`
	TxPool  *TxPoolMessage  `json:"txpool,omitempty"`
	Network *NetworkMessage `json:"network,omitempty"`
	System  *SystemMessage  `json:"system,omitempty"`
	Logs    *LogsMessage    `json:"logs,omitempty"`
}

type ChartEntries []*ChartEntry

type ChartEntry struct {
	Time  time.Time `json:"time"`
	Value float64   `json:"value"`
}

type GeneralMessage struct {
	Version string `json:"version,omitempty"`
	Commit  string `json:"commit,omitempty"`
}

type HomeMessage struct {
	/* TODO (kurkomisi) */
}

type ChainMessage struct {
	/* TODO (kurkomisi) */
}

type TxPoolMessage struct {
	/* TODO (kurkomisi) */
}

// NetworkMessage contains information about the peers organized based on the IP address.
type NetworkMessage struct {
	PeerBundles map[string]*PeerBundle `json:"peerBundles,omitempty"`
}

// getOrInitBundle returns the peer bundle belonging to the given IP, or
// initializes the bundle if it doesn't exist.
func (m *NetworkMessage) getOrInitBundle(ip string) *PeerBundle {
	if _, ok := m.PeerBundles[ip]; !ok {
		m.PeerBundles[ip] = &PeerBundle{
			Peers: make(PeerMap),
			FailedPeers: make(PeerMap),
		}
	}
	return m.PeerBundles[ip]
}

// getOrInitPeer returns the peer belonging to the given IP and node id, or
// initializes the peer if it doesn't exist.
func (m *NetworkMessage) getOrInitPeer(ip, id string) *Peer {
	return m.getOrInitBundle(ip).getOrInitPeer(id)
}

type PeerMap map[string]*Peer

func (pm PeerMap) getOrInit(id string) *Peer {
	if _, ok := pm[id]; !ok {
		pm[id] = new(Peer)
	}
	return pm[id]
}

func (pm PeerMap) remove(id string) {
	delete(pm, id)
}

// PeerBundle contains information about the peers pertaining to an IP address.
type PeerBundle struct {
	Location    *GeoLocation `json:"location,omitempty"` // geographical information based on IP
	Peers       PeerMap      `json:"peers,omitempty"`    // the peers' node id is used as key
	FailedPeers PeerMap      `json:"failedPeers,omitempty"`
}

func (b *PeerBundle) getOrInitPeer(id string) *Peer {
	return b.Peers.getOrInit(id)
}

func (b *PeerBundle) removePeer(id string) {
	b.Peers.remove(id)
}

func (b *PeerBundle) getOrInitFailedPeer(id string) *Peer {
	return b.FailedPeers.getOrInit(id)
}

func (b * PeerBundle) removeFailedPeer(id string) {
	b.FailedPeers.remove(id)
}

// GeoLocation contains geographical information.
type GeoLocation struct {
	Country   string  `json:"country,omitempty"`
	City      string  `json:"city,omitempty"`
	Latitude  float64 `json:"latitude,omitempty"`
	Longitude float64 `json:"longitude,omitempty"`
}

// Peer contains lifecycle timestamps and traffic information of a given peer.
type Peer struct {
	Connected    []time.Time `json:"connected,omitempty"`
	Disconnected []time.Time `json:"disconnected,omitempty"`

	Ingress ChartEntries `json:"ingress,omitempty"`
	Egress  ChartEntries `json:"egress,omitempty"`

	element *list.Element
	ip, id string
}

// SystemMessage contains the metered system data samples.
type SystemMessage struct {
	ActiveMemory   ChartEntries `json:"activeMemory,omitempty"`
	VirtualMemory  ChartEntries `json:"virtualMemory,omitempty"`
	NetworkIngress ChartEntries `json:"networkIngress,omitempty"`
	NetworkEgress  ChartEntries `json:"networkEgress,omitempty"`
	ProcessCPU     ChartEntries `json:"processCPU,omitempty"`
	SystemCPU      ChartEntries `json:"systemCPU,omitempty"`
	DiskRead       ChartEntries `json:"diskRead,omitempty"`
	DiskWrite      ChartEntries `json:"diskWrite,omitempty"`
}

// LogsMessage wraps up a log chunk. If 'Source' isn't present, the chunk is a stream chunk.
type LogsMessage struct {
	Source *LogFile        `json:"source,omitempty"` // Attributes of the log file.
	Chunk  json.RawMessage `json:"chunk"`            // Contains log records.
}

// LogFile contains the attributes of a log file.
type LogFile struct {
	Name string `json:"name"` // The name of the file.
	Last bool   `json:"last"` // Denotes if the actual log file is the last one in the directory.
}

// Request represents the client request.
type Request struct {
	Logs *LogsRequest `json:"logs,omitempty"`
}

// LogsRequest contains the attributes of the log file the client wants to receive.
type LogsRequest struct {
	Name string `json:"name"` // The request handler searches for log file based on this file name.
	Past bool   `json:"past"` // Denotes whether the client wants the previous or the next file.
}