proc

package module
v0.0.7 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 9, 2022 License: Unlicense Imports: 14 Imported by: 0

README

proc

Process control, logging and child processes

Description

Golang is a great language for concurrency, but sometimes you want parallelism, and it's often simpler to design apps as little units that plug together via RPC APIs. Services don't always have easy start/stop/reconfig/restart controls, and sometimes they use their own custom configuration scheme that is complicated to integrate with yours.

In addition, you may want to design your applications as neat little pieces, but how to attach them together and orchestrate them starting up and coming down cleanly, and not have to deal with several different ttys to get the logs.

Proc creates a simple framework for creating observable, controllable execution units out of your code, and more easily integrating the code of others.

This project is the merge of several libraries for logging, spawning and controlling child processes, and creating an RPC to child processes that controls the run of the child process. Due to the confusing duplication of signals as a means of control and the lack of uniformity in signals (ie windows) the goal of proc is to create one way to do, following the principles of design used for Go itself.

Badges

<insert badges here

Installation

Usage

reasonably include in the README.

Support

Roadmap

  • Implement basic logger
  • Create concurrent safe configuration CLI/env/config system

Contributing

Authors and acknowledgment

David Vennik david@cybriq.systems

License

Unlicenced: see here

Project status

In the process of revision and merging together several related libraries that need to be unified.

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (

	// App is the name of the application
	App = "  main"
	// AllSubsystems stores all of the package subsystem names found in the current
	// application
	AllSubsystems []string
)
View Source 
var LevelSpecs = map[LogLevel]LevelSpec{
	Off:   gLS(Off, 0, 0, 0),
	Fatal: gLS(Fatal, 255, 0, 0),
	Error: gLS(Error, 255, 128, 0),
	Check: gLS(Check, 255, 255, 0),
	Warn:  gLS(Warn, 255, 255, 0),
	Info:  gLS(Info, 0, 255, 0),
	Debug: gLS(Debug, 0, 128, 255),
	Trace: gLS(Trace, 128, 0, 255),
}

LevelSpecs specifies the id, string name and color-printing function

View Source 
var LvlStr = map[LogLevel]string{
	Off:   "off  ",
	Fatal: "fatal",
	Error: "error",
	Warn:  "warn ",
	Info:  "info ",
	Check: "check",
	Debug: "debug",
	Trace: "trace",
}

Functions

func Add added in v0.0.3 

func Add(pathBase string) (subsystem string)

Add adds a subsystem to the list of known subsystems and returns the string so it is nice and neat in the package logg.go file

func GetLoc added in v0.0.3 

func GetLoc(skip int, subsystem string) (output string)

GetLoc calls runtime.Caller and formats as expected by source code editors for terminal hyperlinks

Regular expressions and the substitution texts to make these clickable in Tilix and other RE hyperlink configurable terminal emulators:

This matches the shortened paths generated in this command and printed at the very beginning of the line as this logger prints: 

^((([\/a-zA-Z@0-9-_.]+/)+([a-zA-Z@0-9-_.]+)):([0-9]+))
/usr/local/bin/goland --line $5 $GOPATH/src/github.com/p9c/matrjoska/$2

I have used a shell variable there but tilix doesn't expand them, so put your GOPATH in manually, and obviously change the repo subpath.

func SetLogLevel added in v0.0.5 

func SetLogLevel(l LogLevel)

func SetTimeStampFormat added in v0.0.5 

func SetTimeStampFormat(format string)

Types

type Bool added in v0.0.6 

type Bool struct {
	Meta
	// contains filtered or unexported fields
}

func (*Bool) Bool added in v0.0.6 

func (b *Bool) Bool() bool

func (*Bool) Duration added in v0.0.7 

func (d *Bool) Duration() time.Duration

func (*Bool) Float added in v0.0.6 

func (b *Bool) Float() float64

func (*Bool) FromString added in v0.0.6 

func (b *Bool) FromString(s string) error

func (*Bool) Int added in v0.0.6 

func (b *Bool) Int() int64

func (*Bool) List added in v0.0.6 

