• Kurkó Mihály's avatar
    dashboard: CPU, memory, diskIO and traffic on the footer (#15950) · 05ade193
    Kurkó Mihály authored
    * dashboard: footer, deep state update
    
    * dashboard: resolve asset path
    
    * dashboard: prevent state update on every reconnection
    
    * dashboard: fix linter issue
    
    * dashboard, cmd: minor UI fix, include commit hash
    
    * dashboard: gitCommit renamed to commit
    
    * dashboard: move the geth version to the right, make commit optional
    
    * dashboard: memory, traffic and CPU on footer
    
    * dashboard: fix merge
    
    * dashboard: CPU, diskIO on footer
    
    * dashboard: rename variables, use group declaration
    
    * dashboard: docs
    05ade193
config.go 1.76 KB
// 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 "time"

// DefaultConfig contains default settings for the dashboard.
var DefaultConfig = Config{
	Host:    "localhost",
	Port:    8080,
	Refresh: 5 * time.Second,
}

// Config contains the configuration parameters of the dashboard.
type Config struct {
	// Host is the host interface on which to start the dashboard server. If this
	// field is empty, no dashboard will be started.
	Host string `toml:",omitempty"`

	// Port is the TCP port number on which to start the dashboard server. The
	// default zero value is/ valid and will pick a port number randomly (useful
	// for ephemeral nodes).
	Port int `toml:",omitempty"`

	// Refresh is the refresh rate of the data updates, the chartEntry will be collected this often.
	Refresh time.Duration `toml:",omitempty"`

	// Assets offers a possibility to manually set the dashboard website's location on the server side.
	// It is useful for debugging, avoids the repeated generation of the binary.
	Assets string `toml:",omitempty"`
}