ergo

README

https://ergo.services

Purpose

Quick start

Features

Requirements

• Go 1.20.x and above

Versioning

Golang introduced v2 rule a while ago to solve complicated dependency issues. We found this solution very controversial and there is still a lot of discussion around it. So, we decided to keep the old way for the versioning, but have to use the git tag with v1 as a major version (due to "v2 rule" restrictions). Since now we use git tag pattern 1.999.XYZ where X - major number, Y - minor, Z - patch version.

Changelog

Fully detailed changelog see in the ChangeLog file.

Benchmarks

You can find available benchmarks in the following repository https://github.com/ergo-services/benchmarks.

• Messaging performance (local, network)

• Memory consumption (demonstrates framework memory footprint) per process.

Development and debugging

To enable Golang profiler just add --tags debug in your go run or go build (profiler runs at http://localhost:9009/debug/pprof)

To disable panic recovery use --tags norecover.

To enable trace logging level for the internals (node, network,...) use --tags trace and set gen.LogLevelTrace for your node.

To run tests with cleaned test cache:

go vet
go clean -testcache
go test -v ./...

Commercial support

please, contact support@ergo.services for more information

Documentation

Index

• Variables
• func StartNode(name gen.Atom, options gen.NodeOptions) (gen.Node, error)

Variables

var (
	FrameworkVersion = gen.Version{
		Name:    "Ergo Framework",
		Release: "3.0.0",
		License: gen.LicenseMIT,
	}
)

Functions

func StartNode

func StartNode(name gen.Atom, options gen.NodeOptions) (gen.Node, error)

StartNode starts a new node with given name