func (b *Bool) List() []string

func (*Bool) Set added in v0.0.6 

func (b *Bool) Set(bo bool)

func (*Bool) String added in v0.0.6 

func (b *Bool) String() string

func (*Bool) Uint added in v0.0.6 

func (b *Bool) Uint() uint64

type Chk 

type Chk func(e error) bool

Chk is a shortcut for printing if there is an error, or returning true

type Duration added in v0.0.7 

type Duration struct {
	Meta
	// contains filtered or unexported fields
}

func (*Duration) Bool added in v0.0.7 

func (d *Duration) Bool() bool

func (*Duration) Duration added in v0.0.7 

func (d *Duration) Duration() time.Duration

func (*Duration) Float added in v0.0.7 

func (d *Duration) Float() float64

func (*Duration) FromString added in v0.0.7 

func (d *Duration) FromString(s string) error

func (*Duration) Int added in v0.0.7 

func (d *Duration) Int() int64

func (*Duration) List added in v0.0.7 

func (d *Duration) List() []string

func (*Duration) Set added in v0.0.7 

func (d *Duration) Set(du time.Duration)

func (*Duration) String added in v0.0.7 

func (d *Duration) String() string

func (*Duration) Uint added in v0.0.7 

func (d *Duration) Uint() uint64

type Float added in v0.0.6 

type Float struct {
	Meta
	// contains filtered or unexported fields
}

func (*Float) Bool added in v0.0.6 

func (f *Float) Bool() bool

func (*Float) Duration added in v0.0.7 

func (f *Float) Duration() time.Duration

func (*Float) Float added in v0.0.6 

func (f *Float) Float() float64

func (*Float) FromString added in v0.0.6 

func (f *Float) FromString(s string) error

func (*Float) Int added in v0.0.6 

func (f *Float) Int() int64

func (*Float) List added in v0.0.6 

func (f *Float) List() []string

func (*Float) Set added in v0.0.6 

func (f *Float) Set(bo float64)

func (*Float) String added in v0.0.6 

func (f *Float) String() string

func (*Float) Uint added in v0.0.6 

func (f *Float) Uint() uint64

type Int added in v0.0.6 

type Int struct {
	Meta
	// contains filtered or unexported fields
}

func (*Int) Bool added in v0.0.6 

func (in *Int) Bool() bool

func (*Int) Duration added in v0.0.7 

func (in *Int) Duration() time.Duration

func (*Int) Float added in v0.0.6 

func (in *Int) Float() float64

func (*Int) FromString added in v0.0.6 

func (in *Int) FromString(s string) error

func (*Int) Int added in v0.0.6 

func (in *Int) Int() int64

func (*Int) List added in v0.0.6 

func (in *Int) List() []string

func (*Int) Set added in v0.0.6 

func (in *Int) Set(bo int)

func (*Int) String added in v0.0.6 

func (in *Int) String() string

func (*Int) Uint added in v0.0.6 

func (in *Int) Uint() uint64

type LevelPrinter 

type LevelPrinter struct {
	Ln Println
	// F prints like fmt.Println surrounded by log details
	F Printf
	// S uses spew.dump to show the content of a variable
	S Prints
	// C accepts a function so that the extra computation can be avoided if
	// it is not being viewed
	C Printc
	// Chk is a shortcut for printing if there is an error, or returning
	// true
	Chk Chk
}

LevelPrinter defines a set of terminal printing primitives that output with extra data, time, level, and code location

type LevelSpec 

type LevelSpec struct {
	Name      string
	Colorizer func(format string, a ...interface{}) string
}

type List added in v0.0.6 

type List struct {
	sync.Mutex
	Meta
	// contains filtered or unexported fields
}

func (*List) Bool added in v0.0.6 

func (l *List) Bool() bool

func (*List) Duration added in v0.0.7 

func (l *List) Duration() time.Duration

func (*List) Float added in v0.0.6 

func (l *List) Float() float64

func (*List) FromString added in v0.0.6 

func (l *List) FromString(s string) error

FromString converts a comma separated list of strings into a List

