core

Documentation

Overview

Package core defines Stratumn Node's core functionality.

Index

• Constants
• Variables
• func BuiltinServices() []manager.Service
• func Deps(services []manager.Service, configSet cfg.ConfigSet, servID string) (deps []string, err error)
• func Fgraph(w io.Writer, services []manager.Service, configSet cfg.ConfigSet, ...) error
• func LoadConfig(set cfg.Set, filename string) error
• func NewConfigurableSet(services []manager.Service, customConfig *Config) cfg.Set
• func PrettyLog(filename, level, system string, follow, json, color bool) error
• type Config
• type ConfigHandler
  • func (c *ConfigHandler) Config() interface{}
  • func (c *ConfigHandler) ID() string
  • func (c *ConfigHandler) SetConfig(config interface{}) error
• type Core
  • func New(configSet cfg.ConfigSet, opts ...Opt) (*Core, error)
  • func (c *Core) Boot(ctx context.Context) error
• type Opt
  • func OptManager(mgr *manager.Manager) Opt
  • func OptMetricsHandler(h func()) Opt
  • func OptServices(services ...manager.Service) Opt
  • func OptStderr(w io.Writer) Opt
  • func OptStdout(w io.Writer) Opt
  • func OptUpHandler(h func()) Opt
• type ServiceGroupConfig

Constants

const ConfigVersionKey = "core.configuration_version"

ConfigVersionKey is the key of the configuration version number in the TOML file.

Variables

var DefaultConfig = Config{
	ConfigVersion: len(migrations),
	BootService:   "boot",
	ServiceGroups: []ServiceGroupConfig{{
		ID:       "boot",
		Name:     "Boot Services",
		Desc:     "Starts boot services.",
		Services: []string{"system", "bootstrap", "api", "util"},
	}, {
		ID:       "system",
		Name:     "System Services",
		Desc:     "Starts system services.",
		Services: []string{"signal", "pruner", "monitoring"},
	}, {
		ID:       "p2p",
		Name:     "P2P Services",
		Desc:     "Starts P2P services.",
		Services: []string{"identify", "relay", "kaddht", "ping", "clock", "pubsub"},
	}, {
		ID:       "network",
		Name:     "Network Services",
		Desc:     "Starts network services.",
		Services: []string{"host", "natmgr"},
	}, {
		ID:       "api",
		Name:     "API Services",
		Desc:     "Starts API services.",
		Services: []string{"grpcapi", "grpcweb"},
	}, {
		ID:       "util",
		Name:     "Utility Services",
		Desc:     "Starts utility services.",
		Services: []string{"contacts", "event"},
	}},
	EnableBootScreen: true,
	BootScreenHost:   "host",
}

DefaultConfig is the default core configuration.

var (
	// ErrInvalidConfig is returned when the configuration is invalid.
	ErrInvalidConfig = errors.New("the configuration is invalid")
)

Functions

func BuiltinServices

func BuiltinServices() []manager.Service

BuiltinServices returns all the builtin services.

func Deps

func Deps(
	services []manager.Service,
	configSet cfg.ConfigSet,
	servID string,
) (deps []string, err error)

Deps returns the dependencies of a service in the order they would be started with the given configuration.

The returned slice ends with the service itself.

If no service ID is given, the boot service will be used.

func Fgraph

func Fgraph(
	w io.Writer,
	services []manager.Service,
	configSet cfg.ConfigSet,
	servID string,
) error

Fgraph prints the dependency graph of a service given the current configuration to a writer.

If no service ID is given, the boot service will be used.

func LoadConfig

func LoadConfig(set cfg.Set, filename string) error

LoadConfig loads the configuration file and applies migrations.

func NewConfigurableSet

func NewConfigurableSet(services []manager.Service, customConfig *Config) cfg.Set

NewConfigurableSet creates a new set of configurables bound to the given services. If no services are given, the builtin services are used. If no customConfig is given, the default core config is used.

func PrettyLog

func PrettyLog(filename, level, system string, follow, json, color bool) error

PrettyLog pretty prints log output.

Types

type Config

type Config struct {
	// ConfigVersion is the version of the configuration file.
	ConfigVersion int `toml:"configuration_version" comment:"The version of the configuration file."`

	// BootService is the service to launch when starting the node.
	BootService string `toml:"boot_service" comment:"Service to launch when starting the node."`

	// ServiceGroups are groups of services that can be started as a
	// service.
	ServiceGroups []ServiceGroupConfig `toml:"service_groups" comment:"Groups of services."`

	// EnableBootScreen is whether to show the boot screen when starting
	// the node.
	EnableBootScreen bool `toml:"enable_boot_screen" comment:"Whether to show the boot screen when starting the node."`

	// BootScreenHost is the name of the host service used by the
	// boot screen to display metrics and host addresses.
	BootScreenHost string `toml:"boot_screen_host" comment:"Name of the host service used by the boot screen to display metrics and host addresses."`
}

Config contains the core settings.

type ConfigHandler

type ConfigHandler struct {
	// contains filtered or unexported fields
}

ConfigHandler is a configurable for the core settings.

func (*ConfigHandler) Config

func (c *ConfigHandler) Config() interface{}

Config returns the current service configuration or creates one with good default values.

func (*ConfigHandler) ID

func (c *ConfigHandler) ID() string

ID returns the unique identifier of the service.

func (*ConfigHandler) SetConfig

func (c *ConfigHandler) SetConfig(config interface{}) error

SetConfig configures the service handler.

type Core

type Core struct {
	// contains filtered or unexported fields
}

Core manages a node. It wraps a service manager, and can display a boot screen showing services being started and node metrics.

func New

func New(configSet cfg.ConfigSet, opts ...Opt) (*Core, error)

New creates a new core.

func (*Core) Boot

func (c *Core) Boot(ctx context.Context) error

Boot starts the node and runs until an exit signal or a fatal error occurs.

It returns an error early if it failed to start the boot service. Otherwise it never returns unless the context is canceled.

type Opt

type Opt func(*Core)

Opt is a core option.

func OptManager

func OptManager(mgr *manager.Manager) Opt

OptManager sets the service manager.

If this option is not given, a new manager is created.

func OptMetricsHandler

func OptMetricsHandler(h func()) Opt

OptMetricsHandler sets a function that will be called everytime metrics tick.

This is useful for tests.

func OptServices

func OptServices(services ...manager.Service) Opt

OptServices adds services.

If this option is not given, the builtin services are used.

func OptStderr

func OptStderr(w io.Writer) Opt

OptStderr sets the writer for the boot screen error output.

If this option is not given, os.Stderr is used.

func OptStdout

func OptStdout(w io.Writer) Opt

OptStdout sets the writer for the boot screen normal output.

If this option is not given, os.Stdout is used.

func OptUpHandler

func OptUpHandler(h func()) Opt

OptUpHandler sets a function that will be called once the node has started.

This is useful for tests.

type ServiceGroupConfig

type ServiceGroupConfig struct {
	// ID is the unique identifier of the group.
	ID string `toml:"id" comment:"Unique identifier of the service group."`

	// Name is the name of the group.
	Name string `toml:"name" comment:"Name of the service group."`

	// Desc is the description of the group.
	Desc string `toml:"description" comment:"Description of the service group."`

	// Services are the services that the group starts.
	Services []string `toml:"services" comment:"Services started by the group."`
}

ServiceGroupConfig contains settings for a service group.