func (*List) Int added in v0.0.6 

func (l *List) Int() int64

func (*List) List added in v0.0.6 

func (l *List) List() (li []string)

func (*List) Set added in v0.0.6 

func (l *List) Set(li []string)

func (*List) String added in v0.0.6 

func (l *List) String() (o string)

func (*List) Uint added in v0.0.6 

func (l *List) Uint() uint64

type LogLevel 

type LogLevel int32
const (
	Off LogLevel = iota
	Fatal
	Error
	Check
	Warn
	Info
	Debug
	Trace
)

type Logger 

type Logger struct {
	F, E, W, I, D, T LevelPrinter
}

func GetLogger added in v0.0.5 

func GetLogger(pathBase string) (l *Logger)

GetLogger returns a set of LevelPrinter with their subsystem preloaded

type Meta added in v0.0.6 

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

Meta automatically implements everything except the inputs and outputs

func NewMeta added in v0.0.6 

func NewMeta(args Struct) Meta

NewMeta allows you to create a Meta with a sparsely filled, named field struct literal

func (*Meta) Aliases added in v0.0.6 

func (m *Meta) Aliases() []string

func (*Meta) Default added in v0.0.6 

func (m *Meta) Default() string

func (*Meta) Description added in v0.0.6 

func (m *Meta) Description() string

func (*Meta) Documentation added in v0.0.6 

func (m *Meta) Documentation() string

func (*Meta) Group added in v0.0.6 

func (m *Meta) Group() string

func (*Meta) Name added in v0.0.6 

func (m *Meta) Name() string

func (*Meta) Tags added in v0.0.6 

func (m *Meta) Tags() []string

func (*Meta) Type added in v0.0.6 

func (m *Meta) Type() string

type Printc 

type Printc func(closure func() string)

Printc accepts a function so that the extra computation can be avoided if it is not being viewed

type Printf 

type Printf func(format string, a ...interface{})

Printf prints like fmt.Println surrounded by log details

type Println 

type Println func(a ...interface{})

Println prints lists of interfaces with spaces in between

type Prints 

type Prints func(a ...interface{})

Prints prints a spew.Sdump for an interface slice

type String added in v0.0.6 

type String struct {
	Meta
	// contains filtered or unexported fields
}

func (*String) Bool added in v0.0.6 

func (s *String) Bool() bool

func (*String) Duration added in v0.0.7 

func (s *String) Duration() time.Duration

func (*String) Float added in v0.0.6 

func (s *String) Float() float64

func (*String) FromString added in v0.0.6 

func (s *String) FromString(st string) error

func (*String) Int added in v0.0.6 

func (s *String) Int() int64

func (*String) List added in v0.0.6 

func (s *String) List() []string

func (*String) Set added in v0.0.6 

func (s *String) Set(st string)

func (*String) String added in v0.0.6 

func (s *String) String() string

func (*String) Uint added in v0.0.6 

func (s *String) Uint() uint64

type Struct added in v0.0.6 

type Struct struct {
	Name, Type, Group, Description, Documentation, Default string
	Tags, Aliases                                          []string
}

type Uint added in v0.0.6 

type Uint struct {
	Meta
	// contains filtered or unexported fields
}

func (*Uint) Bool added in v0.0.6 

func (u *Uint) Bool() bool

func (*Uint) Duration added in v0.0.7 

func (u *Uint) Duration() time.Duration

func (*Uint) Float added in v0.0.6 

func (u *Uint) Float() float64

func (*Uint) FromString added in v0.0.6 

func (u *Uint) FromString(s string) error

func (*Uint) Int added in v0.0.6 

func (u *Uint) Int() int64

func (*Uint) List added in v0.0.6 

func (u *Uint) List() []string

func (*Uint) Set added in v0.0.6 

func (u *Uint) Set(bo int)

func (*Uint) String added in v0.0.6 

func (u *Uint) String() string

func (*Uint) Uint added in v0.0.6 

func (u *Uint) Uint() uint64

Source Files

View all Source files

Directories

Path Synopsis
cmd
logtest
update

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.